Puppet is a configuration management software that allows the defining and enforcing of the desired state across your nodes and keeps them in this desired state. Nodes are the clients and servers that are connected to and managed by Puppet. Puppet supports both Linux and Windows environments. Also, it is available both commercially and in open source. In this book, we will deal only with the open source version.
However, you may also want to use or give Puppet Enterprise a go, which is the commercial solution. There is a virtual appliance available to download on the Puppet website https://puppetlabs.com/download-learning-vm. You can download and test it. It supports up to ten nodes for free. Of course, using the commercial version is easier as it has complete support and additional functionalities. The problem with it is that, you need to pay for it and have a budget. Following are the additional advantages, if you want to check the Enterprise Puppet. For more details, please check out the URL https://puppetlabs.com/puppet/commercial.
Event inspection
Role-based access control
Puppet Server reporting
Puppet Enterprise installer
Puppet Enterprise console
Puppet Node Manager
While reading books based on Puppet, we come across one little problem: the books are all about managing Linux systems. There are almost no resources explaining the details about managing Windows servers and clients. Thus, it was a challenge for me to use Puppet in the Windows environment. While doing this, I had to deal with many problems and learn the hard way. In this book, I will make it much easier for you to use Puppet for Windows. By the end of this book, you will have a solid understanding of how to write manifests for Windows and deal with the configuration problems. There will be practical step-by-step examples to complete the tasks. However, we will not delve much into technical and theoretical discussions. The book will show you one easy way of doing it. However, this does not mean that this is the only way to do it.
For example, we will use the Foreman web interface with Apache to manage hosts. This does not mean that this is the only way. You can use Puppet without any server and you can distribute the manifests with Git. This is called the masterless mode. You can only implement this with Apache and handle all the manifests from the terminal. You can also use the enterprise version. These are the perfectly possible ways of using Puppet, but may require more effort or money. The list of ways mentioned here is not exhaustive and every implementation method has not been covered. I have tried many ways and different usages, and came to the conclusion that using Foreman with Puppet is one of the easiest ways to start. This maximizes the benefits and minimizes the effort. However, this is subjective and some people may feel more comfortable without the graphical interface, or may switch to the enterprise version.
Here, I will tell you some basic differences and not deal with an exhaustive list of all the differences between Windows and Linux. When checking out Puppet and writing the manifests, you may realize that it is much easier with Linux but harder to complete the same tasks with Windows. Here are some examples:
File resource: This manages the permissions, ownership, and contents of the files. Permission settings do not work as successfully for Windows, as it works for Linux; we will use ACL module for this purpose.
Package resource: This manages the packages and software installation. For Windows, we cannot directly install a package and keep it updated as we do in Linux, because Window sit does not have a package manager such as aptitude or yum. First, we need to first find the installer and send it to the host to handle the installation.
Puppet agent updates: These are not easy with packages and requires manual steps.
Firewall: This has support for Linux, but not an official support for Windows Firewall. We need to write our own manifests, or we can find a solution from Puppet Forge.
Windows Task Scheduler: This is not fully supported and has only rudimentary functionality.
Windows Server: This has a very limited support.
This list may continue in this way. Thus, as we can see, the differences are not in favor of Windows. In this book, we will solve these types of problems and show you how to handle them in an easy way.
We will start with the installation of the operating system of the Puppet Server. From now on, the Puppet Server will be called Puppet Master. We will use the Ubuntu server 14.04 LTS. Some users may prefer Enterprise Linux such as Red Hat or CentOS. If you prefer another flavor of Linux, this is also fine. Following are the server requirements. The requirements are fine for 500 to 1000 nodes. These requirements will change according to the number of your nodes:
Ubuntu Server 14.04 LTS
At least 4 GB RAM
At least 2 Core CPU
At least 40 GB of hard disk space
You can download the Ubuntu Server 14.04 LTS ISO from http://www.ubuntu.com/download/server. Using Long Term Support (LTS) versions, ensure that you do not have to upgrade your server for a long time and that there will be few issues about upgrading the distribution. If you want to test it first locally on your computer, you can also download and install VirtualBox from https://www.virtualbox.org/wiki/Downloads. All the examples in this book have been created in VirtualBox.
You should have a new installation with the OpenSSH server. We will use SSH to connect to the server.
We will use SSH to connect to our server. The installation is very easy. You can use the following command to install:
$ sudo apt-get install ssh -y
sudo
: This enables you to run a command with root privileges.apt-get
: The APT package handling utility is used to install and uninstall software.install
: This option is used withapt-get
to install a package.ssh
: This is thessh
server package name that will be installed.-y
: Theapt-get
installation asks, "Do you want to continue[Y/n]
?". This flag gives the answer as yes and the command runs without interruption.
If you use Windows as your operating system, you can connect using PuTTY. Download this from the link http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html.
If you use Linux, you can connect from the terminal by the ssh
command. For example,
$ sshusername@serverip
From now on, we will use ssh
to connect to our server.
Puppet installation usually follows the following steps:
Set the hostname
Set FQDN
Set the static IP, gateway and DNS
Add the Puppet repositories
Install Puppet
Let's have a look at each of them.
I will use puppetmaster
as the hostname. You can use either vim
or nano
for text editing. If you have never used vim
before, it will be easier for you to use nano
.
$ sudonano /etc/hostname
sudo
: For configuration changes, we will need the root privileges. If we do not run the command withsudo
, we cannot save our changes to the configuration file.nano
: This is the command to run the nano text editor./etc/hostname
: This is the filename for the hostname configuration.
Use CTRL + X and Y to save.
I will use puppetmaster.example.com.
. Use the following command to edit the /etc/hosts
file:
$ sudonano /etc/hosts
Change the contents as follows. Use your own IP according to your network.
127.0.0.1 localhost 127.0.1.1 puppetmaster.example.com 10.10.10.10 puppetmaster.example.com puppetmaster
To verify that the changes are effective, use the hostname
and hostname -f
commands.

