Merge branch 'main' into flavors

Author: markgoddard

galaxy.yml

@@ -12,7 +12,7 @@ tags:
   - cloud
   - openstack
 dependencies:
-  openstack.cloud: "*"
+  "openstack.cloud": ">=2.1.0"
 repository: https://github.com/stackhpc/ansible-collection-openstack
 documentation: https://github.com/stackhpc/ansible-collection-openstack/branch/main/README.md
 homepage: https://github.com/stackhpc/ansible-collection-openstack

plugins/modules/baremetal_deploy_template.py

@@ -0,0 +1,74 @@
+OpenStack Container Clusters
+============================
+
+This role can be used to register container cluster templates in Magnum
+using the Magnum CLI.
+
+Requirements
+------------
+
+The OpenStack Magnum API should be accessible from the target host.
+
+Role Variables
+--------------
+
+`os_container_clusters_venv` is a path to a directory in which to create a
+virtualenv.
+
+`os_container_clusters_auth_type` is an authentication type compatible with the
+`auth_type` argument of `openstack.cloud` Ansible modules.
+
+`os_container_clusters_auth` is a dict containing authentication information
+compatible with the `auth` argument of `openstack.cloud` Ansible modules.
+
+`os_container_clusters_cacert` is an optional path to a CA certificate bundle.
+
+`os_container_clusters_templates` is a list of Magnum container cluster
+templates to register. Each item should be a dict containing container cluster
+template attributes.
+
+`os_container_clusters_public`: whether to register templates as public by
+default. Default is `false`.
+
+`os_container_clusters_templates_hide` (optional) whether to hide the given
+list of cluster templates by default. The `is_hidden` attribute can be used on
+individual templates to specify this as well. Default is False.
+
+Dependencies
+------------
+
+This role depends on the `stackhpc.openstack.os_openstackclient` and
+`stackhpc.openstack.os_openstacksdk` roles.
+
+Example Playbook
+----------------
+
+The following playbook registers a cluster template.
+
+    ---
+    - name: Ensure cluster templates are registered
+      hosts: localhost
+      roles:
+        - role: stackhpc.openstack.os_container_clusters
+          os_container_clusters_venv: "~/os-container-clusters-venv"
+          os_container_clusters_auth_type: "password"
+          os_container_clusters_auth:
+            project_name: <keystone project>
+            username: <keystone user>
+            password: <keystone password>
+            auth_url: <keystone auth URL>
+          os_container_clusters_templates:
+            - name: swarm-cluster
+              coe: swarm
+              master_flavor: m1.small
+              flavor: m1.small
+              image: fedora-25
+              external_network: ext
+              floating_ip_disabled: # leave empty to pass as flag without assigning value
+              labels:
+                etcd_volume_size: 3
+
+Author Information
+------------------
+
+- Mark Goddard (<[email protected]>)

roles/os_container_clusters/README.md

@@ -0,0 +1,16 @@
+---
+# Path to a directory in which to create a virtualenv.
+os_container_clusters_venv:
+# Authentication type.
+os_container_clusters_auth_type:
+# Authentication information.
+os_container_clusters_auth: {}
+# List of magnum container cluster templates. Each item should be a dict
+# mapping container cluster template attribute names to their values.
+os_container_clusters_templates: []
+# Upper constraints file for installation of python dependencies.
+os_container_clusters_upper_constraints_file:
+# Whether to make templates public
+os_container_clusters_public: false
+# Whether to hide templates by default
+os_container_clusters_templates_hide: false

roles/os_container_clusters/defaults/main.yml

@@ -0,0 +1,8 @@
+---
+dependencies:
+  - role: stackhpc.openstack.os_openstacksdk
+    os_openstacksdk_venv: "{{ os_container_clusters_venv }}"
+    os_openstacksdk_upper_constraints_file: "{{ os_container_clusters_upper_constraints_file }}"
+  - role: stackhpc.openstack.os_openstackclient
+    os_openstackclient_venv: "{{ os_container_clusters_venv }}"
+    os_openstackclient_upper_constraints_file: "{{ os_container_clusters_upper_constraints_file }}"

roles/os_container_clusters/meta/main.yml

