Installing and configuring Ansible

The automation server is provisioned and the initial operating system configuration is completed in the previous step. In this step, the following tasks are implemented:

Installing Ansible.
Adding Ansible collections.
Creating an Ansible inventory file.
Using Ansible vault to encrypt files.
Testing connections.

An optional step is included to install the Ansible NSX-T collections. The optional step is needed only if Ansible® is used to create sandboxes.

Installing Ansible

At a command line on the automation server, run the following commands.

sudo apt update
sudo apt install ansible -y
sudo apt install python3-pip -y
ansible --version

These commands are used for the following items:

Refresh the system’s package index.
Install the Ansible® software.
Install the pip package that is required for the use if WinRM with Ansible.
Verify that Ansible is installed.

Adding Ansible collections

Ansible collections are extra modules. In this deployment, use the following commands to add the required collections:

ansible-galaxy collection install ansible.posix
ansible-galaxy collection install community.general
ansible-galaxy collection install ansible.windows
ansible-galaxy collection install community.windows
ansible-galaxy collection install juniper.device
ansible-galaxy collection install junipernetworks.junos

The juniper.device and junipernetworks.junos collections are required only if you are building an isolated recovery environment.

Creating an Ansible inventory file

Create a directory structure for the Ansible files and create an initial inventory file to test Ansible connections to the Ansible hosts. Use the following commands, when connected as the ansible user:
```
sudo mkdir /swlib
sudo mkdir /swlib/ansible
```
Create an inventory file called hosts that has two groups: [LHBR] and [VBR], with the IP addresses or FQDN of the Linux® hardened repository and Veeam® backup server:
```
touch /swlib/ansible/hosts
vi /swlib/ansible/hosts
```

Examples

A hosts file for the immutable backup.

[lhbr]
lhbr01.test.ibmcloud.local ansible_user=root

[vbr]
prodbackup ansible_host=10.38.207.157 ansible_user=sa-ansible ansible_connection=winrm ansible_winrm_server_cert_validation=ignore

A hosts file for the isolated recovery environment.

[lhbr]
lhbr01.test.ibmcloud.local ansible_user=root

[vbr]
prodbackup ansible_host=10.38.207.157 ansible_user=sa-ansible ansible_connection=winrm ansible_winrm_server_cert_validation=ignore

[vsrx]
gateway01 ansible_host=10.5.37.138 ansible_user=sa-ansible

Using Ansible vault to encrypt files

Ansible vault allows the encryption of values and data structures to secure sensitive data that is necessary to successfully run Ansible plays, but are not publicly visible, like passwords or private keys. Ansible automatically decrypts vault-encrypted content at run time when the key is provided.

Vault is implemented with file-level granularity, which means the files are either entirely encrypted or unencrypted. It uses the AES256 algorithm to provide symmetric encryption that is keyed to a user-supplied password. The same password is used to encrypt and decrypt content. The ansible-vault command is used to initially encrypt files, and then is used to view, edit, or decrypt the data.

Create an Ansible configuration file that details the location of the hosts file and vault password file.
Create and encrypt a file, called group_vars/vbr.yml, that holds the password for the sa-ansible user to access the Veeam backup server. The reason that the password for the Veeam backup server is placed here is so that the ansible vbr -m win_ping commands works.
Create and encrypt a file that is called vault that holds the passwords for the hardened backup repository and optionally the vSRX appliance.

The use of the vault_pass file is an optional task, which creates and protects a file that holds the password to the vault. If you choose not to do this task, then you need to enter your password at the prompt when you run Ansible commands.

To allow us not to be prompted for the vault password, enter the following commands:
```
touch ~/.vault_pass
vi ~/.vault_pass
```
Enter the password that you want to use for the vault, and save the file.
Change the permissions so that only the ansible user can read or write chmod 600 ~/.vault_pass.

Create the Ansible configuration file:

cd /swlib/ansible
touch ansible.cfg
vi ansible.cfg

Then, use the following text in the file:

[defaults]
inventory = /swlib/ansible/hosts
vault_password_file = ~/.vault_pass

We need to place the Windows® server password in an encrypted file. Ansible automatically reads files that contain variables from directories, called group_vars and host_vars, and associate them with the groups and hosts by file name. The following command creates an encrypted file, called vbr.yml, that matches the vbr group [vbr] in the inventory file.
```
mkdir group_vars
ansible-vault create group_vars/vbr.yml
```
In the editor, enter the password:
```
ansible_password: <password>
```
Exit by pressing Esc and :wq.
The following commands can be used to modify the file when needed:
- ansible-vault edit group_vars/vbr.yml - The command edits the file.
- ansible-vault decrypt group_vars/vbr.yml - The command decrypts the file so it can be viewed or changed by using another editor, for example, nano.
- ansible-vault encrypt group_vars/vbr.yml - The command encrypts the file after it is viewed or changed.
The following command creates an encrypted file called vault: ansible-vault create vault.
In the editor, enter the following command, where <lhbr_password> and <sa_ansible_password> are the passwords that are defined in the planning stage.
```
vault_lhbr_password: <lhbr_password>
vault_sa_ansible_password: <sa_ansible_password>
```
Exit by pressing Esc and :wq.

Testing connections

Use the following commands to test connections:

ansible lhbr -m ping
ansible vbr -m win_ping

If successful, the output shows SUCCESS for each command.

Installing the Ansible NSX-T collections

This step is optional, and is required only if Ansible is used for configuring sandboxes.

Connect to the Ansible control node as the ansible user.
Install Python: sudo pip3 install --upgrade pyvmomi pyvim requests.

Run the following commands to complete the following tasks:

Create a folder for the download.
Clone the Git repo.
Build the Ansible collection.
Install the locally built collection.

cd /swlib
mkdir downloads
cd downloads
git clone https://github.com/vmware/ansible-for-nsxt.git
cd ansible-for-nsxt
ansible-galaxy collection build
ansible-galaxy collection install vmware-ansible_for_nsxt-1.0.0.tar.gz