Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Configuring the Puppet Agent Node

 

The configuration of the Puppet agent node depends on whether the Puppet agent is integrated with the Junos OS software. To verify support for a specific platform, determine if a platform has the Puppet agent integrated with the software, or determine which Puppet agent package is required for a device that does not have the Puppet agent integrated into the software, see Puppet for Junos OS Supported Platforms.

To set up the Puppet agent node, you must perform the following steps:

  1. On devices running Junos OS that do not have the Puppet agent integrated with the software, install the Puppet agent on the device.

  2. Create a Junos OS user account to run the Puppet agent and configure the appropriate directory structure and environment settings.

    The class that you assign to that user account determines the permissions of the Puppet agent on that device.

  3. On devices running Junos OS that have the Puppet agent integrated with the software, start the Puppet agent process.

Note

OCX1100 switches, QFX Series switches running Junos OS with Enhanced Automation, and devices running Junos OS Evolved have the Puppet agent integrated with the software.

The following sections outline how to install the Puppet agent software, configure the Junos OS user account, and start the Puppet agent process.

Installing the Puppet Agent Package

To install the Puppet agent on devices running Junos OS that do not have the agent integrated into the software:

  1. Determine the jpuppet software package required for your platform and release at Puppet for Junos OS Supported Platforms.
  2. Access the download page at https://github.com/Juniper/jpuppet-download.
  3. Select the release folder corresponding to the Puppet for Junos OS release to download.
  4. Download to the /var/tmp/ directory on the agent device the jpuppet software package that is specific to your platform or device microprocessor architecture, depending on the Puppet for Junos OS release.Note

    Starting in Puppet for Junos OS Release 2.0, the jpuppet packages are specific to the microprocessor architecture. In earlier releases, the packages are specific to a particular platform. If you do not know the microprocessor architecture of your device, you can use the UNIX shell command uname -a to determine it.

    Note

    We recommend that you install the jpuppet software package from the /var/tmp/ directory on your device to ensure the maximum amount of disk space and RAM for the installation.

  5. Configure the provider name, license type, and deployment scope associated with the application.

  6. Install the software package using the request system software add operational mode command, and include the no-validate option.
  7. Verify that the installation is successful by issuing the show version command.

    The list of installed software should include the jpuppet package. For example:

    admin@jd> show version
    Note

    The package name might vary depending on the release of Puppet for Junos OS.

Configuring the Junos OS User Account and Environment Settings

To configure a Junos OS user account and the necessary directory structure and environment settings to run the Puppet agent:

  1. Configure the account username, login class, authentication method, and shell.

    You can configure any username and authentication method for the account. This example configures the username as puppet.

  2. Exit the device and log back in using the Puppet account username and password.
  3. Create a $HOME/.cshrc file, and include the content corresponding to the variant of Junos OS and the release of Puppet for Junos OS installed on the device, which is outlined in Table 1.

    Table 1: Content in Puppet Agent .cshrc File

    Junos OS Variant

    Puppet for Junos OS Release

    .cshrc content

    Junos OS or

    Junos OS with Enhanced Automation

    1.0 or 2.0

    setenv PATH ${PATH}:/opt/sdk/juniper/bin

    3.0

    setenv PATH ${PATH}:/opt/jet/juniper/bin

    Junos OS Evolved

    setenv PATH ${PATH}:/usr/bin

  4. Exit the device and log back in using the Puppet account username and password.
  5. Verify that the jpuppet code is installed and that the PATH variable is correct by running Facter, which should display device-specific information. For example:

    % facter
  6. Create the following $HOME/.puppet directory structure:

  7. Place your puppet.conf file in the $HOME/.puppet directory.

    For information about the configuration file, see Setting Up the Puppet Configuration File on the Puppet Master and Puppet Agents Running Junos OS.

Starting the Puppet Agent Process

Devices that have the Puppet agent integrated into the software require that you start the Puppet agent process on the device.

After you configure the Junos OS user account for the Puppet agent, to start the Puppet agent process:

  1. Enter the shell.

  2. Execute the puppet agent command to start the Puppet agent process, and specify any desired options.

    • For example, on devices running Junos OS or Junos OS with Enhanced Automation:

    • On devices running Junos OS Evolved, switch to the default VRF for management traffic, vrf0, and then start the agent.

    Note

    You can choose to define the server settings in your Puppet configuration file instead of specifying the settings as command options.

Release History Table
Release
Description
Starting in Puppet for Junos OS Release 2.0, the jpuppet packages are specific to the microprocessor architecture. In earlier releases, the packages are specific to a particular platform.