Note
You also need to add the IP and fully qualified domain name (FQDN) to your company DNS, so that the other computers can find your server. I assume that, as a Windows system administrator, you already know how to do this. The IPs used here may not suit your network and IP ranges, so please change all the IP details throughout the book according to your needs.
For your server, give a static IP and define your gateway and nameserver IPs.
First, define your IP gateway and subnet mask. For this, we will edit the /etc/network/interfaces
file. Following is the sample detail I have added for my Puppet Master:
$ sudonano /etc/network/interfaces

As you can see, the details are self-explanatory:
eth0
: This is the network interface nameaddress
: This is your server's IPnetmask
: This is the subnetmaskbroadcast
: This is the broadcast IPgateway
: This is the gateway IP
Now, let's set the nameserver IPs. To set NS records, we need to edit /etc/resolvconf/resolv.conf.d/base
, as follows:
$ nano /etc/resolvconf/resolv.conf.d/base
The sample contents of this file are shown in the following screenshot. In our example, we are using the Google DNS IPs. Here, you can use your company's DNS IPs.

Tip
Downloading the example code
You can download the example code files from your account at http://www.packtpub.com for all the Packt Publishing books you have purchased. If you purchased this book elsewhere, you can visit http://www.packtpub.com/support and register to have the files e-mailed directly to you.
After saving the file, reboot the server. After rebooting, you can check using the following command whether you have the correct IP, netmask, and broadcast:
$ ifconfig

Check whether the gateway is correct using the following command:
$ route -n
Lastly, check whether nameserver works correctly. Run the nslookup
command and enter any address, as follows:
$ nslookup
nslookup
: This is the command to interactively query the Internet names servers. If no nameserver is provided, this will use the default one.google.com
: When we enter any hostname, this will provide the details about itexit
: This command endsnslookup
As you can see in the preceding screenshot, it checks from 8.8.8.8
. Now we can say that our network settings are correct. To exit nslookup
, you can use the exit
command.
We will first add the Puppet repositories for installation. Secondly, we will update the repositories. Lastly, we will update our server before installing Puppet.
Here are the details to add the Puppet repositories:
$ sudowget https://apt.puppetlabs.com/puppetlabs-release-trusty.deb $ sudodpkg -ipuppetlabs-release-trusty.deb
wget
: This is a utility for non-interactive downloads of files from the Web. We use this here to download thepuppetlabs-release-trusty.deb file
.dpkg
: This is the package manager for Linux Debian. The option-i
is used for installation.
Now, update the repository info, as follows:
$ sudo apt-get update
Lastly, install the updates, as follows:
$ sudo apt-get upgrade -y
Now, it is time to install Puppet Master and its agent on your server. We will also do some configurations. The command to install Puppet is as follows:
$ sudo apt-get install -y puppetmaster puppet
Now, let's make sure that Puppet Master starts automatically. For this purpose, we need to edit /etc/default/puppetmaster
. You need to change the START=no
value to START=yes
. If it is already yes
, you can leave this as it is and continue. You also need to enable puppet agent
on the server. We will edit the /etc/default/puppet
file. Again, we need to make sure that START=yes
exists. We also need to change the server details for the puppet agent. Change the /etc/puppet/puppet.conf
file and enter the server details. Just after [main]
, add the line server=puppetmaster.example.com
.

