Chapter 3. Installing an Identity Management replica using an Ansible playbook
Chapter 3. Installing an Identity Management replica using an Ansible playbook Configuring a system as an IdM replica by using Ansible enrolls it into an IdM domain and enables the system to use IdM services on IdM servers in the domain. The deployment is managed by the ipareplica Ansible role. The role can use the autodiscovery mode for identifying the IdM servers, domain and other settings. However, if you deploy multiple replicas in a tier-like model, with different groups of replicas being deployed at different times, you must define specific servers or replicas for each group. Prerequisites You have installed the ansible-freeipa package on the Ansible control node. You understand the general Ansible and IdM concepts. You have planned the replica topology in your deployment . 3.1. Specifying the base, server and client variables for installing the IdM replica Complete this procedure to configure the inventory file for installing an IdM replica. Prerequisites You have configured your Ansible control node to meet the following requirements: You are using Ansible version 2.13 or later. You have installed the ansible-freeipa package on the Ansible controller. Procedure Open the inventory file for editing. Specify the fully-qualified domain names (FQDN) of the hosts to become IdM replicas. The FQDNs must be valid DNS names: Only numbers, alphabetic characters, and hyphens ( - ) are allowed. For example, underscores are not allowed and can cause DNS failures. The host name must be all lower-case. Example of a simple inventory hosts file with only the replicas' FQDN defined If the IdM server is already deployed and the SRV records are set properly in the IdM DNS zone, the script automatically discovers all the other required values. Optional: Provide additional information in the inventory file based on how you have designed your topology: Scenario 1 If you want to avoid autodiscovery and have all replicas listed in the [ipareplicas] section use a specific IdM server, set the server in the [ipaservers] section of the inventory file. Example inventory hosts file with the FQDN of the IdM server and replicas defined Scenario 2 Alternatively, if you want to avoid autodiscovery but want to deploy specific replicas with specific servers, set the servers for specific replicas individually in the [ipareplicas] section in the inventory file. Example inventory file with a specific IdM server defined for a specific replica In the example above, replica3.idm.example.com uses the already deployed replica1.idm.example.com as its replication source. Scenario 3 If you are deploying several replicas in one batch and time is a concern to you, multitier replica deployment can be useful for you. Define specific groups of replicas in the inventory file, for example [ipareplicas_tier1] and [ipareplicas_tier2] , and design separate plays for each group in the install-replica.yml playbook. Example inventory file with replica tiers defined The first entry in ipareplica_servers will be used. The second entry will be used as a fallback option. When using multiple tiers for deploying IdM replicas, you must have separate tasks in the playbook to first deploy replicas from tier1 and then replicas from tier2: Example of a playbook file with different plays for different replica groups Optional: Provide additional information regarding firewalld and DNS: Scenario 1 If you want the replica to use a specified firewalld zone, for example an internal one, you can specify it in the inventory file. If you do not set a custom zone, IdM will add its services to the default firewalld zone. The predefined default zone is public . Important The specified firewalld zone must exist and be permanent. Example of a simple inventory hosts file with a custom firewalld zone Scenario 2 If you want the replica to host the IdM DNS service, add the ipareplica_setup_dns=true line to the [ipareplicas:vars] section. Additionally, specify if you want to use per-server DNS forwarders: To configure per-server forwarders, add the ipareplica_forwarders variable and a list of strings to the [ipareplicas:vars] section, for example: ipareplica_forwarders=192.0.2.1,192.0.2.2 To configure no per-server forwarders, add the following line to the [ipareplicas:vars] section: ipareplica_no_forwarders=true . To configure per-server forwarders based on the forwarders listed in the /etc/resolv.conf file of the replica, add the ipareplica_auto_forwarders variable to the [ipareplicas:vars] section. Example inventory file with instructions to set up DNS and per-server forwarders on the replicas Scenario 3 Specify the DNS resolver using the ipaclient_configure_dns_resolve and ipaclient_dns_servers options (if available) to simplify cluster deployments. This is especially useful if your IdM deployment is using integrated DNS: An inventory file snippet specifying a DNS resolver: Note The ipaclient_dns_servers list must contain only IP addresses. Host names are not allowed. Additional resources /usr/share/ansible/roles/ipareplica/README.md 3.2. Specifying the credentials for installing the IdM replica using an Ansible playbook Complete this procedure to configure the authorization for installing the IdM replica. Prerequisites You have configured your Ansible control node to meet the following requirements: You are using Ansible version 2.13 or later. You have installed the ansible-freeipa package on the Ansible controller. Procedure Specify the password of a user authorized to deploy replicas , for example the IdM admin . Use the Ansible Vault to store the password, and reference the Vault file from the playbook file, for example install-replica.yml : Example playbook file using principal from inventory file and password from an Ansible Vault file For details how to use Ansible Vault, see the official Ansible Vault documentation. Less securely, provide the credentials of admin directly in the inventory file. Use the ipaadmin_password option in the [ipareplicas:vars] section of the inventory file. The inventory file and the install-replica.yml playbook file can then look as follows: Example inventory hosts.replica file Example playbook using principal and password from inventory file Alternatively but also less securely, provide the credentials of another user authorized to deploy a replica directly in the inventory file. To specify a different authorized user, use the ipaadmin_principal option for the user name, and the ipaadmin_password option for the password. The inventory file and the install-replica.yml playbook file can then look as follows: Example inventory hosts.replica file Example playbook using principal and password from inventory file Additional resources /usr/share/ansible/roles/ipareplica/README.md 3.3. Deploying an IdM replica using an Ansible playbook Complete this procedure to use an Ansible playbook to deploy an IdM replica. Prerequisites The managed node is a Red Hat Enterprise Linux 8 system with a static IP address and a working package manager. You have configured the inventory file for installing an IdM replica . You have configured the authorization for installing the IdM replica . Procedure Run the Ansible playbook: 3.4. Uninstalling an IdM replica using an Ansible playbook Note In an existing Identity Management (IdM) deployment, replica and server are interchangeable terms. For information on how to uninstall an IdM server, see Uninstalling an IdM server using an Ansible playbook or Using an Ansible playbook to uninstall an IdM server even if this leads to a disconnected topology . Additional resources Introduction to IdM servers and clients
[ipareplicas] replica1.idm.example.com replica2.idm.example.com replica3.idm.example.com [...] [ipaservers] server.idm.example.com [ipareplicas] replica1.idm.example.com replica2.idm.example.com replica3.idm.example.com [...] [ipaservers] server.idm.example.com replica1.idm.example.com [ipareplicas] replica2.idm.example.com replica3.idm.example.com ipareplica_servers=replica1.idm.example.com [ipaservers] server.idm.example.com [ipareplicas_tier1] replica1.idm.example.com [ipareplicas_tier2] replica2.idm.example.com \ ipareplica_servers=replica1.idm.example.com,server.idm.example.com --- - name: Playbook to configure IPA replicas (tier1) hosts: ipareplicas_tier1 become: true roles: - role: ipareplica state: present - name: Playbook to configure IPA replicas (tier2) hosts: ipareplicas_tier2 become: true roles: - role: ipareplica state: present [ipaservers] server.idm.example.com [ipareplicas] replica1.idm.example.com replica2.idm.example.com replica3.idm.example.com [...] [ipareplicas:vars] ipareplica_firewalld_zone= custom zone [ipaservers] server.idm.example.com [ipareplicas] replica1.idm.example.com replica2.idm.example.com replica3.idm.example.com [...] [ipareplicas:vars] ipareplica_setup_dns=true ipareplica_forwarders=192.0.2.1,192.0.2.2 [...] [ipaclient:vars] ipaclient_configure_dns_resolver=true ipaclient_dns_servers=192.168.100.1 - name: Playbook to configure IPA replicas hosts: ipareplicas become: true vars_files: - playbook_sensitive_data.yml roles: - role: ipareplica state: present [...] [ipareplicas:vars] ipaadmin_password=Secret123 - name: Playbook to configure IPA replicas hosts: ipareplicas become: true roles: - role: ipareplica state: present [...] [ipareplicas:vars] ipaadmin_principal=my_admin ipaadmin_password=my_admin_secret123 - name: Playbook to configure IPA replicas hosts: ipareplicas become: true roles: - role: ipareplica state: present ansible-playbook -i ~/MyPlaybooks/inventory ~/MyPlaybooks/install-replica.yml