IPA Server Provisioning

Star 0
Version 1.1.0
IPA Server Provisioning
Maintainers
support[at]europeanweather.cloud
License
Support level
EWC
Category
Security Identity & Access Management Compute
Technology
Ansible Playbook Terraform Module

IPA Server Provisioning

IPA (acronym for identity, policy and audit) and its open-source implementation FreeIPA, serve both as a user management system and as your internal DNS nameserver.

This is a configuration template (i.e. an Ansible Playbook) to customize your environment in the European Weather Cloud (EWC).

The template is designed to:

  • Provision an instance via Terraform, with your specified VM image and desired flavor (a.k.a VM plan):

    • If a terraform.tfstate state file is not found under the user-defined directory, attempts to create the instance from scratch

    OR

    • if a terraform.tfstate file is found, leverages Terraform's out-of-the-box functionality to update the instance referenced on it
  • Validate that network/subnet configuration in the EWC tenancy

  • Configure the existing or newly provisioned instance such that it:

    • Provides DNS resolutions for discovery of resources (i.e. other virtual machines)
    • Enables centralized user and credentials creation/edition/deletion/authentication
    • Allows centralized authorization between users and resources
  • Automatically update the underlying subnet DNS nameserver to point to the newly configured IPA server

After successful provisioning, you can take advantage of Terraform built-in functionality to safely modify or delete the instance. You'll find the definition of your instance in main.tf, and its current state in terraform.tfstate, under the user-defined tf_project_path directory.

To learn the basics about managing infrastructure with Terraform, checkout the official documentation examples.

⚠️ Successfull execution leads to changes of the DNS nameserver(s) in your OpenStack subnet (includes now only the IP address of the new IPA server). This can negatively affect existing VMs within your subnet. To prevent issues, programatically update each VM via the IPA Client Enroll Flavour CommunityHub Item. Alternatively, you can manually add the new nameserver to their DNS configuration.

Prerequisites

💡 Versions listed correspond to minimal prerequisites.

To successfully run this playbook, the following packages should be available in your work environment:

Name Version License Home URL
git 2.0 GPLv2 https://git-scm.com/downloads
python 3.9 PSF https://www.python.org/downloads
ansible 2.15 GPLv3+ https://pypi.org/project/ansible
terraform 0.14 BSL https://developer.hashicorp.com/terraform/install

Usage

1. Download Ansible dependencies

💡 By default, Ansible Roles are installed under the ~/.ansible/roles directory within your working environment.

Download the correct version of the Ansible dependencies, if you haven't done so already:

ansible-galaxy role install -r requirements.yml

2. Configure and apply the template

2.1. Interactive Mode

By running the following command, you can trigger an interactive session that prompts you for the necessary user inputs, and then applies changes to your target EWC environment:

ansible-playbook ipa-server-provisioning.yml

2.2. Non-Interactive Mode

💡 To learn more about defining variables at runtime, checkout the official Ansible documentation.

You can also run in non-interactive mode by passing the --extra-vars or -e flag, followed by a map of key-value pairs; one for each and every available input (see inputs section below). For example:

ansible-playbook \
  -e '{
        "ewc_provider": "eumetsat",
        "tf_project_path":"~/iac/ipa-server-1",
        "app_name":"ipa",
        "instance_name":"server",
        "instance_index": 1,
        "flavor_name":"eo2.medium",
        "image_name":"Rocky-8.10-20250204105303",
        "public_keypair_name":"my-public-key",
        "private_keypair_path":"~/.ssh/id_rsa",
        "private_network_name": "private",
        "security_group_name": "ipa",
        "ipa_domain":"eumetsat.sandbox.ewc",
        "ipa_admin_username":"ipaadmin",
        "ipa_admin_password":"my-secret-password",
        "ipa_admin_givenname": "IPAADMIN",
        "ipa_admin_surname": "EWC"
    }' \
  ipa-server-provisioning.yml

Inputs

Name Description Type Default Required
ewc_provider your target EWC provider. Must match that the provider of your OpenStack application credentials. Valid input values are ecmwf or eumetsat. string n/a yes
tf_project_path path to terraform working directory. Example: ~/iac/ipa-server-1 string n/a yes
app_name application name, used as prefix in the full instance name. Example: ipa string n/a yes
instance_name name of the instance, used in the full instance name. Example: server string n/a yes
instance_index index or identifier for the instance, used as suffix in the full instance name. Example: 1 number n/a yes
flavor_name name the flavor to use for the instance. To learn about available options, checkout the official EWC VM plans documentation. 💡 A VM plan with at least 4GB of RAM is recommended for successful setup and stable operation. string n/a yes
image_name name of the image to use for the instance. For complete information on available options, see the official EWC Images documentation. ⚠️ Only RockyLinux 9.5 and RockyLinux 8.10 VM images are currently supported. This is due to constrains imposed by the required ewc-ansible-role-ipa-server Ansible Role. Example: Rocky-8.10-20250204105303 string n/a yes
public_keypair_name name of public keypair (stored in OpenStack) to be copied into the instance for remote SSH access string n/a yes
private_keypair_path path to the local private keypair to use for SSH access to the instance. Example: ~/.ssh/id_rsa string n/a yes
private_network_name private network name to attach the instance. Example: private string n/a yes
security_group_name security group name to apply to the instance. Example: ipa string n/a yes
ipa_domain domain name to be managed by the IPA server. Example: eumetsat.sandbox.ewc string n/a yes
ipa_admin_username username of administrator account to replace the default IPA admin string n/a yes
ipa_admin_password password of administrator account to replace the default IPA admin string n/a yes
ipa_admin_givenname given name of the administrator to replace the default IPA admin (needs not be a physical person). Example: EWC string n/a yes
ipa_admin_surname surname of the administrator to replace the default IPA admin (needs not to belong to a physical person). Example: IPAADMIN string n/a yes

Dependencies

⚠️ Only RockyLinux 9.5 and RockyLinux 8.10 VM images are currently supported. This is due to constrains imposed by the required ewc-ansible-role-ipa-server Ansible Role.

💡 A VM plan with at least 4GB of RAM is recommended for successful setup and stable operation.

Name Version License Home URL
ewc-tf-module-openstack-compute 1.4 MIT https://github.com/ewcloud/ewc-tf-module-openstack-compute
ewc-ansible-role-ipa-server 1.0 MIT https://github.com/ewcloud/ewc-ansible-role-ipa-server
Other
Deployable