Chapter 3. Integrating Red Hat Ceph Storage

Procedure

1. Enter the cephadm container client:

   $ sudo cephadm shell

2. Create pools for the Compute service (vms), the Block Storage service (volumes), and the Image service (images):

   $ for P in vms volumes images; do
      ceph osd pool create $P;
      ceph osd pool application enable $P rbd;
   done

3. If you are using the Shared File Systems service, create the cephfs volume. This automatically enables the CephFS Metadata service (MDS) and creates the necessary data and metadata pools on the Ceph cluster:

   $ ceph fs volume create cephfs

4. If you are using the Shared File Systems service with CephFS-NFS, deploy an NFS service on the Red Hat Ceph Storage cluster:

   1. If you are deploying Red Hat Ceph Storage 7 or 8, run the following command:

      $ ceph nfs cluster create cephfs \
      --ingress --virtual-ip=<vip> \
      --ingress-mode=haproxy-protocol

   2. If you are deploying Red Hat Ceph Storage 9, run the following command:

      $ ceph nfs cluster create cephfs \
      --ingress --virtual-ip=<vip> \
      --ingress-mode=haproxy-protocol \
      --enable-nfsv3

      • Replace <vip> with the IP address assigned to the NFS service. The NFS service should be on a dedicated network that isolates NFS traffic while allowing RHOSO users to attach their Compute instances to access shares.

5. Create a CephX key for RHOSO to use to access pools:

   $ ceph auth add client.openstack \
        mgr 'allow *' \
           mon 'profile rbd' \
           osd 'profile rbd pool=vms, profile rbd pool=volumes, profile rbd pool=backups, profile rbd pool=images'

   • If you are using the Shared File Systems service, add osd caps for the CephFS data pool by using the following command instead:

     $ ceph auth add client.openstack \
          mgr 'allow *' \
             mon 'profile rbd' \
             osd 'profile rbd pool=vms, profile rbd pool=volumes, profile rbd pool=backups, profile rbd pool=images, profile rbd pool=cephfs.cephfs.data'

6. Export the CephX key:

   $ ceph auth get client.openstack > /etc/ceph/ceph.client.openstack.keyring

7. Export the configuration file:

   $ ceph config generate-minimal-conf > /etc/ceph/ceph.conf

Procedure

1. Transfer the cephx key and configuration file created in the Creating Red Hat Ceph Storage pools procedure to a host that can create resources in the openstack namespace.

2. Base64 encode these files and store them in KEY and CONF environment variables:

   $ KEY=$(cat /etc/ceph/ceph.client.openstack.keyring | base64 -w 0)
   $ CONF=$(cat /etc/ceph/ceph.conf | base64 -w 0)

3. Create a YAML file to create the Secret resource.

4. Using the environment variables, add the Secret configuration to the YAML file:

   apiVersion: v1
   data:
     ceph.client.openstack.keyring: $KEY
     ceph.conf: $CONF
   kind: Secret
   metadata:
     name: ceph-conf-files
     namespace: openstack
   type: Opaque

5. Save the YAML file.

6. Create the Secret resource:

   $ oc create -f <secret_configuration_file>

   • Replace <secret_configuration_file> with the name of the YAML file you created.

Procedure

1. Check the storage interface defined in your NodeNetworkConfigurationPolicy (nncp) custom resource to confirm that it has the same network configuration as the public_network of the Red Hat Ceph Storage cluster. This is required to enable access to the Red Hat Ceph Storage cluster through the Storage network. The Storage network should have the same network configuration as the public_network of the Red Hat Ceph Storage cluster.

   It is not necessary for RHOSO to access the cluster_network of the Red Hat Ceph Storage cluster.

   Note

   If it does not impact workload performance, the Storage network can be different from the external Red Hat Ceph Storage cluster public_network using routed (L3) connectivity as long as the appropriate routes are added to the Storage network to reach the external Red Hat Ceph Storage cluster public_network.

2. Check the networkAttachments for the default Image service instance in the OpenStackControlPlane CR to confirm that the default Image service is configured to access the Storage network:

   glance:
       enabled: true
       template:
         databaseInstance: openstack
         storage:
           storageRequest: 10G
         glanceAPIs:
           default
             replicas: 3
             override:
               service:
                 internal:
                   metadata:
                     annotations:
                       metallb.universe.tf/address-pool: internalapi
                       metallb.universe.tf/allow-shared-ip: internalapi
                       metallb.universe.tf/loadBalancerIPs: 172.17.0.80
                   spec:
                     type: LoadBalancer
             networkAttachments:
             - storage