After making the changes, we will restart the services as shown here:
$ sudo service puppetmaster restart $ sudo service puppet restart
Check whether they are running using the following commands:
$ sudo service puppetmaster status $ sudo service puppet status

As you can see in the preceding screenshot, the services are running without any problem. So we completed the installation of Puppet Master and Puppet agent on our server.
After installing Puppet Master, our next step is to install the Foreman web user interface that will be used to manage and report. Foreman is an open source project that can be used with Puppet or Chef. With Foreman and Puppet, you can manage your servers for configuration management, orchestration, and monitoring. For installation of Foreman, we will first add the relevant repositories, and after that install it.
Add repository details, as follows:
$ sudo -i # echo "deb http://deb.theforeman.org/ trusty stable" > /etc/apt/sources.list.d/foreman.list # echo "deb http://deb.theforeman.org/ plugins stable" >> /etc/apt/sources.list.d/foreman.list
You can also use sudonano
to add the details to the relevant files. In the preceding commands, echo
outputs the text to the screen or a file. >
overwrites the file, if it exists; if it does not exist, the file will be created. >>
adds content to the end of the file without overwriting it.
We need to add the key for the repository, as we are manually adding the source details using this command:
# wget -q http://deb.theforeman.org/pubkey.gpg -O- | apt-key add -
Now we have successfully added the repository details; we can continue with the repository updates, as follows:
# apt-get update
We need Apache as our web server. So, we install apache2 and foreman-installer
as shown in the following:
# apt-get install -y foreman-installer
The final step is to run the foreman-installer
. It will take some time to complete. For my server, it took more than five minutes.
# foreman-installer

Do not forget to write down the user and password details to connect your server. In the next section, we will see the basics of the user interface.
Now, just open a browser and enter your URL. In our example, the URL is https://puppetmaster.example.com
. You will get the login page.

Log in with your username and password and you will get a screen as follows. In this screen, you will see only one host, which is our Puppet Master server. We added its agent before, and now we can see that it was connected just two minutes ago. This means that we can even manage Puppet Master with Puppet.

The next step is to change your password. From the right upper corner, go over to Admin User and click on My account. Set a new password as per your convenience. Make sure that the password is strong.

Now let's check out the dashboard. For the dashboard, from the Monitor menu click on Dashboard. In the dashboard, you will see the summary statuses of all your hosts. At the moment as we have only one host, there is not much detail. When we will have more hosts, we will check again, and then find that there will be many different statuses. Most of the statuses of your hosts will fall under one of the statuses listed, as follows:

