roles: add variables documentation

Update the role's documentations to include the variables that can be set for each role. Also move the default variables values which were in the playbooks to the roles themselves. Signed-off-by: Mathieu Dupré <[email protected]>
seapath · Dec 19, 2024 · b20f554 · b20f554
1 parent b9efa06
commit b20f554
Show file tree

Hide file tree

Showing 33 changed files with 203 additions and 66 deletions.
diff --git a/playbooks/cluster_setup_libvirt.yaml b/playbooks/cluster_setup_libvirt.yaml
@@ -8,8 +8,5 @@
 - name: Configure libvirt
   hosts: hypervisors:&cluster_machines
   become: true
-  vars:
-    rbd_pool_name: "{{ libvirt_rbd_pool | default('rbd') }}"
-    pool_name: "{{ libvirt_pool_name | default('ceph') }}"
   roles:
     - configure_libvirt
diff --git a/roles/add_livemigration_user/README.md b/roles/add_livemigration_user/README.md
@@ -1,14 +1,18 @@
 # Add LiveMigration User Role
 
-This role sets the live migration user on the cluster, with ssh key exchanges
+This role sets the live migration user on the cluster, with ssh key exchanges.
+If the user does not already exist, they will be created.
 
 ## Requirements
 
 no requirement.
 
 ## Role Variables
 
-- livemigration_user
+| Variable                | Required | Type   | Comments                                                           |
+|-------------------------|----------|--------|--------------------------------------------------------------------|
+| livemigration_user      | no       | String | The livemigration user. If not defined, the role will do nothing.  |
+
 
 ## Example Playbook
 

diff --git a/roles/ceph_expansion_lv/README.md b/roles/ceph_expansion_lv/README.md
@@ -4,11 +4,18 @@ This role extends the ceph LV to whatever is ask in the variables
 
 ## Requirements
 
-no requirement.
+No requirement.
 
 ## Role Variables
 
-- lvm_volumes
+| Variable                | Required | Type          | Comments                                                           |
+|-------------------------|----------|---------------|--------------------------------------------------------------------|
+| lvm_volumes             | no       | Array of dict | LVM volumes                                                        |
+| -> data_vg              | no       |String         | TODO                                                               |
+| -> data                 | no       |String         | TODO                                                               |
+| -> data_size            | no       |String         | TODO                                                               |
+| ansible_lvm             | no       | Dict          | TODO                                                               |
+
 
 ## Example Playbook
 

diff --git a/roles/configure_admin_user/README.md b/roles/configure_admin_user/README.md
@@ -1,13 +1,16 @@
-# Configure admin_user Role
+# Configure admin user Role
 This role copy the root ssh key to admin user's. This user is used by Debian when using consolevm.
 
 ## Requirements
 
-- detect_seapath_distro
+No requirement.
 
 ## Role Variables
 
-- admin_user
+| Variable                | Required | Type   | Comments                                                           |
+|-------------------------|----------|--------|--------------------------------------------------------------------|
+| seapath_distro          | yes      | String | SEAPATH variant. *CentOS*, *Debian* or *Yocto*. The variable can be set automatically using the *detect_seapath_distro role* |
+| admin_user              | yes      | String | The admin user.                                                    |
 
 ## Example Playbook
 

diff --git a/roles/configure_admin_user/meta/main.yml b/roles/configure_admin_user/meta/main.yml
@@ -10,5 +10,9 @@ galaxy_info:
   - name: Debian
     versions:
     - all
+  platforms:
+  - name: CentOS
+    versions:
+    - all
 dependencies:
   - role: detect_seapath_distro