3. Confirm the Block Storage service is configured to access the Storage network through MetalLB.
4. Optional: Confirm the Shared File Systems service is configured to access the Storage network through ManilaShare.
5. Confirm the Compute service (nova) is configured to access the Storage network.
6. Confirm the Red Hat Ceph Storage configuration file, /etc/ceph/ceph.conf, contains the IP addresses of the Red Hat Ceph Storage cluster monitors. These IP addresses must be within the Storage network IP address range.
7. Open your openstack_control_plane.yaml file to edit the OpenStackControlPlane CR.

8. Add the extraMounts parameter to define the services that require access to the Red Hat Ceph Storage secret.

   The following is an example of using the extraMounts parameter for this purpose. Only include ManilaShare in the propagation list if you are using the Shared File Systems service (manila):

   apiVersion: core.openstack.org/v1beta1
   kind: OpenStackControlPlane
   spec:
     extraMounts:
       - name: v1
         region: r1
         extraVol:
           - propagation:
             - CinderVolume
             - GlanceAPI
             - ManilaShare
             extraVolType: Ceph
             volumes:
             - name: ceph
               projected:
                 sources:
                 - secret:
                     name: <ceph-conf-files>
             mounts:
             - name: ceph
               mountPath: "/etc/ceph"
               readOnly: true

   • Replace <ceph-conf-files> with the name of your Secret CR created in Creating a Red Hat Ceph Storage secret.

9. Add the customServiceConfig parameter to the glance template to configure the Image service to use the Red Hat Ceph Storage cluster:

   apiVersion: core.openstack.org/v1beta1
   kind: OpenStackControlPlane
   metadata:
     name: openstack
   spec:
     glance:
       template:
         customServiceConfig: |
           [DEFAULT]
           enabled_backends = <backend_name>:rbd
           [glance_store]
           default_backend = <backend_name>
           [<backend_name>]
           rbd_store_ceph_conf = /etc/ceph/ceph.conf
           store_description = "RBD backend"
           rbd_store_pool = images
           rbd_store_user = openstack
         databaseInstance: openstack
         databaseAccount: glance
         secret: osp-secret
         storage:
           storageRequest: 10G
     extraMounts:
       - name: v1
         region: r1
         extraVol:
           - propagation:
             - GlanceAPI
             extraVolType: Ceph
             volumes:
             - name: ceph
               secret:
                 secretName: ceph-conf-files
             mounts:
             - name: ceph
               mountPath: "/etc/ceph"
               readOnly: true

   • Replace <backend_name> with the name of the default back end.

     When you use Red Hat Ceph Storage as a back end for the Image service, image-conversion is enabled by default. For more information, see Planning storage and shared file systems in Planning your deployment.

10. Add the customServiceConfig parameter to the cinder template to configure the Block Storage service to use the Red Hat Ceph Storage cluster. For information about using Block Storage backups, see Configuring the Block Storage backup service.

    apiVersion: core.openstack.org/v1beta1
    kind: OpenStackControlPlane
    spec:
      extraMounts:
        ...
      cinder:
        template:
          cinderVolumes:
            ceph:
              customServiceConfig: |
                [DEFAULT]
                enabled_backends=ceph
                [ceph]
                volume_backend_name=ceph
                volume_driver=cinder.volume.drivers.rbd.RBDDriver
                rbd_ceph_conf=/etc/ceph/ceph.conf
                rbd_user=openstack
                rbd_pool=volumes
                rbd_flatten_volume_from_snapshot=False
                rbd_secret_uuid=<$FSID>

    • Replace <$FSID> with the actual FSID. The FSID itself does not need to be considered secret. For more information, see Obtaining the Red Hat Ceph Storage FSID.