We will finish reviewing the Foreman interface. This will be enough for now. We will later see more details of the interface to manage our hosts.
Puppet Master must be protected well. It is a high-risk asset. With Puppet, you can install software on all your servers and clients. Puppet agents on Linux and Windows run with root and admin rights respectively. Think about a scenario where a hacker gets control of it. He can easily run any command, install backdoors, and fully compromise your IT infrastructure.
I suggest using the Ubuntu Server version that does not have a graphical user interface. This will ensure that there will not be much unnecessary software on your Puppet Master. Having only the necessary software on it helps you to have a more secure server, and also to keep the performance higher.
Note
Security rule:
Do not install any software that is not necessary. If vulnerable software does not exist, it cannot be attacked.
Keep frequent backups of your server.
There are many good backup solutions such as Backup Exec and Veeam. There are also hardware level backup solutions for storage devices. As a last option, you can also use free backup solutions such as Burp backup or a version control system (VCS). VCS will only back up your code and configuration.
Backup solutions and how to handle them is out of the scope of the book. Every company and system administrator has or should have their backup solution. If you do not have one, it is really time to implement one of the solutions as soon as possible. Without backups, your most important concern and risk will be business continuity.
Every day we see that there are new vulnerabilities, and with new security updates they are patched. So you must have a good policy of updates. The updates are very easy with Ubuntu; you only run two commands, as follows:
$ sudo apt-get update $ sudo apt-get upgrade
I will not explain these commands again. You can check the section Installing Puppet in this chapter to see the details if you need.
Before updating your server, ensure that in case of problems, you can go back. If you are using a virtual machine, such as Puppet Master, take a snapshot before the updates. If you use hardware, take a new backup before you start.
Lastly, it is also a good idea to have a development environment. Testing the updates in development and then updating the production server would be a good practice.
Some administrators do not feel happy about entering a sudo
command and password whenever there is a need for root privilege. To simply bypass this problem, they enable the root account and use it for every task.
The problem with using the root account is that, you have many processes and software running with root privileges. Assuming that one of them is vulnerable, and a hacker targets your server. When the hacker uses this vulnerability and opens a shell, the privileges that he will have are directly related to the process. So, if the process runs with root privileges, the hacker gains root access. Root access implies total control of the server. If the process is using a limited user account, the hacker will gain these privileges. This means that he still has a long way to go and find some way to escalate the privileges.
Also, when you use the root account, you also need to protect the server from yourself. The root account can do everything; with great power comes great responsibility. If you do something wrong, accidentally, you may need to restore your server from a backup. If you do not have a backup, things may get worse.
Always use a limited account and use sudo
only when needed. This will protect you from hackers and also from yourself.
Check status of the root account, as follows:
$ sudopasswd root -S
If not locked, lock it using the following:
$ sudopasswd root –l
Note
From now on, in this chapter, all the following details are not related to the implementation and installation of Puppet. However, it is suggested to complete these steps in a live environment. When learning in a test environment, security may not be your initial concern. In this case, simply go to Chapter 2, Installing Puppet Agents
Another important point is to have a decent password policy. With the correct password policy, we will make it harder for the passwords to be cracked. In the Windows Group Policy, there are also settings for password policy. Thus, the Windows administrators can easily understand its necessity. Here are some points to improve upon.
To limit the old passwords that can be used, we need to edit the /etc/pam.d/common-password
file. PAM is Pluggable Authentication Modules. PAM enables us to change the authentication process of Linux.
$ sudonano /etc/pam.d/common-password password [success=1 default=ignore] pam_unix.so obscure sha512 remember=5
pam_unix.so
is the default PAM moduleobscure sha512
will encrypt the new passwords withsha512
success=1
skips the next ruleremember=5
will prevent the user from using the last five passwords
To set more complex passwords, we will install the libpam-cracklib
library, as follows:
$ sudo apt-get install libpam-cracklib
After this, we again edit the /etc/pam.d/common-password
file as follows:
$ sudonano/etc/pam.d/common-password password requisite pam_cracklib.so retry=3 minlen=10 difok=3 ucredit=-1 lcredit=-1 dcredit=-1 ocredit=-1
retry=3
ensures that while setting the password, if the user cannot successfully set a password three times, thepasswd
command will abortminlen=10
is the minimum length for the passworddifok=3
is the minimum number of characters that must be different from those of the previous passworducredit=-1
sets the minimum number of required uppercase characters to 1lcredit=-1
sets the minimum number of required lowercase characters to 1dcredit=-1
sets the minimum number of required digits to 1ocredit=-1
sets the minimum number of required symbols to 1
Here are the /etc/pam.d/common-password
details after the changes:

