Welcome to Puppet Enterprise! This quick start guide uses a web-based installer to walk you through a basic Puppet Enterprise installation. This installation type is ideal for trying out PE with up to 10 nodes, and can be used to manage up to 4000 nodes.
On a single *nix machine, you’ll install:
- The Puppet master, the central hub of activity, where Puppet code is compiled to create agent catalogs, and where SSL certificates are verified and signed.
- The PE console, PE’s web interface, which features numerous configuration and reporting tools.
- PuppetDB, which collects data generated throughout your Puppet infrastructure.
Once this installation is complete, you’ll move on to installing Puppet Enterprise on the nodes you wish to manage with Puppet, commonly known as agent nodes.
Step 1: Review installation prerequisites
Before getting started, review this checklist to make sure you’re ready to install PE.
Be aware that you’ll need to work as the
rootuser on the command line throughout the installation process.
Make sure your hardware needs are met.
Minimum hardware for 10 or fewer nodes (you can download and install Puppet Enterprise on up to 10 nodes at no charge):
Cores RAM /opt/ EC2 2 6 GB 20 GB m3.xlarge instance
If you wish to manage more than 10 nodes, consult the hardware recommendations.
Make sure that all of the nodes you plan to use PE with know their own hostnames. This can be done by properly configuring reverse DNS on your local DNS server, or by setting the hostname explicitly.
Make sure all nodes are able to reach each other by name. This can be done with a local DNS server, or by editing the
/etc/hostsfile on each node to point to the proper IP addresses.
Ensure port 3000 is reachable, because the web-based installer uses this port.
Know the fully qualified domain name of the server you’re installing PE on. (For example,
Step 2: Download and unpack the tarball
All the files you need to install Puppet Enterprise are bundled together in a single compressed file called a tarball.
Visit our downloads page and download the full tarball that matches your operating system’s version and architecture.
To install on… Select a filename ending with… RHEL, CentOS, Scientific Linux, or Oracle Linux
-el-<version and arch>.tar.gz
-ubuntu-<version and arch>.tar.gz
-sles-<version and arch>.tar.gz
Puppet uses a digital signature to authenticate its files. You can verify the integrity of the tarball by following the Verifying the installer instructions.
Run the following command to unpack the tarball:
tar -xf <TARBALL>
Note: You need about 1 GB of space in
/tmpto untar the installer.
Next, set up the installer. From the PE installer directory, run:
When prompted, choose the “Guided” installation option.
The PE installer will now start a web server and provide a web address:
https://<install platform hostname>:3000. Copy this address into your browser (make sure to use
Leave your terminal connection open until installation is complete, or the installation will fail.
When prompted, accept the security request in your browser. The web-based installation uses a default SSL certificate, so you must add a security exception in order to access the web-based installer. This is safe to do.
Step 3: Personalize your installation
You’ve successfully launched PE’s web-based installer! On the installer start page, click Let’s get started!. The installer first collects some key configuration information, which is used to make sure your installation is set up correctly.
To configure your setup:
Choose Install on this server, which will install the Puppet master component on the server you’re running the installer from.
Provide the following information about the Puppet master server:
Puppet master FQDN: The fully qualified domain name of the server you’re installing PE on.
DNS aliases: A comma-separated list of aliases that your agent nodes (the nodes you wish to manage with PE) can use to reach the Puppet master.
When prompted about database support, choose the default option, Install PostgreSQL for me.
Create a password for the console administrator. The password must be at least eight characters. The user name for the console administrator is always admin.
Finally, click Submit, and then review the information you provided. If you need to make any changes, click Go back and make whatever changes are required. Otherwise, click Continue.
Step 4: Complete installation and log into the PE console
On the validation page, the installer verifies various configuration elements (for example, if SSH credentials are correct, if there is enough disk space, and if the OS is the same for the various components).
If there are no outstanding issues, click Deploy now. The installer installs and configures Puppet Enterprise. It may also need to install additional packages from your OS’s repository. This process may take up to 15 minutes.
When installation is complete, the installer script that was running in the terminal closes itself.
Click the Start using Puppet Enterprise button that appears at the end of the web-based installer.
You will receive a browser warning about an untrusted certificate. This is because you were the signing authority for the console’s certificate, and your Puppet Enterprise deployment is not known to your browser as a valid signing authority. Ignore the warning and accept the certificate.
On the login page for the console, log in with the username admin and the password you created when installing the Puppet master.
Congratulations, you’ve successfully installed the Puppet master node! Next you’ll install PE on your agent nodes, so that you can manage these nodes with Puppet. Click here when you’re ready to move on.