Chapter 3. Integrating with an existing Red Hat Ceph Storage cluster

Procedure

1. Create and add additional environment files:

   • If you deploy an overcloud that uses the native CephFS back-end driver, add /usr/share/openstack-tripleo-heat-templates/environments/manila-cephfsnative-config.yaml.

   • If you deploy an overcloud that uses CephFS-NFS, add /usr/share/openstack-tripleo-heat-templates/environments/manila-cephfsganesha-config.yaml.

     Red Hat recommends that you deploy the CephFS-NFS driver with an isolated StorageNFS network where shares are exported. You must deploy the isolated network to overcloud Controller nodes. For information about creating the StorageNFS network and updating the roles, see Composable networks in Customizing your Red Hat OpenStack Platform deployment.

2. Modify the openstack overcloud deploy command depending on the CephFS back end that you use.

   • For native CephFS:

      $ openstack overcloud deploy --templates \
        -e /usr/share/openstack-tripleo-heat-templates/environments/external-ceph.yaml \
        -e /usr/share/openstack-tripleo-heat-templates/environments/manila-cephfsnative-config.yaml \
        -e /home/stack/templates/ceph-config.yaml \
        -e --ntp-server pool.ntp.org
        ...

   • For CephFS-NFS:

      $ openstack overcloud deploy --templates \
          -r /home/stack/custom_roles.yaml \
          -e /usr/share/openstack-tripleo-heat-templates/environments/external-ceph.yaml \
          -e /usr/share/openstack-tripleo-heat-templates/environments/manila-cephfsganesha-config.yaml \
          -e /home/stack/templates/ceph-config.yaml \
          -e /home/stack/templates/overcloud-networks-deployed.yaml\
          -e /home/stack/templates/overcloud-vip-deployed.yaml \
          -e --ntp-server pool.ntp.org
          ...

     Note

     The custom ceph-config.yaml environment file overrides parameters in the external-ceph.yaml file and either the manila-cephfsnative-config.yaml file or the manila-cephfsganesha-config.yaml file. Therefore, include the custom ceph-config.yaml environment file in the deployment command after external-ceph.yaml and either manila-cephfsnative-config.yaml or manila-cephfsganesha-config.yaml.

     Example environment file

     parameter_defaults:
         CinderEnableIscsiBackend: false
         CinderEnableRbdBackend: true
         CinderEnableNfsBackend: false
         NovaEnableRbdBackend: true
         GlanceBackend: rbd
         CinderRbdPoolName: "volumes"
         NovaRbdPoolName: "vms"
         GlanceRbdPoolName: "images"
         CinderBackupRbdPoolName: "backups"
         CephClusterFSID: <cluster_ID>
         CephExternalMonHost: <IP_address>,<IP_address>,<IP_address>
         CephClientKey: "<client_key>"
         CephClientUserName: "openstack"
         ManilaCephFSDataPoolName: manila_data
         ManilaCephFSMetadataPoolName: manila_metadata
         ManilaCephFSCephFSAuthId: 'manila'
         CephManilaClientKey: '<client_key>'
         ExtraConfig:

     • Replace <cluster_ID>, <IP_address>, and <client_key> with values that are suitable for your environment.

Procedure

1. Create a new custom environment file to define the RGW connection.

2. Add the following parameters to the custom environment file:

   parameter_defaults:
      ExternalSwiftPublicUrl: <public_rgw_endpoint_url>
      ExternalSwiftInternalUrl: <internal_rgw_endpoint_url>
      ExternalSwiftAdminUrl: <admin_rgw_endpoint_url>
      ExternalSwiftUserTenant: 'service'
      SwiftPassword: <swift_password>

   • Replace <public_rgw_endpoint_url> with an HTTP formatted URL that represents the public endpoint where the external RGW instance is listening for connections. By default, the external RGW instance listens on port 8080. Confirm your deployment uses this port.
   • Replace <internal_rgw_endpoint_url> with an HTTP formatted URL that represents the internal endpoint where the external RGW instance is listening for connections. By default, the external RGW instance listens on port 8080. Confirm your deployment uses this port.
   • Replace <admin_rgw_endpoint_url> with an HTTP formatted URL that represents the administrative endpoint where the external RGW instance is listening for connections. By default, the external RGW instance listens on port 8080. Confirm your deployment uses this port.

   • Replace <swift_password> with the Object Storage service (swift) password.

     Note

     The swift user created in the overcloud uses the password defined by the SwiftPassword parameter. You must configure the external RGW instance to use the same password to authenticate with the Identity service by using the rgw_keystone_admin_password.

3. Save the new custom environment file.

4. Add the following parameters to the Red Hat Ceph Storage configuration file to configure RGW to use the Identity service:

       rgw_keystone_api_version = 3
       rgw_keystone_url = <public_keystone_endpoint_url>
       rgw_keystone_accepted_roles = member, Member, admin
       rgw_keystone_accepted_admin_roles = ResellerAdmin, swiftoperator
       rgw_keystone_admin_domain = default
       rgw_keystone_admin_project = service
       rgw_keystone_admin_user = swift
       rgw_keystone_admin_password = <swift_admin_password>
       rgw_keystone_implicit_tenants = true
       rgw_s3_auth_use_keystone = true
       rgw_swift_versioning_enabled = true
       rgw_swift_account_in_url = true
       rgw_max_attr_name_len = 128
       rgw_max_attrs_num_in_req = 90
       rgw_max_attr_size = 256
       rgw_keystone_verify_ssl = false
       rgw_keystone_revocation_interval: '0'
       rgw_swift_enforce_content_length: 'true'
       rgw_trust_forwarded_https: 'true'
       rgw_max_attr_name_len: 128
       rgw_max_attrs_num_in_req: 90
       rgw_max_attr_size: 1024
       rgw_keystone_accepted_reader_roles: 'SwiftSystemReader'

   • Replace <public_keystone_endpoint_url> with an HTTP formatted URL that represents the public endpoint where the Identity service is listening for connections. By default, the Identity service listens on port 5000. Confirm your deployment uses this port.

   • Replace <swift_admin_password> with the Object Storage service password defined in your custom environment file.

     Note

     Director creates the following roles and users in the Identity service by default:

     • rgw_keystone_accepted_admin_roles: ResellerAdmin, swiftoperator
     • rgw_keystone_admin_domain: default
     • rgw_keystone_admin_project: service
     • rgw_keystone_admin_user: swift
5. Save the changes to the Red Hat Ceph Storage configuration file.

6. Update your deployment with the custom environment file:

   openstack overcloud deploy --templates \
   -e <existing_overcloud_environment_files>
   -e /usr/share/openstack-tripleo-heat-templates/environments/swift-external.yaml
   -e <external_rgw_environment_file>

   • Replace <existing_overcloud_environment_files> with the list of environment files that are part of your existing deployment.
   • Replace <external_rgw_environment_file> with the name of the custom environment file created during this procedure.