11. Optional: Add the customServiceConfig parameter to the manila template to configure the Shared File Systems service to use native CephFS or CephFS-NFS with the Red Hat Ceph Storage cluster. For more information, see Configuring the Shared File Systems service (manila).

    The following example exposes native CephFS:

    apiVersion: core.openstack.org/v1beta1
    kind: OpenStackControlPlane
    spec:
      extraMounts:
      ...
      manila:
        template:
          manilaAPI:
            customServiceConfig: |
              [DEFAULT]
              enabled_share_protocols=cephfs
          manilaShares:
            share1:
              customServiceConfig: |
                [DEFAULT]
                enabled_share_backends=cephfs
                [cephfs]
                driver_handles_share_servers=False
                share_backend_name=cephfs
                share_driver=manila.share.drivers.cephfs.driver.CephFSDriver
                cephfs_conf_path=/etc/ceph/ceph.conf
                cephfs_auth_id=openstack
                cephfs_cluster_name=ceph
                cephfs_volume_mode=0755
                cephfs_protocol_helper_type=CEPHFS

    The following example exposes CephFS with NFS:

    apiVersion: core.openstack.org/v1beta1
    kind: OpenStackControlPlane
    spec:
      extraMounts:
      ...
      manila:
        template:
          manilaAPI:
            customServiceConfig: |
              [DEFAULT]
              enabled_share_protocols=nfs
          manilaShares:
            share1:
              customServiceConfig: |
                [DEFAULT]
                enabled_share_backends=cephfsnfs
                [cephfsnfs]
                driver_handles_share_servers=False
                share_backend_name=cephfsnfs
                share_driver=manila.share.drivers.cephfs.driver.CephFSDriver
                cephfs_conf_path=/etc/ceph/ceph.conf
                cephfs_auth_id=openstack
                cephfs_cluster_name=ceph
                cephfs_volume_mode=0755
                cephfs_protocol_helper_type=NFS
                cephfs_nfs_cluster_id=cephfs

12. Apply the updates to the OpenStackControlPlane CR:

    $ oc apply -f openstack_control_plane.yaml

Procedure

1. Create a ConfigMap with additional content for the Compute service (nova) configuration file /etc/nova/nova.conf.d/ inside the nova_compute container. This additional content directs the Compute service to use Red Hat Ceph Storage RBD.

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: ceph-nova
   data:
    <03-ceph-nova.conf>: |
     [libvirt]
     images_type=rbd
     images_rbd_pool=vms
     images_rbd_ceph_conf=/etc/ceph/ceph.conf
     images_rbd_glance_store_name=<backend_name>
     images_rbd_glance_copy_poll_interval=15
     images_rbd_glance_copy_timeout=600
     rbd_user=openstack
     rbd_secret_uuid=<$FSID>

   • Replace <03-ceph-nova.conf> with your file name. This file name must follow the naming convention of ##-<name>-nova.conf. Files are evaluated by the Compute service alphabetically. A filename that starts with 01 will be evaluated by the Compute service before a filename that starts with 02. When the same configuration option occurs in multiple files, the last one read wins.
   • Replace <backend_name> with the name of the back end specified in the glance template of the OpenStackControlPlane CR.
   • Replace <$FSID> with the actual FSID, as described in the Obtaining the Ceph FSID section. The FSID itself does not need to be considered secret.

2. Create a custom version of the default nova service to use the new ConfigMap, which in this case is called ceph-nova.

   apiVersion: dataplane.openstack.org/v1beta1
   kind: OpenStackDataPlaneService
   metadata:
     name: nova-custom-ceph
   spec:
     caCerts: combined-ca-bundle
     edpmServiceType: nova
     dataSources:
      - configMapRef:
          name: ceph-nova
      - secretRef:
          name: nova-cell1-compute-config
      - secretRef:
          name: nova-migration-ssh-key
     playbook: osp.edpm.nova

   • The custom service is named nova-custom-ceph. It cannot be named nova because nova is an unchangeable default service. Any custom service that has the same name as a default service name will be overwritten during reconciliation.

3. Apply the ConfigMap and custom service changes:

   $ oc create -f ceph-nova.yaml

4. In your OpenStackDataPlaneNodeSet CR, update the list of services by adding the ceph-client service and replacing the default nova service with the new custom service, for example nova-custom-ceph. Add the extraMounts parameter to define access to the Ceph Storage secret.

   Example:

   apiVersion: dataplane.openstack.org/v1beta1
   kind: OpenStackDataPlaneNodeSet
   spec:
     ...
     services:
     - redhat
     - bootstrap
     - download-cache
     - configure-network
     - validate-network
     - install-os
     - configure-os
     - ssh-known-hosts
     - run-os
     - reboot-os
     - install-certs
     - ceph-client
     - ovn
     - neutron-metadata
     - libvirt
     - nova-custom-ceph
     - telemetry
   
     nodeTemplate:
       extraMounts:
       - extraVolType: Ceph
         volumes:
         - name: ceph
           secret:
             secretName: ceph-conf-files
         mounts:
         - name: ceph
           mountPath: "/etc/ceph"
           readOnly: true

   • You must add the ceph-client service before the ovn, libvirt, and nova-custom-ceph services in the list of services. The ceph-client service configures data plane nodes as clients of a Red Hat Ceph Storage server by distributing the Red Hat Ceph Storage client files.

   • This example might not list all of the services in your environment. You can run the following command to verify the list of services in your environment:

     $ oc get -n openstack crd/openstackdataplanenodesets.dataplane.openstack.org -o yaml |yq -r '.spec.versions.[].schema.openAPIV3Schema.properties.spec.properties.services.default

     For more information, see Data plane services.