diff --git a/roles/configure_ha/README.md b/roles/configure_ha/README.md
@@ -4,21 +4,35 @@ This role configures the High Availability part of a seapath cluster (Corosync a
 
 ## Requirements
 
-- detect_seapath_distro
+No requirement.
 
 ## Role Variables
 
-- corosync_node_list
-- tmpdir
-- crm_cmd_path
-- vmmgrapi_cmd_list
-- extra_crm_cmd_to_run
+| Variable                | Required | Type        | Default | Comments                                                                       |
+|-------------------------|----------|-------------|---------|--------------------------------------------------------------------------------|
+| seapath_distro          | yes      | String      |         | SEAPATH variant. *CentOS*, *Debian* or *Yocto*. The variable can be set automatically using the *detect_seapath_distro role* |
+| corosync_node_list      | yes      | String list |         | List of all corosync nodes. Usualy `{{ groups['cluster_machines'] \| list }}`  |
+| tmpdir                  | no       | String      | /tmp    | Tempory directory path to use                                                  |
+| enable_vmmgr_http_api   | no       | Bool        | false   | Set to true to enable SEAPATH vm-manager REST API                              |
+| admin_cluster_ip        | no       | String      |         | IP of the REST API. If not set the m-manager REST API will be disabled even if `enable_vmmgr_http_api is set to true` |
+| extra_crm_cmd_to_run    | no       | String      |         | List of `crm configure` commands to run separate by a new line.                |
 
 ## Example Playbook
 
 ```yaml
 - name: Configure HA
   hosts: cluster_machines
+  vars:
+    corosync_node_list: "{{ groups['cluster_machines'] | list }}"
+    extra_crm_cmd_to_run: >-
+      primitive st-1 stonith:external/rackpdu params hostlist=h1 pduip=192.168.3.127
+      location l-st-h1 st-1 -inf: h1
+      primitive st-2 stonith:eexternal/rackpdu params hostlist=h2 pduip=192.168.3.128
+      location l-st-h2 st-2 -inf: h2
+      primitive st-3 stonith:eexternal/rackpdu params hostlist=h3 pduip=192.168.3.129
+      location l-st-h3 st-3 -inf: h3
+      property stonith-enabled=true
+
   roles:
     - { role: seapath_ansible.configure_ha }
 ```
diff --git a/roles/configure_ha/defaults/main.yml b/roles/configure_ha/defaults/main.yml
@@ -0,0 +1,6 @@
+# Copyright (C) 2024 Savoir-faire Linux, Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+---
+tmpdir: "/tmp"
+enable_vmmgr_http_api: false
diff --git a/roles/configure_ha/meta/main.yml b/roles/configure_ha/meta/main.yml
@@ -8,5 +8,11 @@ galaxy_info:
   - name: Debian
     versions:
     - all
+  - name: CentOS
+    versions:
+    - all
+  - name: Yocto
+    versions:
+    - all
 dependencies:
   - role: detect_seapath_distro
diff --git a/roles/configure_ha/tasks/main.yml b/roles/configure_ha/tasks/main.yml
@@ -145,7 +145,6 @@
     cmd: crm -d config load update -
     stdin: "{{ vmmgrapi_cmd_list }}"
   when:
-    - enable_vmmgr_http_api is defined
     - enable_vmmgr_http_api is true
     - admin_cluster_ip is defined
   run_once: true

diff --git a/roles/configure_libvirt/README.md b/roles/configure_libvirt/README.md
@@ -1,15 +1,17 @@
 # Configure Libvirt Role
 
-This role configure the libvirt secret and pool for ceph to use
+This role create a libvirt storage pool for ceph.
 
 ## Requirements
 
-no requirement.
+No requirement.
 
 ## Role Variables
 
-- libvirt_rbd_pool
-- libvirt_pool_name
+| Variable                | Required | Type   | Default | Comments                                       |
+|-------------------------|----------|--------|---------|------------------------------------------------|
+| libvirt_rbd_pool        | no       | String | rbd     | The Ceph RBD pool use by libvirts              |
+| libvirt_pool_name       | no       | String | ceph    | The name of the libvirt storage pool to create |
 
 ## Example Playbook
 

diff --git a/roles/configure_libvirt/defaults/main.yml b/roles/configure_libvirt/defaults/main.yml
@@ -0,0 +1,6 @@
+# Copyright (C) 2024 Savoir-faire Linux, Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+---
+libvirt_rbd_pool: "rbd"
+libvirt_pool_name: "ceph"
diff --git a/roles/configure_libvirt/meta/main.yml b/roles/configure_libvirt/meta/main.yml
@@ -3,11 +3,17 @@
 ---
 galaxy_info:
   author: "Seapath"
-  description: configures the libvirt secret and pool for ceph to use
+  description: Create a libvirt storage pool for ceph.
   license: Apache-2.0
   min_ansible_version: 2.9.10
   platforms:
   - name: Debian
     versions:
     - all
+  - name: CentOS
+    versions:
+    - all
+  - name: Yocto
+    versions:
+    - all
 dependencies: []
diff --git a/roles/configure_libvirt/tasks/main.yml b/roles/configure_libvirt/tasks/main.yml
@@ -71,15 +71,15 @@
   community.libvirt.virt_pool:
       command: define
       xml: '{{ lookup("template", "libvirt_pool.xml.j2") }}'
-      name: "{{ pool_name }}"
+      name: "{{ libvirt_pool_name }}"
 - name: Start libvirt pool
   community.libvirt.virt_pool:
       state: active
-      name: "{{ pool_name }}"
+      name: "{{ libvirt_pool_name }}"
 - name: Autostart pool
   community.libvirt.virt_pool:
       autostart: yes
-      name: "{{ pool_name }}"
+      name: "{{ libvirt_pool_name }}"
 - name: Refresh pool
   command: virsh pool-refresh --pool ceph
   changed_when: false

diff --git a/roles/configure_libvirt/templates/libvirt_pool.xml.j2 b/roles/configure_libvirt/templates/libvirt_pool.xml.j2
@@ -1,7 +1,7 @@
 <pool type="rbd">
-  <name>{{ pool_name }}</name>
+  <name>{{ libvirt_pool_name }}</name>
   <source>
-    <name>{{ rbd_pool_name }}</name>
+    <name>{{ libvirt_rbd_pool }}</name>
     <host name='rbd' port='6789' />
     <auth username='libvirt' type='ceph'>
       <secret uuid='{{ libvirt_uuid_rbd }}'/>

diff --git a/roles/configure_nic_irq_affinity/README.md b/roles/configure_nic_irq_affinity/README.md
@@ -5,16 +5,23 @@ This is useful is you use macvlan driver for your containers or VMs
 
 ## Requirements
 
-no requirement.
+No requirement.
 
 ## Role Variables
 
-- nics_affinity
+| Variable                | Required | Type       | Comments                                                           |
+|-------------------------|----------|----------- |--------------------------------------------------------------------|
+| nics_affinity           | no       | Dict array | Array of dictionnaries, nic / affinity (e.g. "eth0": "3-4"). Affinity can be a single core, or a range seperate by *-*. Multiple values can be set separate by a coma. |
 
 ## Example Playbook
 
 ```yaml
 - hosts: cluster_machines
+  vars:
+    nics_affinity:
+      - "eth0": "3-4"
+      - "eth1": "9"
+      - "eth2": "7,10-13"
   roles:
     - { role: seapath_ansible.configure_nic_irq_affinity }
 ```
diff --git a/roles/configure_nic_irq_affinity/handlers/main.yml b/roles/configure_nic_irq_affinity/handlers/main.yml
@@ -0,0 +1,11 @@
+# Copyright (C) 2024 Savoir-faire Linux, Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+---
+
+- name: Enable and start NIC irq affinity service
+  systemd:
+    name: setup_nic_irq_affinity.service
+    enabled: yes
+    state: started
+    daemon_reload: yes
diff --git a/roles/configure_nic_irq_affinity/meta/main.yml b/roles/configure_nic_irq_affinity/meta/main.yml
@@ -10,5 +10,10 @@ galaxy_info:
   - name: Debian
     versions:
     - all
+  - name: Yocto
+    versions:
+    - all
+  - name: CentOS
+    versions:
+    - all
 dependencies: []
-
diff --git a/roles/configure_nic_irq_affinity/tasks/main.yml b/roles/configure_nic_irq_affinity/tasks/main.yml
@@ -10,23 +10,18 @@
         src: setup_nic_irq_affinity.py
         dest: /etc/systemd/system/setup_nic_irq_affinity.py
         mode: 0755
-    
+
     - name: Copy NIC irq affinity service
       copy:
         src: setup_nic_irq_affinity.service
         dest: /etc/systemd/system/setup_nic_irq_affinity.service
         mode: 0644
-    
+
     - name: Copy NIC irq affinity environment file
       template:
         src: setup_nic_irq_affinity.j2
         dest: /etc/default/setup_nic_irq_affinity
         mode: 0644
-
-    - name: Enable and start NIC irq affinity service
-      systemd:
-        name: setup_nic_irq_affinity.service
-        enabled: yes
-        state: started
-        daemon_reload: yes
+
   when: nics_affinity is defined
+  notify: Enable and start NIC irq affinity service
diff --git a/roles/conntrackd/README.md b/roles/conntrackd/README.md
@@ -4,12 +4,16 @@ This role configure the conntrackd feature
 
 ## Requirements
 
-no requirement.
+No requirement.
 
 ## Role Variables
 
 - conntrackd_ignore_ip_list
 
+| Variable                   | Required | Type   | Comments                                    |
+|----------------------------|----------|--------|---------------------------------------------|
+| conntrackd_ignore_ip_list  | no       | Bool   | Enable contrackd if the variable is defined |
+
 ## Example Playbook
 
 ```yaml

diff --git a/roles/conntrackd/meta/main.yml b/roles/conntrackd/meta/main.yml
@@ -10,5 +10,7 @@ galaxy_info:
   - name: Debian
     versions:
     - all
+  - name: CentOS
+    versions:
+    - all
 dependencies: []
-
diff --git a/roles/deploy_cukinia/README.md b/roles/deploy_cukinia/README.md
@@ -4,11 +4,11 @@ This role deploys the cukinia utility
 
 ## Requirements
 
-no requirement.
+No requirement.
 
 ## Role Variables
 
-no variable.
+No variable.
 
 ## Example Playbook
 

diff --git a/roles/deploy_cukinia/files/cukinia b/roles/deploy_cukinia/files/cukinia
diff --git a/roles/deploy_cukinia_tests/README.md b/roles/deploy_cukinia_tests/README.md
@@ -4,11 +4,11 @@ This role deploys the cukinia tests
 
 ## Requirements
 
-no requirement.
+No requirement.
 
 ## Role Variables
 
-- filter (can be "none", "hosts", "observers" or "guests")
+No variable.
 
 ## Example Playbook
 

diff --git a/roles/deploy_cukinia_tests/cukinia-tests b/roles/deploy_cukinia_tests/cukinia-tests
diff --git a/roles/deploy_python3_setup_ovs/README.md b/roles/deploy_python3_setup_ovs/README.md
@@ -4,11 +4,11 @@ deploys python3-setup-ovs (seapath-config_ovs)
 
 ## Requirements
 
-no requirement.
+No requirement.
 
 ## Role Variables
 
-no variable.
+No variable.
 
 ## Example Playbook
 

diff --git a/roles/deploy_python3_setup_ovs/meta/main.yml b/roles/deploy_python3_setup_ovs/meta/main.yml
@@ -10,5 +10,7 @@ galaxy_info:
   - name: Debian
     versions:
     - all
+  - name: CentOS
+    versions:
+    - all
 dependencies: []
-
+0 −1		cukinia/common_security_tests.d/apt.conf.j2
+2 −0		cukinia/common_security_tests.d/kernel.conf
+0 −1		cukinia/common_security_tests.d/systemd.conf