@@ -0,0 +1,61 @@
+---
+- name: Ensure magnum client is installed
+  ansible.builtin.pip:
+    name: python-magnumclient
+    state: present
+    virtualenv: "{{ os_container_clusters_venv or omit }}"
+  become: "{{ os_container_clusters_venv == None }}"
+
+- 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: Ensure container cluster templates exist
+  vars:
+    ansible_python_interpreter: "{{ os_container_clusters_venv ~ '/bin/python' if os_container_clusters_venv != None else old_ansible_python_interpreter }}"
+  openstack.cloud.coe_cluster_template:
+    auth: "{{ os_container_clusters_auth }}"
+    auth_type: "{{ os_container_clusters_auth_type }}"
+    cacert: "{{ os_container_clusters_cacert | default(omit) }}"
+    interface: "{{ os_container_clusters_interface | default(omit, true) }}"
+    labels: "{{ item.labels | default(omit) }}"
+    external_network_id: "{{ item.external_network_id | default(undef(hint='You must provide an external network')) }}"
+    master_flavor_id: "{{ item.master_flavor | default(undef(hint='You must provide a master flavor')) }}"
+    flavor_id: "{{ item.flavor | default(undef(hint='You must provide a flavor')) }}"
+    image_id: "{{ item.image | default(undef(hint='You must provide an image')) }}"
+    name: "{{ item.name | default(undef(hint='You must provide a name')) }}"
+    coe: "{{ item.coe | default(undef(hint='You must provide a coe')) }}"
+    network_driver: "{{ item.network_driver | default(omit) }}"
+    master_lb_enabled: "{{ item.master_lb_enabled | default(True) | bool }}"
+    floating_ip_enabled: "{{ item.floating_ip_enabled | default(True) | bool }}"
+    dns_nameserver: "{{ item.dns_nameserver | default(omit) }}"
+    public: "{{ item.public | default(os_container_clusters_public) | bool }}"
+    docker_volume_size: "{{ item.docker_volume_size | default(omit) }}"
+    fixed_network: "{{ item.fixed_network | default(omit) }}"
+    fixed_subnet: "{{ item.fixed_subnet | default(omit) }}"
+    registry_enabled: "{{ item.registry_enabled | default(omit) }}"
+    tls_disabled: "{{ item.tls_disabled | default(omit) }}"
+    keypair_id: "{{ item.keypair_id | default(omit) }}"
+    volume_driver: "{{ item.volume_driver | default(omit) }}"
+    http_proxy: "{{ item.http_proxy | default(omit) }}"
+    https_proxy: "{{ item.https_proxy | default(omit) }}"
+    no_proxy: "{{ item.no_proxy | default(omit) }}"
+    state: "{{ item.state | default(omit) }}"
+  with_items: "{{ os_container_clusters_templates }}"
+
+# NOTE: The coe_cluster_template module does not currently support setting the
+# hidden parameter.
+- name: Hide cluster templates if specified
+  ansible.builtin.command: >
+    {{ os_container_clusters_venv ~ '/bin/' if os_container_clusters_venv else '' }}openstack
+    {% for auth_name, auth_value in os_container_clusters_auth.items() %}
+    --os-{{ auth_name | replace('_', '-') }}='{{ auth_value }}'
+    {% endfor %}
+    {% if os_container_clusters_cacert is defined %}
+    --os-cacert {{ os_container_clusters_cacert }}
+    {% endif %}
+    --os-interface=public
+    coe cluster template update {{ item.name }} replace hidden=True
+  with_items: "{{ os_container_clusters_templates }}"
+  when: item.is_hidden | default(os_container_clusters_templates_hide) | bool
+  changed_when: true

roles/os_container_clusters/tasks/main.yml

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

roles/os_container_clusters/tests/inventory

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

roles/os_container_clusters/tests/test.yml

@@ -34,8 +34,9 @@ catalog. Maybe be one of `public`, `admin`, or `internal`.
 
 `os_deploy_templates` is a list of Ironic deploy templates to register. Each
 item should be a dict containing following items:
-* `name`: Name of the deploy template.
-* `steps`: List of deploy steps.
+* `name`: Name of the deploy template. Required when the deploy template is
+  created, after which the name or ID may be used.
+* `steps`: List of deploy steps. Required when the deploy template is created.
 * `extra`: Dict of metadata, optional.
 * `uuid`: UUID, optional.
 * `state`: State, optional.