Introduce ci_lvms_storage role

The ci_lvms_storage role aims to be a drop in replacement
for ci_local_storage. It uses LVMS (Logical Volume Manager
Storage) based on the TopoLVM CSI driver to dynamically
provision local storage built from block devices on OCP
nodes.

This role requires cifmw_lvms_disk_list to contain a list of
paths to block devices which already exist on OCP nodes. If
the cifmw_devscripts_config_overrides.vm_extradisks_list list
contains "vda vdb", then it will create these block devices and
cifmw_lvms_disk_list should be set to ['/dev/vda', '/dev/vdb'].
This role will then pass this list to the deviceSelector list
used by the LVMCluster CRD.

This patch introduces the role but ci_local_storage is still
used by the 06-deploy-{architecture,edpm}.yml playbooks unless
cifmw_use_lvms is true. The ci_gen_kustomize_values role is
updated to set the storageClass to lvms-local-storage only if
cifmw_use_lvms is true. Otherwise it keeps its default of
local-storage. A similar change has been made to the role
test_operator so that Tempest uses the chosen storage class.

In a follow up patch we can default cifmw_use_lvms to true so
LVMS becomes opt out. For now it is opt in for early testing.

Signed-off-by: John Fulton <[email protected]>
Related: https://issues.redhat.com/browse/OSPRH-2749

Author: fultonj

docs/dictionary/en-custom.txt

@@ -19,6 +19,7 @@ authfile
 autoscale
 autostart
 awk
+backend
 backends
 baremetal
 baremetalhost
@@ -90,6 +91,7 @@ cri
 crio
 crs
 crypto
+csi
 csr
 csv
 ctl
@@ -262,6 +264,8 @@ losetup
 lsblk
 lv
 lvm
+lvmcluster
+lvms
 lweyzmmtmji
 machinenetwork
 macos
@@ -351,6 +355,7 @@ osd
 osp
 osprh
 otz
+overprovisionratio
 ovirt
 ovirtmgmt
 ovn
@@ -370,6 +375,8 @@ polarion
 polkit
 pragadeeswaran
 pre
+prepend
+prepended
 prikey
 privatekey
 projectquay
@@ -433,6 +440,7 @@ sha
 shiftstack
 shiftstackclient
 sig
+sizepercent
 skbg
 skiplist
 specificities
@@ -472,6 +480,7 @@ tmux
 tobiko
 toctree
 todo
+topolvm
 traceback
 tripleo
 ttl

docs/source/usage/01_usage.md

@@ -20,6 +20,7 @@ are shared among multiple roles:
 - `cifmw_use_libvirt`: (Bool) toggle libvirt support.
 - `cifmw_use_crc`: (Bool) toggle rhol/crc usage.
 - `cifmw_use_uefi`: (Bool) toggle UEFI support in libvirt_manager provided VMs.
+- `cifmw_use_lvms`: (Bool) toggle LVMS support. Defaults to `false`.
 - `cifmw_openshift_kubeconfig`: (String) Path to the kubeconfig file if externally provided. If provided will be the kubeconfig to use and update after login.
 - `cifmw_openshift_api`: (String) Path to the kubeconfig file. If provided will be the API to authenticate against.
 - `cifmw_openshift_user`: (String) Login user. If provided, the user that logins.

playbooks/06-deploy-architecture.yml

@@ -146,6 +146,15 @@
     - name: Configure Storage Class
       ansible.builtin.import_role:
         name: ci_local_storage
+      when: not cifmw_use_lvms | default(false)
+      tags:
+        - storage
+        - edpm_bootstrap
+
+    - name: Configure LVMS Storage Class
+      ansible.builtin.include_role:
+        name: ci_lvms_storage
+      when: cifmw_use_lvms | default(false)
       tags:
         - storage
         - edpm_bootstrap

playbooks/06-deploy-edpm.yml

@@ -23,6 +23,12 @@
     - name: Configure Storage Class
       ansible.builtin.include_role:
         name: ci_local_storage
