cinder adoption: add support for PureStorage/FC

Support the adoption of a cinder/PureStorage backend.
This initial implementation only supports FiberChannel, but the code is generic
enough that it should be easy to add other supported protocols, following
the pattern already followed for the cinder/NetApp adoption.

In fact this code follows a lot the workflow already used for the
cinder/NetApp adoption, minimizing the amount of facts sets:
- the configuration is fetched from 17.1, checking if all required
  variables are available;
- sensitive details retrieved (basically the API key) are stored as
  a secret in the OpenShift cluster;
- a cinder-volume spec is defined using the retrieved configuration
  and the secret, and applied to the control plane.

Author: tosky

tests/roles/cinder_adoption/defaults/main.yaml

@@ -1,4 +1,4 @@
-# Volume backends: ceph, ontap-nfs, ontap-iscsi
+# Volume backends: ceph, ontap-nfs, ontap-iscsi, pure-fc
 # Backup backends: ceph, swift, ontap-nfs
 cinder_volume_backend: ""
 cinder_backup_backend: ""
@@ -116,8 +116,9 @@ cinder_conf_path: "/tmp/cinder.conf"
 # The path where we temporarily save shares.conf fetched from TripleO controller node
 cinder_nfs_shares_conf_path: "/tmp/shares.conf"
 
-# The backend name generated by puppet-tripleo
+# The backend names generated by puppet-tripleo
 cinder_netapp_backend: "tripleo_netapp"
+cinder_pure_backend: "tripleo_pure"
 
 # List of netapp credentials to be captured from tripleo cinder.conf
 cinder_volume_netapp_vars:
@@ -127,6 +128,11 @@ cinder_volume_netapp_vars:
   - netapp_vserver
   - netapp_pool_name_search_pattern
 
+# List of pure credentials to be captured from tripleo cinder
+cinder_volume_pure_vars:
+  - san_ip
+  - pure_api_token
+
 # Vars for cinder-backup
 cinder_backup_nfs_backup_mount_point_base: "/var/lib/cinder/backup"
 cinder_retry_delay: 5

tests/roles/cinder_adoption/tasks/cinder_volume_pure.yaml

@@ -0,0 +1,61 @@
+- name: Slurp cinder.conf from controller
+  become: true
+  ansible.builtin.shell: |
+    {{ shell_header }}
+    CONTROLLER1_SCP="{{ controller1_ssh  | regex_replace('^ssh', 'scp')}}"
+    ${CONTROLLER1_SCP}:{{ cinder_tripleo_path }} {{ cinder_conf_path }}
+    chmod a+r {{ cinder_conf_path }}
+
+- name: Stat the retrieved cinder.conf file
+  ansible.builtin.stat:
+    path: "{{ cinder_conf_path }}"
+  register: cinder_conf
+
+- name: Fail if cinder.conf is not present
+  when: not cinder_conf.stat.exists
+  ansible.builtin.fail:
+    msg: "cinder.conf does not exist"
+
+- name: Deploy Podified Cinder-Volume - Pure
+  vars:
+    cinder_pure_config: |
+      {% set cinder_pure_conf = {} %}
+      {% for item in cinder_volume_pure_vars %}
+      {% set value = lookup('ansible.builtin.ini', item, file=cinder_conf_path, section=cinder_pure_backend, allow_no_value=True) %}
+      {% set _ = cinder_pure_conf.__setitem__(item, value) %}
+      {% endfor %}
+      {{ cinder_pure_conf }}
+    cinder_configuration_template:
+      pure-fc: 'cinder_volume_pure_fc.yaml.j2'
+  block:
+    - name: Fail if cinder_pure_config params are not defined
+      when: |
+        cinder_pure_config.san_ip is not defined or
+        cinder_pure_config.pure_api_token is not defined
+      ansible.builtin.fail:
+        msg:
+          - 'Missing required pure-related parameters in the configuration of the cluster being adopted'
+
+    - name: Render Pure OpenShift Secret template
+      ansible.builtin.template:
+        src: "{{ role_path }}/templates/cinder-volume-pure-secrets.yaml.j2"
+        dest: /tmp/cinder-volume-pure-secrets.yaml
+        mode: "0600"
+
+    - name: Render cinder pure OpenShift patch file template
+      ansible.builtin.template:
+        src: "{{ role_path }}/templates/{{ cinder_configuration_template[cinder_volume_backend] }}"
+        dest: /tmp/cinder_volume_pure_config.yaml
+        mode: "0600"
+
+    - name: Apply the rendered Pure secret in the openstack namespace
+      ansible.builtin.shell: |
+        {{ shell_header }}
+        {{ oc_header }}
+        oc apply -f /tmp/cinder-volume-pure-secrets.yaml
+
+    - name: Configure the appropriate pure backend
+      ansible.builtin.shell: |
+        {{ shell_header }}
+        {{ oc_header }}
+        oc patch openstackcontrolplane openstack --type=merge --patch-file=/tmp/cinder_volume_pure_config.yaml

tests/roles/cinder_adoption/tasks/volume_backend.yaml

@@ -10,3 +10,8 @@
     cinder_volume_backend == 'ontap-nfs' or
     cinder_volume_backend == 'ontap-iscsi'
   ansible.builtin.include_tasks: cinder_volume_netapp.yaml
+
+- name: deploy podified Cinder volume with pure FC
+  when: >
+    cinder_volume_backend == 'pure-fc'
+  ansible.builtin.include_tasks: cinder_volume_pure.yaml

tests/roles/cinder_adoption/templates/cinder-volume-pure-secrets.yaml.j2

@@ -0,0 +1,15 @@
+# Define the "cinder-volume-pure-secrets" Secret that contains sensitive
+# information pertaining to the pure-based backends.
+apiVersion: v1
+kind: Secret
+metadata:
+  labels:
+    service: cinder
+    component: cinder-volume
+  name: cinder-volume-pure-secrets
+type: Opaque
+stringData:
+  pure-cinder-secrets: |
+    [{{ cinder_pure_backend }}]
+    san_ip = {{ cinder_pure_config.san_ip }}
+    pure_api_token = {{ cinder_pure_config.pure_api_token }}

tests/roles/cinder_adoption/templates/cinder_volume_pure_fc.yaml.j2

@@ -0,0 +1,14 @@
+spec:
+  cinder:
+    template:
+      cinderVolumes:
+        pure-fc:
+          networkAttachments:
+            - storage
+          customServiceConfig: |
+            [{{ cinder_pure_backend }}]
+            volume_backend_name=pure-fc
+            volume_driver=cinder.volume.drivers.pure.PureFCDriver
+            consistencygroup_support=True
+          customServiceConfigSecrets:
+            - cinder-volume-pure-secrets