Create section_rhoso18_flashblade_configuration.rst

Author: sdodsley

source/manila/configuration/manila_config_files/section_rhoso18_flashblade_configuration.rst

@@ -0,0 +1,164 @@
+Deploying Pure Storage FlashBlade Manila driver in a Red Hat OpenStack Services on OpenShift 18.0
+=================================================================================================
+
+.. _purestorage-flashblade-rhoso18:
+
+Overview
+--------
+
+This guide shows how to configure and deploy the Pure Storage FlashBlade Manila driver in a
+**Red Hat OpenStack Services on OpenShift (RHOSO) 18.0** deployment.
+After reading this, you'll be able to define the proper configuration and
+deploy single or multiple FlashBlade manila back ends in a RHOSO cluster.
+
+.. note::
+
+  For more information about RHOSO, please refer to its `documentation pages
+  <https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html/deploying_red_hat_openstack_services_on_openshift/index>`_.
+
+Requirements
+------------
+
+In order to deploy Pure Storage FlashBlade Manila back ends, you should have the
+following requirements satisfied:
+
+- Pure Storage FlashBlades deployed and ready to be used as Manila
+  back ends. See :ref:`manila_flashblade_prerequisites` for more details.
+
+- RHOSO openstack control plane deployed where Manila services will be configured.
+
+
+Deployment Steps
+----------------
+
+Use Certified Pure Storage Manila Share Image
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Red Hat requires that you utilize the Certified Pure Storage Manila Share
+Image when deploying RHOSO18.0 with a Pure Storage FlashArray backend.
+
+This container can be found in the `Red Hat Container Catalog <https://catalog.redhat.com/search?searchType=containers&partnerName=Pure%20Storage%2C%20Inc.&p=1>`__.
+
+Ensure the certified image is added to the ``openstackversion`` CR.  This is defined in the following YAML file (``openstack_version.yaml``):
+
+.. code-block:: yaml
+  :name: manila-openstackversion
+
+  apiVersion: core.openstack.org/v1beta1
+  kind: OpenStackVersion
+  metadata:
+    name: openstack
+  spec:
+    customContainerImages:
+      manilaShareImages:
+        flashblade: registry.connect.redhat.com/purestorage/openstack-manila-share-pure-18-0
+
+Save this file and update:
+
+.. code-block:: bash
+   :name: manila-openstackversion-apply
+
+   $ oc apply -f openstack-version.yaml
+
+Create a Secret file
+^^^^^^^^^^^^^^^^^^^^
+
+It is necessary to create a secret file that will contain the access
+credential(s) for your backend Pure FlashBlade(s) in your RHOSO deployment.
+
+In this following example file (``pure-fb-secrets.yaml``) secrets are provided for
+a FlashBlade. If using multiple backends you need to define a unique secret for each.
+
+.. code-block:: yaml
+  :name: manila-pure-secret
+
+    [flashblade]
+    flashblade_mgmt_vip = <INSERT FB MGMT VIP HERE>
+    flashblade_data_vip = <INSERT FB DATA VIP HERE>
+    flashblade_api = <INSERT FB API TOKEN HERE>
+
+Create the OpenShift secret based on the above configuration file:
+
+.. code-block:: bash
+  :name: manila-secret
+
+    $ oc create secret generic pure-fb-secret --from-file=pure-fb-secrets.yaml
+
+For security, you may now delete the configuration file.
+
+Update the OpenStack Control Plane
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Open your OpenStackControlPlane CR file, ``openstack_control_plane.yaml``. Edit the CR file and add in the
+Pure Storage Cinder volume backend.
+
+.. code-block:: yaml
+  :name: manila-pure-openstackcontrolplane
+
+  apiVersion: core.openstack.org/v1beta1
+  kind: OpenStackControlPlane
+  metadata:
+    name: openstack
+  spec:
+    manila:
+      enabled: true
+      template:
+        manilaAPI:
+          replicas: 3
+          customServiceConfig: |
+            [DEFAULT]
+            debug = true
+            enabled_share_protocols=nfs
+        manilaScheduler:
+          replicas: 3
+        manilaShares:
+          flashblade:
+            networkAttachments:
+            - storage
+            - storageMgmt
+            customServiceConfigSecrets:
+            - pure-fb-secret
+            customServiceConfig: |
+              [DEFAULT]
+              debug = true
+              enabled_share_backends=flashblade
+              [flashblade]
+              driver_handles_share_servers=False
+              share_backend_name=flashblade
+              share_driver=manila.share.drivers.purestorage.flashblade.FlashBladeShareDriver
+
+
+Save this file and update:
+
+.. code-block:: bash
+   :name: manila-openstackversion-apply
+
+   $ oc apply -f openstack_control_plane.yaml
+   
+Test the Deployed Back Ends
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+After RHOSO system is deployed, run the following command to check if the
+Manila services are up:
+
+.. code-block:: bash
+  :name: manila-service-list
+
+  $ oc rsh openstackclient
+  sh-5.1$ openstack share service list
+
+
+Run the following commands to create the share types mapped to the deployed back ends:
+
+.. code-block:: bash
+  :name: create-share-types
+
+  sh-5.1$ openstack share type create --snapshot_support true ---revert_to_snapshot_support true flashblade false
+
+Make sure that you're able to create Manila shares with the configured volume
+types:
+
+.. code-block:: bash
+  :name: create-shares
+
+  sh-5.1$ openstack share create --share-type flashblade --name testshare NFS 1