Install PE with your defined parameters

If you know which PE infrastructure components you want to install and you do not require guidance, you can specify your installation parameters in a JSON file. Then use PIM to start the installation by running a single command.

Before you begin:
  • Ensure that you have the required access to the nodes where you want to install PE infrastructure.
    • To install the primary server locally on the machine where PIM is running, you must log in as the root user.
    • To install PE components on remote nodes, the machine running PIM must have SSH access to the target nodes, and the user executing the installation must have superuser privileges for those nodes. You can configure SSH, or use the -b flag to pass the SSH key or SSH credentials when you run the installation command.
  • Ensure that Puppet is not already installed on any of the nodes where you want to install PE infrastructure.

To install PE from the PIM command line:

  1. Download PIM.

    Go to the Puppet Installation Manager download page and download the binary for your operating system.

  2. Create a JSON file specifying the installation parameters you require.

    For examples illustrating the JSON properties required for different PE architectures, see Creating an installation parameters file.

  3. Start the installation.

    In your terminal, navigate to the pim directory and run one of the following commands, replacing parameters.json with the actual file name (including the file path, if necessary):

    • To run the installation without debugging and without configuring SSH, use a command like the following example:
      ./pim install parameters.json
    • To enable debug logging, add -d or --debug. For example:
      ./pim install parameters.json --debug
    • To pass an SSH key or SSH credentials for accessing remote nodes, use the -b flag with the installation command as shown in the following examples:
      ./pim install -b user=root -b private-key=~/.ssh/ssh_key params.json
      ./pim install -b user=root -b password=ssh_password params.json
  4. Follow the CLI prompts to complete the installation process.
    PIM uses the Puppet Enterprise Administration Module (PEADM), which depends on Puppet Bolt, a tool for automating Puppet infrastructure maintenance tasks. When you run the ./pim install command, PIM checks whether Bolt is present and, if necessary, provides the option to install Bolt.