Puppet Enterprise 2016.4

The following instructions are for performing a text mode split installation of PE. This installs the Puppet master, the PE console, and PuppetDB components on three separate machines—one machine for each component.

See Choosing a PE architecture for more information about installation types.

Before beginning, review the text mode installation overview.

Install PE

Important: Perform these steps in the order given.

Step 1: Install the Puppet master

  1. Download and verify the appropriate PE tarball.
  2. Unpack the tarball by running tar -xf <TARBALL_FILENAME>. This requires about 1 GB of space in /tmp.
  3. From the installer directory, run the installer. The installation steps will vary depending on the path you choose.

    • To have the installer open a copy of pe.conf for you to edit and install with, run the installer without the -c flag.

      sudo ./puppet-enterprise-installer
      
    • To use a pe.conf file that you’ve previously populated, run the installer with the -c flag pointed at the pe.conf file.

      sudo ./puppet-enterprise-installer -c <FULL PATH TO pe.conf>
      

      Warning: If you’re using a pre-populated file, be sure you’ve set the parameters correctly as detailed in the following steps.

  4. If you ran the installer without the -c flag, select “text-mode” when prompted.

    This opens your text editor with a pe.conf file that you can edit to match your infrastructure and add any additional text-mode installation options as needed.

  5. Set the following parameters:

    Important: Do not use single quotes on parameter values. Use double quotes as shown in the examples.

    Note: In the following examples, <FQDN> is the fully qualified domain name of the server. For example, the parameter and value should be expressed as "puppet_enterprise::puppet_master_host": "master.example.com".

    Parameter Value
    "console_admin_password": "<PASSWORD>"— Replace <PASSWORD> with your password used to log into the PE console.
    "puppet_enterprise::puppet_master_host": "<FQDN>"— Provide the<FQDN> of the node hosting the Puppet master.
    "puppet_enterprise::console_host": "<FQDN>"— Provide the<FQDN> of the node hosting the PE console.
    "puppet_enterprise::puppetdb_host": "<FQDN>"— Provide the<FQDN> of the node hosting PuppetDB.

    Warning: In a split install, do not use the “%{::trusted.certname}” value for the Puppet master.

  6. If you have an external PostgreSQL server, refer to the external PostgreSQL parameters in the pe.conf reference and add them to pe.conf.

  7. Save and close the file.

    This starts the installation.

Step 2: Install PuppetDB

  1. Transfer the PE installer tarball and the pe.conf file to the PuppetDB node.
  2. Unpack the tarball by running tar -xf <TARBALL_FILENAME>. This requires about 1 GB of space in /tmp.
  3. If the pe.conf parameter puppet_enterprise::puppet_master_host is set to "%{::trusted.certname}", change the value to the FQDN of the Puppet master.
  4. From the installer directory, run the installer with sudo ./puppet-enterprise-installer -c <FULL PATH TO pe.conf>.

Step 3: Install the PE console

  1. Transfer the PE installer tarball and the pe.conf file to the PE console node.
  2. Unpack the tarball by running tar -xf <TARBALL_FILENAME>. This requires about 1 GB of space in /tmp.
  3. If the pe.conf parameter puppet_enterprise::puppet_master_host is set to "%{::trusted.certname}", change the value to the FQDN of the Puppet master.
  4. From the installer directory, run the installer with sudo ./puppet-enterprise-installer -c <FULL PATH TO pe.conf>.

Step 4: Run Puppet

To complete the installation, run puppet agent -t on the PE nodes in the following order:

  1. The Puppet master node
  2. The PuppetDB node
  3. The PE console node

When the installation completes, you can find an updated pe.conf file at /etc/puppetlabs/enterprise/conf.d on each component node.

Mandatory parameters for pe.conf

Refer to the pe.conf parameter reference for a list of mandatory parameters needed to install PE.

Text-mode installation options

As described above, the syntax for the text-based installation with a specified pe.conf file is:

sudo ./puppet-enterprise-installer -c <FULL PATH TO pe.conf>

When you use the -c option, the pe.conf file name with full path is required. The command will quit with an error message if you omit it.

When you use the -c option, you can also use the following options:

  • -D: The installer will display debugging information.
  • -q: The installer will run in quiet mode. The installation process will not be displayed. If errors occur during the installation, the command will quit with an error message.
  • -V: The installer will display very verbose debugging information.
  • -h: The installer will display help information.

To see the help information for the command, run:

sudo ./puppet-enterprise-installer -h

Rerunning the installer

The PE installer is idempotent, meaning that you can run it as many times as needed without affecting the outcome. If you encounter errors during installation, you can fix them and run the installer again.

Add Puppet Enterprise binaries to PATH

PE installs a number of binaries for interacting with its tools and services. You should include these binaries in your default path.

  1. To include these binaries in your default $PATH, manually add them to your profile or run:

    PATH=/opt/puppetlabs/puppet/bin:/opt/puppetlabs/server/bin:$PATH;export PATH
    

PE installs a number symlinks for interacting with its tools and services. If needed, you can disable symlinks by placing a setting in your your default Hiera file.

  1. In your default Hiera file, add the following setting:

    puppet_enterprise::manage_symlinks: false
    

Related links

Back to top