5. Save the changes to the services list.

6. Create an OpenStackDataPlaneDeployment CR:

   $ oc create -f <dataplanedeployment_cr_file>

   • Replace <dataplanedeployment_cr_file> with the name of your file.

     The Ansible job for the nova-custom-ceph service copies overrides from the ConfigMap to the Compute service hosts. The Ansible job also uses virsh secret-* commands so the libvirt service retrieves the cephx secret by FSID.

Procedure

1. Configure the RGW to verify users and their roles in the Identity service (keystone) to authenticate with the external RGW service.
2. Deploy and configure a RGW service to handle object storage requests.

Procedure

1. Create a DNSData custom resource (CR) for the external Ceph cluster.

   Example DNSData CR:

   apiVersion: network.openstack.org/v1beta1
   kind: DNSData
   metadata:
     labels:
       component: ceph-storage
       service: ceph
     name: ceph-storage
     namespace: openstack
   spec:
     dnsDataLabelSelectorValue: dnsdata
     hosts:
       - hostnames:
         - ceph-rgw-internal-vip.ceph.local
         ip: <172.18.0.2>
       - hostnames:
         - ceph-rgw-external-vip.ceph.local
         ip: <10.10.10.2>

   • Replace <172.18.0.2> with the correct host for your environment. In this example, the host at the IP address 172.18.0.2 hosts the Ceph RGW endpoint for access on the private storage network. This host passes the CR so that a DNS A and PTR record is created. This enables the host to be accessed by using the host name ceph-rgw-internal-vip.ceph.local.
   • Replace <10.10.10.2> with the correct host for your environment. In this example, the host at the IP address 10.10.10.2 hosts the Ceph RGW endpoint for access on the external network. This host passes the CR so that a DNS A and PTR record is created. This enables the host to be accessed by using the host name ceph-rgw-external-vip.ceph.local.

2. Apply the CR to your environment:

   $ oc apply -f <ceph_dns_yaml>

   • Replace <ceph_dns_yaml> with the name of the DNSData CR file.
3. Update the CoreDNS CR to configure DNS forwarding to the dnsmasq service for requests to the ceph.local domain. For more information about DNS forwarding, see Using DNS forwarding in the RHOCP Networking guide.

4. List the openstack domain DNS cluster IP address:

   $ oc get svc dnsmasq-dns

   Example output:

   $ oc get svc dnsmasq-dns
   dnsmasq-dns     LoadBalancer   10.217.5.130   192.168.122.80    53:30185/UDP     160m

5. Record the DNS cluster IP address from the command output for DNS forwarding.

6. List the CoreDNS CR:

   $ oc -n openshift-dns describe dns.operator/default

7. Edit the CoreDNS CR and add the servers configuration to the spec section with the DNS cluster IP address.

   Example CoreDNS CR updated with the DNS cluster IP address:

   apiVersion: operator.openshift.io/v1
   kind: DNS
   metadata:
     creationTimestamp: "2024-03-25T02:49:24Z"
     finalizers:
     - dns.operator.openshift.io/dns-controller
     generation: 3
     name: default
     resourceVersion: "164142"
     uid: 860b0e61-a48a-470e-8684-3b23118e6083
   spec:
     cache:
       negativeTTL: 0s
       positiveTTL: 0s
     logLevel: Normal
     nodePlacement: {}
     operatorLogLevel: Normal
     servers:
     - forwardPlugin:
         policy: Random
         upstreams:
         - 10.217.5.130:53
       name: ceph
       zones:
       - ceph.local
     upstreamResolvers:
       policy: Sequential
       upstreams:
       - port: 53
         type: SystemResolvConf

   where:

   servers

   Defines DNS forwarding configurations for specific domains.

   upstreams

   Specifies the DNS cluster IP address to which DNS queries are forwarded.

   10.217.5.130:53

   Is the DNS cluster IP address recorded from the oc get svc dnsmasq-dns command.

   zones

   Defines the domain for which DNS queries are forwarded to the upstream server.

