Chapter 3. Integrating with an existing 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 through NFS, add /usr/share/openstack-tripleo-heat-templates/environments/manila-cephfsganesha-config.yaml.

     Red Hat recommends that you deploy the Ceph-through-NFS driver with an isolated StorageNFS network where shares are exported. You must deploy the isolated network to overcloud controller nodes. To enable this deployment, director includes the following file and role:

     • An example custom network configuration file that includes the StorageNFS network (/usr/share/openstack-tripleo-heat-templates/network_data_ganesha.yaml). Review and customize this file as necessary.
     • A ControllerStorageNFS role.

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/ceph-ansible/ceph-ansible-external.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 through NFS:

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

     Note

     The custom ceph-config.yaml environment file overrides parameters in the ceph-ansible-external.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 ceph-ansible-external.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"
         GnocchiRbdPoolName: "metrics"
         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:
             ceph::profile::params::rbd_default_features: '1'

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

Procedure

1. Add the following parameter_defaults to a custom environment file, for example, swift-external-params.yaml, and adjust the values to suit your deployment:

   parameter_defaults:
      ExternalSwiftPublicUrl: 'http://<Public RGW endpoint or loadbalancer>:8080/swift/v1/AUTH_%(project_id)s'
      ExternalSwiftInternalUrl: 'http://<Internal RGW endpoint>:8080/swift/v1/AUTH_%(project_id)s'
      ExternalSwiftAdminUrl: 'http://<Admin RGW endpoint>:8080/swift/v1/AUTH_%(project_id)s'
      ExternalSwiftUserTenant: 'service'
      SwiftPassword: 'choose_a_random_password'

   Note

   The example code snippet contains parameter values that might differ from values that you use in your environment:

   • The default port where the remote RGW instance listens is 8080. The port might be different depending on how the external RGW is configured.
   • 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.

2. Add the following code to the Ceph config file to configure RGW to use the Identity service. Replace the variable values to suit your environment:

       rgw_keystone_api_version = 3
       rgw_keystone_url = http://<public Keystone endpoint>:5000/
       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 = <password_as_defined_in_the_environment_parameters>
       rgw_keystone_implicit_tenants = true
       rgw_keystone_revocation_interval = 0
       rgw_s3_auth_use_keystone = true
       rgw_swift_versioning_enabled = true
       rgw_swift_account_in_url = true

   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

3. Deploy the overcloud with the additional environment files with any other environment files that are relevant to your deployment:

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