+      when: not cifmw_use_lvms | default(false)
+
+    - name: Configure LVMS Storage Class
+      ansible.builtin.include_role:
+        name: ci_lvms_storage
+      when: cifmw_use_lvms | default(false)
 
     - name: Run edpm_prepare
       ansible.builtin.include_role:

roles/ci_gen_kustomize_values/README.md

@@ -33,6 +33,8 @@ with a message.
 * `cifmw_ci_gen_kustomize_values_userdata_b64`: (List) Base64 encoded list of data to combine in the generated output.
   Defaults to `[]`.
 * `ci_gen_kustomize_fetch_ocp_state`: (Boolean) If true it enables generating CI templates based on the OCP state. Defaults to `true`.
+* `cifmw_ci_gen_kustomize_values_storage_class_prefix`: (String) Prefix for `storageClass` in generated values.yaml files. Defaults to `"lvms-"` only if `cifmw_use_lvms` is True, otherwise it defaults to `""`. The prefix is prepended to the `cifmw_ci_gen_kustomize_values_storage_class`. It is not recommended to override this value, instead set `cifmw_use_lvms` True or False.
+* `cifmw_ci_gen_kustomize_values_storage_class`: (String) Value for `storageClass` in generated values.yaml files. Defaults to `"lvms-local-storage"` only if `cifmw_use_lvms` is True, otherwise it defaults to `"local-storage"`.
 
 ### Specific parameters for edpm-values
 This configMap needs some more parameters in order to properly override the `architecture` provided one.

roles/ci_gen_kustomize_values/defaults/main.yml

@@ -67,6 +67,8 @@ cifmw_ci_gen_kustomize_values_nameservers: []
 cifmw_ci_gen_kustomize_values_userdata: {}
 cifmw_ci_gen_kustomize_values_userdata_b64: []
 ci_gen_kustomize_fetch_ocp_state: true
+cifmw_ci_gen_kustomize_values_storage_class_prefix: "{{ 'lvms-' if cifmw_use_lvms | default(false) | bool else '' }}"
+cifmw_ci_gen_kustomize_values_storage_class: "{{ cifmw_ci_gen_kustomize_values_storage_class_prefix }}local-storage"
 
 # Those parameter must be set if you want to edit an "edpm-values"
 # cifmw_ci_gen_kustomize_values_ssh_authorizedkeys

roles/ci_gen_kustomize_values/templates/bgp/network-values/values.yaml.j2

@@ -142,4 +142,4 @@ data:
       metallb.universe.tf/loadBalancerIPs: {{ cifmw_networking_env_definition.networks['internalapi'].network_v4 | ansible.utils.ipmath(86) }}
 
   lbServiceType: LoadBalancer
-  storageClass: local-storage
+  storageClass: {{ cifmw_ci_gen_kustomize_values_storage_class }}

roles/ci_gen_kustomize_values/templates/common/network-values/values.yaml.j2

@@ -126,4 +126,4 @@ data:
       metallb.universe.tf/loadBalancerIPs: {{ cifmw_networking_env_definition.networks['internalapi'].network_v4 | ansible.utils.ipmath(86) }}
 
   lbServiceType: LoadBalancer
-  storageClass: local-storage
+  storageClass: {{ cifmw_ci_gen_kustomize_values_storage_class }}

roles/ci_gen_kustomize_values/templates/ovs-dpdk-sriov/network-values/values.yaml.j2

@@ -126,4 +126,4 @@ data:
       metallb.universe.tf/loadBalancerIPs: {{ cifmw_networking_env_definition.networks['internalapi'].network_v4 | ansible.utils.ipmath(86) }}
 
   lbServiceType: LoadBalancer
-  storageClass: local-storage
+  storageClass: {{ cifmw_ci_gen_kustomize_values_storage_class }}

roles/ci_gen_kustomize_values/templates/uni01alpha/network-values/values.yaml.j2

@@ -129,4 +129,4 @@ data:
       metallb.universe.tf/loadBalancerIPs: {{ cifmw_networking_env_definition.networks['internalapi'].network_v4 | ansible.utils.ipmath(86) }}
 
   lbServiceType: LoadBalancer
-  storageClass: local-storage
+  storageClass: {{ cifmw_ci_gen_kustomize_values_storage_class }}