The password expiration details are in the /etc/login.defs
file. Change the value of PASS_MAX_DAYS
to 90
and it will be forced to update the password every 90 days, as follows:
$ sudonano/etc/login.defs PASS_MAX_DAYS 90
This policy makes sure that any brute force attempt will fail, or need too much time to complete. We will lock the user account for 10 minutes, if five times there are consecutive login failures. For this purpose, we need to modify the /etc/pam.d/common-auth
file. After the lock and wait time, if the user successfully logs in with the correct password, the failed attempts counter will be reset to zero. Otherwise, each failed attempt after the lock will cause another 10 minutes of lock. So, I suggest here that you keep a backup user with the sudo rights, as follows:
$ sudonano/etc/pam.d/common-auth auth required pam_tally2.so deny=5 onerr=fail unlock_time=600
pam_tally2.so
is the PAM module that comes with Ubuntu installation and used for account locks.deny=5
is the setting used to set the number of failed logins to lock an account.onerr=fail
if something weird happens, the PAM login status will befail
orsuccess
. The default status isfail
.unlock_time=600
is the number of seconds after which the account will be unlocked.
After completing all the changes, restart your server with the reboot
command for all the changes to be applied. This is done as follows:
$ sudo reboot
You can check a user's login attempts with the following command:
$ sudo pam_tally2 -u username
pam_tally2
is the command for the login counter PAM-u
is used to set the user
Here is an example output after two unsuccessful login attempts:

If you want to reset the counter and unlock the user, you can use the following command. -r
switch is used to reset the failures counter.
$ sudo pam_tally2 -u username -r
This step makes sure that even if somebody gets your password, it will not be usable. Thus, we will use the SSH key files. The SSH key files are used to identify yourself to an SSH server using the public-key cryptography and challenge-response authentication. We will disable the password logon option and it will be only possible to connect with a key file. We will also put a password to the key file, to make sure that it is also not usable without the password.
Use the ssh-keygen
command to generate the keys, as follows:
$ ssh-keygen

ssh-keygen
first asks for the folder to save the keys. Just push the Enter key and continue. The next question is the passphrase. Make sure that you enter a password. Using the password with your key makes sure that, when somebody gets your key, it will be unusable.
Now go to the .ssh
folder, as follows:
$ cd .ssh
Under this folder, you will see these two files:
id_rsa
: Private keyid_rsa.pub
: Public key
We need to add the details of the public key to a file called authorized_keys
. This will make it possible to log in with the private key.
$ cat id_rsa.pub >authorized_keys
The
cat
command displays the content of a file in the terminalThe
>
symbol adds the content of a command output to a file and if the file has content, it will be overwrittenThe
authorized_keys
is the file that will be required for thessh
connection with a key
Here is an example screenshot:

Change the authorized_keys file permissions, otherwise the key will not work. This is done as follows:
$ chmod 600 authorized_keys
This command will allow only the user to edit and write the file; any group or other users will not be able to change it.
Now, we need to get the contents of id_rsa
to our computer that we will use to connect to Puppet Master.
To do this, you can use FileZilla to connect and download the file. Or you can use any FTP client with SFTP support. Here is a screenshot for the SFTP connection definition:

You need to enter the following:
Host: The server IP is
10.10.10.10
. This is the IP that we gave to our Puppet Master server while installing.Protocol: SFTP.
Logon Type: Normal.
User: Your username.
Password: Your password.
After you have filled the details, click the Connect button. When you connect, you will see your user folder and the .ssh
folder, as follows:

Download the id_rsa
file to your documents folder. After this, you need to convert the file with PuTTYgen.exe
. Open PuTTYgen.exe
and click the Load button. You also need to select the All Files (*.*) option, as shown here:

After you click it open, it will ask for the password. After this, click on Save private key and give a name to your key. I saved it as puppetmaster.ppk
. Now, we are ready to use this key to connect to Puppet Master.
To do it, first fill in the details as follows:

Now go to SSH | Auth. Select the key file, as follows:

After this, go back to Session from the Category section and use the Save button. This will make sure that you can reuse the connection and do not have to define the same settings again.
Now you will be able to connect by double-clicking your saved session name. It will ask for the key file password and then you will be able to connect.
To connect from Linux systems, you do not need to convert the private key. You can just connect from the terminal with the ssh
command, as follows:
$ sshusername@serverip -ikeyfile
When I change this command to my example, it will b
sshpuppet@10.10.10.10 -iid_rsa
This is our last step for SSH. After disabling the password login option, there will be no possibility for an hacker to use brute force against an account. Also, there will be no possibility to log in, even if the hacker knows the password.
We need to change the /etc/ssh/sshd_config
file to disable password, as follows:
$ sudonano /etc/ssh/sshd_config
Find the PasswordAuthentication
text, uncomment it, and set the value to no
.

