Chapter 3. Integrating with an existing Ceph Storage cluster To integrate Red Hat OpenStack Platform (RHOSP) with an existing Red Hat Ceph Storage cluster, you must install the ceph-ansible package. After that, you can create custom environment files to override and provide values for configuration options within OpenStack components. 3.1. Installing the ceph-ansible package The Red Hat OpenStack Platform director uses ceph-ansible to integrate with an existing Ceph Storage cluster, but ceph-ansible is not installed by default on the undercloud. Procedure Enter the following command to install the ceph-ansible package on the undercloud: 3.2. Creating a custom environment file Director supplies parameters to ceph-ansible to integrate with an external Red Hat Ceph Storage cluster through the environment file: /usr/share/openstack-tripleo-heat-templates/environments/ceph-ansible/ceph-ansible-external.yaml If you deploy the Shared File Systems service (manila) with external CephFS, separate environment files supply additional parameters: For native CephFS, the environment file is /usr/share/openstack-tripleo-heat-templates/environments/manila-cephfsnative-config.yaml . For CephFS through NFS, the environment file is /usr/share/openstack-tripleo-heat-templates/environments/manila-cephfsganesha-config.yaml . To configure integration of an existing Ceph Storage cluster with the overcloud, you must supply the details of your Ceph Storage cluster to director by using a custom environment file. Director invokes these environment files during deployment. Procedure Create a custom environment file: /home/stack/templates/ceph-config.yaml Add a parameter_defaults: section to the file: Use parameter_defaults to set all of the parameters that you want to override in /usr/share/openstack-tripleo-heat-templates/environments/ceph-ansible/ceph-ansible-external.yaml . You must set the following parameters at a minimum: CephClientKey : The Ceph client key for the client.openstack user in your Ceph Storage cluster. This is the value of key you retrieved in Configuring the existing Ceph Storage cluster . For example, AQDLOh1VgEp6FRAAFzT7Zw+Y9V6JJExQAsRnRQ== . CephClusterFSID : The file system ID of your Ceph Storage cluster. This is the value of fsid in your Ceph Storage cluster configuration file, which you retrieved in Configuring the existing Ceph Storage cluster . For example, 4b5c8c0a-ff60-454b-a1b4-9747aa737d19 . CephExternalMonHost : A comma-delimited list of the IPs of all MON hosts in your Ceph Storage cluster, for example, 172.16.1.7, 172.16.1.8 . For example: Optional: You can override the Red Hat OpenStack Platform (RHOSP) client username and the following default pool names to match your Ceph Storage cluster: CephClientUserName: <openstack> NovaRbdPoolName: <vms> CinderRbdPoolName: <volumes> GlanceRbdPoolName: <images> CinderBackupRbdPoolName: <backups> GnocchiRbdPoolName: <metrics> Optional: If you are deploying the Shared File Systems service with CephFS, you can override the following default data and metadata pool names: Note Ensure that these names match the names of the pools you created. Set the client key that you created for the Shared File Systems service. You can override the default Ceph client username for that key: Note The default client username ManilaCephFSCephFSAuthId is manila , unless you override it. CephManilaClientKey is always required. After you create the custom environment file, you must include it when you deploy the overcloud. Additional resources Deploying the overcloud 3.3. Ceph containers for Red Hat OpenStack Platform with Ceph Storage To configure Red Hat OpenStack Platform (RHOSP) to use Red Hat Ceph Storage with NFS Ganesha, you must have a Ceph container. To be compatible with Red Hat Enterprise Linux 8, RHOSP 16 requires Red Hat Ceph Storage 4 or 5 (Ceph package 14.x or Ceph package 16.x). The Ceph Storage 4 and 5 containers are hosted at registry.redhat.io , a registry that requires authentication. For more information, see Container image preparation parameters . 3.4. Deploying the overcloud Deploy the overcloud with the environment file that you created. Procedure The creation of the overcloud requires additional arguments for the openstack overcloud deploy command: This example command uses the following options: --templates - Creates the overcloud from the default heat template collection, /usr/share/openstack-tripleo-heat-templates/ . -e /usr/share/openstack-tripleo-heat-templates/environments/ceph-ansible/ceph-ansible-external.yaml - Sets the director to integrate an existing Ceph cluster to the overcloud. -e /home/stack/templates/ceph-config.yaml - Adds a custom environment file to override the defaults set by -e /usr/share/openstack-tripleo-heat-templates/environments/ceph-ansible/ceph-ansible-external.yaml . In this case, it is the custom environment file you created in Installing the ceph-ansible package . --ntp-server pool.ntp.org - Sets the NTP server. 3.4.1. Adding environment files for the Shared File Systems service with CephFS If you deploy an overcloud that uses the Shared File Systems service (manila) with CephFS, you must add additional environment files. Procedure 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. Modify the openstack overcloud deploy command depending on the CephFS back end that you use. For native CephFS: For CephFS through NFS: 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 Replace <cluster_ID> , <IP_address> , and <client_key> with values that are suitable for your environment. Additional resources For more information about generating a custom roles file, see Deploying the Shared File Systems service with CephFS through NFS . 3.4.2. Adding an additional environment file for external Ceph Object Gateway (RGW) for Object storage If you deploy an overcloud that uses an already existing RGW service for Object storage, you must add an additional environment file. Procedure Add the following parameter_defaults to a custom environment file, for example, swift-external-params.yaml , and adjust the values to suit your deployment: 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 . 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: 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 Deploy the overcloud with the additional environment files with any other environment files that are relevant to your deployment:

Commands:
sudo dnf install -y ceph-ansible
parameter_defaults:
parameter_defaults: CephClientKey: <AQDLOh1VgEp6FRAAFzT7Zw+Y9V6JJExQAsRnRQ==> CephClusterFSID: <4b5c8c0a-ff60-454b-a1b4-9747aa737d19> CephExternalMonHost: <172.16.1.7, 172.16.1.8>
ManilaCephFSDataPoolName: <manila_data> ManilaCephFSMetadataPoolName: <manila_metadata>
ManilaCephFSCephFSAuthId: <manila> CephManilaClientKey: <AQDQ991cAAAAABAA0aXFrTnjH9aO39P0iVvYyg==>
openstack overcloud deploy --templates -e /usr/share/openstack-tripleo-heat-templates/environments/ceph-ansible/ceph-ansible-external.yaml -e /home/stack/templates/ceph-config.yaml -e --ntp-server pool.ntp.org
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
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
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'
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'
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
openstack overcloud deploy --templates -e <your_environment_files> -e /usr/share/openstack-tripleo-heat-templates/environments/swift-external.yaml -e swift-external-params.yaml