8. Create a Certificate CR with the host names from the DNSData CR.

   Example Certificate CR:

   apiVersion: cert-manager.io/v1
   kind: Certificate
   metadata:
     name: cert-ceph-rgw
     namespace: openstack
   spec:
     duration: 43800h0m0s
     issuerRef: {'group': 'cert-manager.io', 'kind': 'Issuer', 'name': 'rootca-public'}
     secretName: cert-ceph-rgw
     dnsNames:
       - ceph-rgw-internal-vip.ceph.local
       - ceph-rgw-external-vip.ceph.local

9. Apply the CR to your environment:

   $ oc apply -f <ceph_cert_yaml>

   • Replace <ceph_cert_yaml> with the name of the Certificate CR file.

10. Extract the certificate and key data from the secret created when the Certificate CR was applied:

    $ oc get secret <ceph_cert_secret_name> -o yaml

    • Replace <ceph_cert_secret_name> with the name used in the secretName field of your Certificate CR.

      Example output:

      [stack@osp-storage-04 ~]$ oc get secret cert-ceph-rgw -o yaml
      apiVersion: v1
      data:
        ca.crt: <CA>
        tls.crt: <b64cert>
        tls.key: <b64key>
      kind: Secret

      • The <b64cert> and <b64key> values are the base64-encoded certificate and key strings that you must use in the next step.

11. Extract and base64 decode the certificate and key information obtained in the previous step.

    Extract and decode the certificate:

    $ oc get secret <ceph_cert_secret_name> -o yaml | awk '/tls.crt/ {print $2}' | base64 -d

    Extract and decode the key:

    $ oc get secret <ceph_cert_secret_name> -o yaml | awk '/tls.key/ {print $2}' | base64 -d

12. If you are using Red Hat Ceph Storage 7 or 8, concatenate the decoded certificate and key values with no spaces in between, and save them in the Ceph Object Gateway service specification.

    The rgw section of the specification file looks like the following:

      service_type: rgw
      service_id: rgw
      service_name: rgw.rgw
      placement:
        hosts:
        - host1
        - host2
      networks:
        - 172.18.0.0/24
      spec:
        rgw_frontend_port: 8082
        rgw_realm: default
        rgw_zone: default
        ssl: true
        rgw_frontend_ssl_certificate: |
        -----BEGIN CERTIFICATE-----
        MIIDkzCCAfugAwIBAgIRAKNgGd++xV9cBOrwDAeEdQUwDQYJKoZIhvcNAQELBQAw
        <redacted>
        -----END CERTIFICATE-----
        -----BEGIN RSA PRIVATE KEY-----
        MIIEpQIBAAKCAQEAyTL1XRJDcSuaBLpqasAuLsGU2LQdMxuEdw3tE5voKUNnWgjB
        <redacted>
        -----END RSA PRIVATE KEY-----

    The ingress section of the specification file looks like the following:

      service_type: ingress
      service_id: rgw.default
      service_name: ingress.rgw.default
      placement:
        count: 1
      spec:
        backend_service: rgw.rgw
        frontend_port: 8080
        monitor_port: 8999
        virtual_interface_networks:
        - 172.18.0.0/24
        virtual_ip: 172.18.0.2/24
        ssl_cert: |
        -----BEGIN CERTIFICATE-----
        MIIDkzCCAfugAwIBAgIRAKNgGd++xV9cBOrwDAeEdQUwDQYJKoZIhvcNAQELBQAw
        <redacted>
        -----END CERTIFICATE-----
        -----BEGIN RSA PRIVATE KEY-----
        MIIEpQIBAAKCAQEAyTL1XRJDcSuaBLpqasAuLsGU2LQdMxuEdw3tE5voKUNnWgjB
        <redacted>
        -----END RSA PRIVATE KEY-----

    where:

    rgw_frontend_ssl_certificate

    Contains the base64 decoded values from both <b64cert> and <b64key> in the previous step with no spaces in between.

    ssl_cert

    Contains the base64 decoded values from both <b64cert> and <b64key> in the previous step with no spaces in between.

