Merge pull request #11 from stackhpc/host-aggregates

Add os_host_aggregates role

Author: markgoddard

roles/os_host_aggregates/README.md

@@ -0,0 +1,70 @@
+OpenStack Host Aggregates
+=========================
+
+This role can be used to register host aggregates in Nova using the
+`openstack.cloud.host_aggregate` module.
+
+Requirements
+------------
+
+The OpenStack Nova API should be accessible from the target host.
+
+Role Variables
+--------------
+
+`os_host_aggregates_venv` is a path to a directory in which to create a
+virtualenv.
+
+`os_host_aggregates_auth_type` is an authentication type compatible with the
+`auth_type` argument of `openstack.cloud` Ansible modules.
+
+`os_host_aggregates_auth` is a dict containing authentication information
+compatible with the `auth` argument of `openstack.cloud` Ansible modules.
+
+`os_host_aggregates_cacert` is an optional path to a CA certificate bundle.
+
+`os_host_aggregates_interface` is the endpoint URL type to fetch from the
+service catalog. Maybe be one of `public`, `admin`, or `internal`.
+
+`os_host_aggregates` is a list of Nova host aggregates to register. Each item
+should be a dict containing the item 'name', and optionally:
+
+* 'availability_zone' (name of the availability zone to set on the aggregate)
+* 'hosts' (list of hostnames to add to the aggregate)
+* 'metadata' (dict of key/value pairs to set on the aggregate)
+
+Dependencies
+------------
+
+This role depends on the `stackhpc.openstack.os_openstacksdk` role.
+
+Example Playbook
+----------------
+
+The following playbook registers a Nova host aggregate.
+
+    ---
+    - name: Ensure Nova host aggregates are registered
+      hosts: localhost
+      roles:
+        - role: stackhpc.openstack.os_host_aggregates
+          os_host_aggregates_venv: "~/os-host-aggregates-venv"
+          os_host_aggregates_auth_type: "password"
+          os_host_aggregates_auth:
+            project_name: <keystone project>
+            username: <keystone user>
+            password: <keystone password>
+            auth_url: <keystone auth URL>
+          os_host_aggregates:
+            - name: db_aggregate
+              availability_zone: az1
+              hosts:
+                - host1
+                - host2
+              metadata:
+                type: dbcluster
+
+Author Information
+------------------
+
+- Pierre Riteau (<[email protected]>)

roles/os_host_aggregates/defaults/main.yml

@@ -0,0 +1,17 @@
+---
+# Path to a directory in which to create a virtualenv.
+os_host_aggregates_venv:
+# Authentication type.
+os_host_aggregates_auth_type:
+# Authentication information.
+os_host_aggregates_auth: {}
+# Endpoint URL type to fetch from the service catalog. Maybe be one of:
+# public, admin, or internal.
+os_host_aggregates_interface:
+# List of nova host aggregates to register. Each item should be a dict containing the
+# following items:
+# - 'name': Name of the host aggregate.
+# - 'availability_zone': Name of the availability zone, optional.
+# - 'hosts': List of hosts to add to the aggregate, optional.
+# - 'metadata': Dict of key/value pairs to set on the aggregate, optional.
+os_host_aggregates: [] # noqa var-naming[no-role-prefix]

roles/os_host_aggregates/meta/main.yml

@@ -0,0 +1,4 @@
+---
+dependencies:
+  - role: stackhpc.openstack.os_openstacksdk
+    os_openstacksdk_venv: "{{ os_host_aggregates_venv }}"

roles/os_host_aggregates/tasks/host-aggregates.yml

@@ -0,0 +1,13 @@
+---
+- name: Ensure nova host aggregates exist
+  openstack.cloud.host_aggregate:
+    auth_type: "{{ os_host_aggregates_auth_type }}"
+    auth: "{{ os_host_aggregates_auth }}"
+    cacert: "{{ os_host_aggregates_cacert | default(omit) }}"
+    interface: "{{ os_host_aggregates_interface | default(omit, true) }}"
+    name: "{{ item.name }}"
+    availability_zone: "{{ item.availability_zone | default(omit) }}"
+    hosts: "{{ item.hosts | default(omit) }}"
+    metadata: "{{ item.metadata | default(omit) }}"
+    state: present
+  with_items: "{{ os_host_aggregates }}"

roles/os_host_aggregates/tasks/main.yml

@@ -0,0 +1,9 @@
+---
+- name: Set a fact about the Ansible python interpreter
+  ansible.builtin.set_fact:
+    old_ansible_python_interpreter: "{{ ansible_python_interpreter | default('/usr/bin/python3') }}"
+
+- name: Import host-aggregates.yml
+  ansible.builtin.import_tasks: host-aggregates.yml
+  vars:
+    ansible_python_interpreter: "{{ os_host_aggregates_venv ~ '/bin/python' if os_host_aggregates_venv != None else old_ansible_python_interpreter }}"

roles/os_host_aggregates/tests/inventory

@@ -0,0 +1 @@
+localhost ansible_connection='local' ansible_python_interpreter='/usr/bin/env python'

roles/os_host_aggregates/tests/test.yml

@@ -0,0 +1,6 @@
+---
+- name: Test os_host_aggregates role
+  hosts: all
+  connection: local
+  roles:
+    - stackhpc.openstack.os_host_aggregates