Chapter 5. Storage classes and storage pools

Procedure

1. Click Storage → StorageClasses.
2. Click Create Storage Class.
3. Enter the storage class Name and Description.

4. Reclaim Policy is set to Delete as the default option. Use this setting.

   If you change the reclaim policy to Retain in the storage class, the persistent volume (PV) remains in Released state even after deleting the persistent volume claim (PVC).

5. Volume binding mode is set to WaitForConsumer as the default option.

   If you choose the Immediate option, then the PV gets created immediately when creating the PVC.

6. Select RBD or CephFS Provisioner as the plugin for provisioning the persistent volumes.

7. Select an existing Storage Pool from the list or create a new pool.

   Note

   The 2-way replication data protection policy is only supported for the non-default RBD pool. 2-way replication can be used by creating an additional pool. To know about Data Availability and Integrity considerations for replica 2 pools, see Knowledgebase Customer Solution Article.

   Create new pool

   1. Click Create New Pool.
   2. Enter Pool name.
   3. Choose 2-way-Replication or 3-way-Replication as the Data Protection Policy.

   4. Select Enable compression if you need to compress the data.

      Enabling compression can impact application performance and might prove ineffective when data to be written is already compressed or encrypted. Data written before enabling compression will not be compressed.

   5. Click Create to create the new storage pool.
   6. Click Finish after the pool is created.

8. Optional: Select Enable Encryption checkbox.
9. Click Create to create the storage class.

Procedure

1. In the OpenShift Web Console, navigate to Storage → StorageClasses.
2. Click Create Storage Class.
3. Enter the storage class Name and Description.
4. Select either Delete or Retain for the Reclaim Policy. By default, Delete is selected.
5. Select either Immediate or WaitForFirstConsumer as the Volume binding mode. WaitForConsumer is set as the default option.
6. Select RBD Provisioner openshift-storage.rbd.csi.ceph.com which is the plugin used for provisioning the persistent volumes.
7. Select Storage Pool where the volume data is stored from the list or create a new pool.

8. Select the Enable encryption checkbox. There are two options available to set the KMS connection details:

   • Select existing KMS connection: Select an existing KMS connection from the drop-down list. The list is populated from the the connection details available in the csi-kms-connection-details ConfigMap.

     1. Select the Provider from the drop down.
     2. Select the Key service for the given provider from the list.

   • Create new KMS connection: This is applicable for vaulttokens and Thales CipherTrust Manager (using KMIP) only.

     1. Select the Key Management Service Provider.

     2. If Vault is selected as the Key Management Service Provider, follow these steps:

        1. Enter a unique Connection Name, host Address of the Vault server ('https://<hostname or ip>'), Port number and Token.

        2. Expand Advanced Settings to enter additional settings and certificate details based on your Vault configuration:

           1. Enter the Key Value secret path in Backend Path that is dedicated and unique to OpenShift Data Foundation.
           2. Optional: Enter TLS Server Name and Vault Enterprise Namespace.
           3. Upload the respective PEM encoded certificate file to provide the CA Certificate, Client Certificate and Client Private Key .
           4. Click Save.

     3. If Thales CipherTrust Manager (using KMIP) is selected as the Key Management Service Provider, follow these steps:

        1. Enter a unique Connection Name.
        2. In the Address and Port sections, enter the IP of Thales CipherTrust Manager and the port where the KMIP interface is enabled. For example, Address: 123.34.3.2, Port: 5696.
        3. Upload the Client Certificate, CA certificate, and Client Private Key.
        4. Enter the Unique Identifier for the key to be used for encryption and decryption, generated above.
        5. The TLS Server field is optional and used when there is no DNS entry for the KMIP endpoint. For example, kmip_all_<port>.ciphertrustmanager.local.
     4. Click Save.
     5. Click Create.

9. Edit the ConfigMap to add the vaultBackend parameter if the HashiCorp Vault setup does not allow automatic detection of the Key/Value (KV) secret engine API version used by the backend path.

   Note

   vaultBackend is an optional parameters that is added to the configmap to specify the version of the KV secret engine API associated with the backend path. Ensure that the value matches the KV secret engine API version that is set for the backend path, otherwise it might result in a failure during persistent volume claim (PVC) creation.

   1. Identify the encryptionKMSID being used by the newly created storage class.

      1. On the OpenShift Web Console, navigate to Storage → Storage Classes.
      2. Click the Storage class name → YAML tab.

      3. Capture the encryptionKMSID being used by the storage class.

         Example:

         encryptionKMSID: 1-vault

   2. On the OpenShift Web Console, navigate to Workloads → ConfigMaps.
   3. To view the KMS connection details, click csi-kms-connection-details.

   4. Edit the ConfigMap.

      1. Click Action menu (⋮) → Edit ConfigMap.

      2. Add the vaultBackend parameter depending on the backend that is configured for the previously identified encryptionKMSID.

         You can assign kv for KV secret engine API, version 1 and kv-v2 for KV secret engine API, version 2.

         Example:

          kind: ConfigMap
          apiVersion: v1
          metadata:
            name: csi-kms-connection-details
          [...]
          data:
            1-vault: |-
              {
                "encryptionKMSType": "vaulttokens",
                "kmsServiceName": "1-vault",
                [...]
                "vaultBackend": "kv-v2"
              }
            2-vault: |-
              {
                "encryptionKMSType": "vaulttenantsa",
                [...]
                "vaultBackend": "kv"
              }

      3. Click Save