13. If you are using Red Hat Ceph Storage 9, save the decoded certificate and key values separately in the Ceph Object Gateway service specification.

    The rgw section of the specification file looks like the following:

      service_type: rgw
      service_id: rgw
      service_name: rgw.rgw
      placement:
        hosts:
        - host1
        - host2
      networks:
        - 172.18.0.0/24
      spec:
        rgw_frontend_port: 8082
        rgw_realm: default
        rgw_zone: default
        ssl: true
        certificate_source: inline
        ssl_cert: |
        -----BEGIN CERTIFICATE-----
        MIIDkzCCAfugAwIBAgIRAKNgGd++xV9cBOrwDAeEdQUwDQYJKoZIhvcNAQELBQAw
        <redacted>
        -----END CERTIFICATE-----
        ssl_key: |
        -----BEGIN PRIVATE KEY-----
        MIIEpQIBAAKCAQEAyTL1XRJDcSuaBLpqasAuLsGU2LQdMxuEdw3tE5voKUNnWgjB
        <redacted>
        -----END PRIVATE KEY-----

    The ingress section of the specification file looks like the following:

      service_type: ingress
      service_id: rgw.default
      service_name: ingress.rgw.default
      placement:
        count: 1
      spec:
        backend_service: rgw.rgw
        frontend_port: 8080
        monitor_port: 8999
        virtual_interface_networks:
        - 172.18.0.0/24
        virtual_ip: 172.18.0.2/24
        ssl: true
        certificate_source: inline
        ssl_cert: |
        -----BEGIN CERTIFICATE-----
        MIIDkzCCAfugAwIBAgIRAKNgGd++xV9cBOrwDAeEdQUwDQYJKoZIhvcNAQELBQAw
        <redacted>
        -----END CERTIFICATE-----
        ssl_key: |
        -----BEGIN PRIVATE KEY-----
        MIIEpQIBAAKCAQEAyTL1XRJDcSuaBLpqasAuLsGU2LQdMxuEdw3tE5voKUNnWgjB
        <redacted>
        -----END PRIVATE KEY-----

    where:

    certificate_source: inline

    Specifies that the certificate and key are embedded directly in the specification.

    ssl_cert

    Contains the base64 decoded certificate value from <b64cert> in the previous step.

    ssl_key

    Contains the base64 decoded key value from <b64key> in the previous step.

    Note

    In Red Hat Ceph Storage 9, the rgw_frontend_ssl_certificate field, which required concatenated certificate and key values, is deprecated. New deployments must use the separate ssl_cert and ssl_key fields.

14. Use the procedure "Deploying the Ceph Object Gateway using the service specification" to deploy Ceph RGW with SSL. For more information, see the Red Hat Ceph Storage Operations Guide:

    • Red Hat Ceph Storage 7 Operations Guide
    • Red Hat Ceph Storage 8 Operations Guide
    • Red Hat Ceph Storage 9 Operations Guide
15. Connect to the openstackclient pod.

16. Verify that DNS forwarding has been successfully configured.

    $ curl --trace - <host_name>

    • Replace <host_name> with the name of the external host previously added to the DNSData CR.

      Example output:

      sh-5.1$ curl https://rgw-external-vip.ceph.local:8080
      <?xml version="1.0" encoding="UTF-8"?><ListAllMyBucketsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Owner><ID>anonymous</ID><DisplayName></DisplayName></Owner><Buckets></Buckets></ListAllMyBucketsResult>
      .1$
      sh-5.1$

    • In this example, the openstackclient pod successfully resolved the host name, and no SSL verification errors were encountered.

Procedure

1. Verify which Ceph version the clients in your Ceph Storage cluster are running:

   $ cephadm shell -- ceph osd get-require-min-compat-client

   Example output:

   luminous

2. To set the cluster to use the Clone v2 API and the deferred deletion feature by default, set min-compat-client to mimic. Only clients in the cluster that are running Ceph version 13.2.x (Mimic) can access images with dependencies:

   $ cephadm shell -- ceph osd set-require-min-compat-client mimic

3. Schedule an interval for trash purge in minutes by using the m suffix:

   $ rbd trash purge schedule add --pool <pool> <30m>

   • Replace <pool> with the name of the associated storage pool, for example, volumes in the Block Storage service.
   • Replace <30m> with the interval in minutes that you want to specify for trash purge.

4. Verify a trash purge schedule has been set for the pool:

   $ rbd trash purge schedule list --pool <pool>

Procedure