After changing the value and saving the file, restart the ssh
service, as shown here:
$ sudo service ssh restart
Now, here is the output when I try to log in without the key:

For the servers and clients, the rule for security is: "Deny all incoming connections and allow only those needed." Here are the steps:
Check which ports to keep open
Define the firewall rules
Make the firewall rules persistent
We will use netstat
to check the listening ports and running services. Here, we already know that for administrative purposes, we need to keep the SSH port 22 open. But we also need to check other ports that Puppet and Foreman are using. The command to check the listening ports and services is as follows:
$ sudonetstat -nlput
netstat
: The command to check network connections.n
flag: This shows addresses in the numeric formatl
flag: This shows only the listening portsp
flag: This shows the PID name of the program that the socket belongs tou
flag: This shows the UDP portst
flag: This shows the TCP ports

Here are the ports that we need to keep open:
22
:ssh
80,445
: HTTP and HTPPS ports to connect Foreman8443
: Foreman proxy is running on this port as a proxy8140
: Puppet Master listens to this port
You can also remember that in the section Installing Foreman when the installation finishes, it gives the details about the 8443
and 8140
ports.
We will use iptables as the firewall. It comes preinstalled on the Ubuntu Server. First, let's check the rules that we have. If no rules are defined previously, all the policies will be in the ACCEPT
state. The commands to check the iptables rules are as follows:
$ sudoiptables -L -v
iptables
: This is the command to manage the firewallL
flag: This lists all rulesv
flag: Verbose output. This shows the rule options and packet counters

We will accept traffic from any source when the destination port is port 22
. Here is the command:
$ sudoiptables -A INPUT -p tcp --dport 22 -j ACCEPT
We will accept traffic from any source when the destination port is port 80. Here is the command:
$ sudoiptables -A INPUT -p tcp --dport 80 -j ACCEPT
We will accept traffic from any source when the destination port is port 443. Here is the command:
$ sudoiptables -A INPUT -p tcp --dport 443 -j ACCEPT
We will accept traffic from any source when the destination port is port 8443. Here is the command:
$ sudoiptables -A INPUT -p tcp --dport 8443 -j ACCEPT
We will accept traffic from any source when the destination port is port 8140. Here is the command:
$ sudoiptables -A INPUT -p tcp --dport 8140 -j ACCEPT
We need to define this rule. Otherwise, any traffic connection will not be complete. We will be able to send traffic outside, but never be able to get answers back. So, we will allow any incoming packet that is related to our outgoing traffic.
$ sudoiptables -A INPUT -m state --state ESTABLISHED,RELATED -j ACCEPT
-m
: This flag is used to match certain conditions. It can be used with different types of modules.state --state ESTABLISHED,RELATED
:state
is the module name that checks the statuses of a connection. Here, we allow any connection that is related to the established and related connections.
This time, we do not give any protocol or port number. So, this means that all the input traffic will be dropped.
$ sudoiptables -P INPUT DROP
After completing the rules, let's check the iptables rules again:

As you can see in the preceding screenshot, all the rules are defined in the order that we defined.
The rules we defined are not persistent. So whenever you restart your server, the rules will be lost. To prevent this, we will install iptables-persistent
. This software will keep our rules and will enable them at the startup. First install it using the following command:
$ sudoapt-get install iptables-persistent
While installing, it will ask you to save the current configuration to a file name such as /etc/iptables/rules.v4
. Answer this with a yes
. The second question will be about IPv6. We did not define any rules for it, so answer no
for this.
After completing the setup, reboot your server and list the rules of iptables to see that they are still there.
In this chapter, we started by learning what Puppet is. After this, we continued with the differences between Puppet implementations. We got hands-on experience by installing Puppet Server and Foreman. The final step was learning about how to keep your server secure. In the next chapter, we will deal with the Puppet agents and their installation on the hosts.