1. Determine if any parts of the control plane are not properly deployed by assessing whether the Ready condition is not True:

   $ oc get -n openstack OpenStackControlPlane \
     -o jsonpath="{range .items[0].status.conditions[?(@.status!='True')]}{.type} is {.status} due to {.message}{'\n'}{end}"

   1. If you identify a service that is not properly deployed, check the status of the service.

      The following example checks the status of the Compute service:

      $ oc get -n openstack Nova/nova \
        -o jsonpath="{range .status.conditions[?(@.status!='True')]}{.type} is {.status} due to {.message}{'\n'}{end}"

      • You can check the status of all deployed services:

        $ oc get pods -n openstack

      • You can check the logs of a specific service:

        $ oc logs -n openstack <service_pod_name>

        • Replace <service_pod_name> with the name of the service pod you want to check.

   2. If you identify an operator that is not properly deployed, check the status of the operator:

      $ oc get pods -n openstack-operators -lopenstack.org/operator-name

      • You can check the operator logs:

        $ oc logs -n openstack-operators -lopenstack.org/operator-name=<operator_name>

2. Check the Status of the data plane deployment:

   $ oc get -n openstack OpenStackDataPlaneDeployment

   • If the Status of the data plane deployment is False, check the logs of the associated Ansible job:

     $ oc logs -n openstack job/<ansible_job_name>

     • Replace <ansible_job_name> with the name of the associated job. The job name is listed in the Message field of the oc get -n openstack OpenStackDataPlaneDeployment command output.

3. Check the Status of the data plane node set deployment:

   $ oc get -n openstack OpenStackDataPlaneNodeSet

   • If the Status of the data plane node set deployment is False, check the logs of the associated Ansible job:

     $ oc logs -n openstack job/<ansible_job_name>

     • Replace <ansible_job_name> with the name of the associated job. It is listed in the Message field of the oc get -n openstack OpenStackDataPlaneNodeSet command output.

4. If any pods are in the CrashLookBackOff state, you can duplicate them for troubleshooting purposes:

   $ oc debug <pod_name>

   • Replace <pod_name> with the name of the pod to duplicate.

5. Optional: You can route traffic to the duplicate pod during the debug process:

   $ oc debug <pod_name> --keep-labels=true

6. Optional: You can use the oc debug command in the following object debugging activities:

   • To run /bin/sh on a container other than the first one, the command’s default behavior, using the command form oc debug -container <pod_name> <container_name>. This is useful for pods like the API where the first container is tailing a file and the second container is the one you want to debug. If you use this command form, you must first use the command oc get pods | grep <search_string> to find the container name.
   • To create any resource that creates pods such as Deployments, StatefulSets, and Nodes, use the command form oc debug <resource_type>/<resource_name>. An example of creating a StatefulSet would be oc debug StatefulSet/cinder-scheduler.

7. Connect to the pod and confirm that the ceph.client.openstack.keyring and ceph.conf files are present in the /etc/ceph directory.

   $ oc rsh <pod_name>

   • Replace <pod_name> with the name of the applicable pod.
   • If the Ceph configuration files are missing, check the extraMounts parameter in your OpenStackControlPlane CR.

8. Confirm the pod has a network connection to the Red Hat Ceph Storage cluster by connecting to the IP and port of a Ceph Monitor from the pod. The IP and port information is located in /etc/ceph.conf.

   The following is an example of this process:

   $ oc get pods | grep glance | grep external-api-0
   glance-06f7a-default-external-api-0                               3/3     Running     0              2d3h
   $ oc debug --container glance-api glance-06f7a-default-external-api-0
   Starting pod/glance-06f7a-default-external-api-0-debug-p24v9, command was: /usr/bin/dumb-init --single-child -- /bin/bash -c /usr/local/bin/kolla_set_configs && /usr/local/bin/kolla_start
   Pod IP: 192.168.25.50
   If you don't see a command prompt, try pressing enter.
   sh-5.1# cat /etc/ceph/ceph.conf
   # Ansible managed
   
   [global]
   
   fsid = 63bdd226-fbe6-5f31-956e-7028e99f1ee1
   mon host = [v2:192.168.122.100:3300/0,v1:192.168.122.100:6789/0],[v2:192.168.122.102:3300/0,v1:192.168.122.102:6789/0],[v2:192.168.122.101:3300/0,v1:192.168.122.101:6789/0]
   
   
   [client.libvirt]
   admin socket = /var/run/ceph/$cluster-$type.$id.$pid.$cctid.asok
   log file = /var/log/ceph/qemu-guest-$pid.log
   
   sh-5.1# python3
   Python 3.9.19 (main, Jul 18 2024, 00:00:00)
   [GCC 11.4.1 20231218 (Red Hat 11.4.1-3)] on linux
   Type "help", "copyright", "credits" or "license" for more information.
   >>> import socket
   >>> s = socket.socket()
   >>> ip="192.168.122.100"
   >>> port=3300
   >>> s.connect((ip,port))
   >>>

9. Optional: If you cannot connect to a Ceph Monitor, troubleshoot the network connection between the cluster and pod. The previous example uses a Python socket to connect to the IP and port of the Red Hat Ceph Storage cluster from the ceph.conf file.

   • There are two potential outcomes from the execution of the s.connect((ip,port)) function:

     • If the command executes successfully and there is no error similar to the following example, the network connection between the pod and cluster is functioning correctly. If the connection is functioning correctly, the command execution will provide no return value at all.

     • If the command takes a long time to execute and returns an error similar to the following example, the network connection between the pod and cluster is not functioning correctly. It should be investigated further to troubleshoot the connection.

       Traceback (most recent call last):
         File "<stdin>", line 1, in <module>
       TimeoutError: [Errno 110] Connection timed out

10. Examine the cephx key as shown in the following example:

    bash-5.1$ cat /etc/ceph/ceph.client.openstack.keyring
    [client.openstack]
       key = "<redacted>"
       caps mgr = allow *
       caps mon = profile rbd
       caps osd = profile rbd pool=vms, profile rbd pool=volumes, profile rbd pool=backups, profile rbd pool=images
    bash-5.1$

11. List the contents of a pool from the caps osd parameter as shown in the following example:

    $ /usr/bin/rbd --conf /etc/ceph/ceph.conf \
    --keyring /etc/ceph/ceph.client.openstack.keyring \
    --cluster ceph --id openstack \
    ls -l -p <pool_name> | wc -l

    • Replace <pool_name> with the name of the required Red Hat Ceph Storage pool.
    • If this command returns the number 0 or greater, the cephx key provides adequate permissions to connect to, and read information from, the Red Hat Ceph Storage cluster.
    • If this command does not complete but network connectivity to the cluster was confirmed, work with the Ceph administrator to obtain the correct cephx keyring.
    • Check if there is an MTU mismatch on the Storage network. If the network is using jumbo frames (an MTU value of 9000), all switch ports between servers using the interface must be updated to support jumbo frames. If this change is not made on the switch, problems can occur at the Ceph application layer. Verify all hosts using the network can communicate at the desired MTU with a command such as ping -M do -s 8972 <ip_address>.

12. Send test data to the images pool on the Ceph cluster.

    The following is an example of performing this task:

    # DATA=$(date | md5sum | cut -c-12)
    # POOL=images
    # RBD="/usr/bin/rbd --conf /etc/ceph/ceph.conf --keyring /etc/ceph/ceph.client.openstack.keyring --cluster ceph --id openstack"
    # $RBD create --size 1024 $POOL/$DATA

    Tip

    It is possible to be able to read data from the cluster but not have permissions to write data to it, even if write permission was granted in the cephx keyring. If you have write permissions, but you cannot write data to the cluster, the cluster might be overloaded and not able to write new data.

    In the example, the rbd command did not complete successfully and was canceled. It was subsequently confirmed the cluster itself did not have the resources to write new data. The issue was resolved on the cluster itself. There was nothing incorrect with the client configuration.

Procedure

1. Locate the Red Hat Ceph Storage configuration file mapped in the Red Hat OpenShift secret created in Creating a Red Hat Ceph Storage secret.

2. Modify the contents of the configuration file to include troubleshooting-related configuration.

   The following is an example of troubleshooting-related configuration:

   [client.openstack]
   admin socket = /var/run/ceph/$cluster-$type.$id.$pid.$cctid.asok
   log file = /var/log/guest-$pid.log
   debug ms = 1
   debug rbd = 20
   log to file = true

   Note

   For more information about troubleshooting, see the Red Hat Ceph Storage Troubleshooting Guide:

   • Red Hat Ceph Storage 7 Troubleshooting Guide
   • Red Hat Ceph Storage 8 Troubleshooting Guide
   • Red Hat Ceph Storage 9 Troubleshooting Guide
3. Update the secret with the new content.