Chapter 6. Ceph Storage Parameters

CephAdminKey

The Ceph admin client key. Can be created with: ceph-authtool --gen-print-key

CephAnsibleDisksConfig

Disks configuration settings for ceph-ansible. The default value is {'devices': ['/dev/vdb'], 'osd_scenario': 'lvm', 'osd_objectstore': 'bluestore'}.

CephAnsibleEnvironmentVariables

Mapping of Ansible environment variables to override defaults.

CephAnsibleExtraConfig

Extra vars for the ceph-ansible playbook.

CephAnsiblePlaybook

List of paths to the ceph-ansible playbooks to execute. If not specified, the playbook will be determined automatically depending on type of operation being performed (deploy/update/upgrade). The default value is ['default'].

CephAnsiblePlaybookVerbosity

The number of -v, -vv, etc. passed to ansible-playbook command. The default value is 1.

CephAnsibleRepo

The repository that should be used to install the right ceph-ansible package. This value can be used by tripleo-validations to double check the right ceph-ansible version is installed. The default value is centos-ceph-nautilus.

CephAnsibleSkipTags

List of ceph-ansible tags to skip. The default value is package-install,with_pkg.

CephClientKey

The Ceph client key. Currently only used for external Ceph deployments to create the openstack user keyring. Can be created with: ceph-authtool --gen-print-key

CephClusterFSID

The Ceph cluster FSID. Must be a UUID.

CephClusterName

The Ceph cluster name. The default value is ceph.

CephConfigOverrides

Extra configuration settings to dump into ceph.conf.

CephDashboardAdminPassword

Admin password for the dashboard component.

CephDashboardAdminRO

Parameter used to set a read-only admin user. The default value is True.

CephDashboardAdminUser

Admin user for the dashboard component. The default value is admin.

CephEnableDashboard

Parameter used to trigger the dashboard deployment. The default value is False.

CephExternalMonHost

List of externally managed Ceph Mon Host IPs. Only used for external Ceph deployments.

CephExternalMultiConfig

List of maps describing extra overrides which will be applied when configuring extra external Ceph clusters. If this list is non-empty, ceph-ansible will run an extra count(list) times using the same parameters as the first run except each parameter within each map will override the defaults. If the following were used, the second run would configure the overcloud to also use the ceph2 cluster with all the previous parameters except /etc/ceph/ceph2.conf would have a mon_host entry containing the value of external_cluster_mon_ips below, and not the default CephExternalMonHost. Subsequent ceph-ansible runs are restricted to just ceph clients. CephExternalMultiConfig may not be used to deploy additional internal Ceph clusters within one OpenStack Orchestration (heat) stack. The map for each list should contain not tripleo-heat-template parameters but ceph-ansible parameters. - cluster: ceph2 fsid: e2cba068-5f14-4b0f-b047-acf375c0004a external_cluster_mon_ips: 172.18.0.5,172.18.0.6,172.18.0.7 keys: - name: "client.openstack" caps: mgr: "allow *" mon: "profile rbd" osd: "osd: profile rbd pool=volumes, profile rbd pool=backups, profile rbd pool=vms, profile rbd pool=images" key: "AQCwmeRcAAAAABAA6SQU/bGqFjlfLro5KxrB1Q==" mode: "0600" dashboard_enabled: false.

CephExtraKeys

List of maps describing extra keys which will be created on the deployed Ceph cluster. Uses ceph-ansible/library/ceph_key.py ansible module. Each item in the list must be in the following example format - name: "client.glance" caps: mgr: "allow *" mon: "profile rbd" osd: "profile rbd pool=images" key: "AQBRgQ9eAAAAABAAv84zEilJYZPNuJ0Iwn9Ndg==" mode: "0600".

CephGrafanaAdminPassword

Admin password for grafana component.

CephIPv6

Enables Ceph daemons to bind to IPv6 addresses. The default value is False.

CephManilaClientKey

The Ceph client key. Can be created with: ceph-authtool --gen-print-key

CephMdsKey

The cephx key for the MDS service. Can be created with ceph-authtool --gen-print-key.

CephMonKey

The Ceph monitors key. Can be created with: ceph-authtool --gen-print-key

CephOsdPercentageMin

The minimum percentage of Ceph OSDs which must be running and in the Ceph cluster, according to ceph osd stat, for the deployment not to fail. Used to catch deployment errors early. Set this value to 0 to disable this check. The default value is 66.

CephPoolDefaultPgNum

Default pg_num to use for the RBD pools. The default value is 128.

CephPoolDefaultSize

Default minimum replication for RBD copies. The default value is 3.

CephPools

Override settings for one of the predefined pools or to create additional ones. Example: { "volumes": { "size": 5, "pg_num": 128, "pgp_num": 128 } }

CephRbdMirrorConfigure

Perform mirror configuration between local and remote pool. The default value is True.

CephRbdMirrorCopyAdminKey

Copy the admin key to all nodes. The default value is False.

CephRbdMirrorPool

Name of the local pool to mirror to remote cluster.

CephRbdMirrorRemoteCluster

The name given to the remote Ceph cluster from the local cluster. Keys reside in the /etc/ceph directory. The default value is not-ceph.

CephRbdMirrorRemoteUser

The rbd-mirror daemon needs a user to authenticate with the remote cluster. By default, this key should be available under /etc/ceph/<remote_cluster>.client.<remote_user>.keyring.

CephRgwClientName

The client name for the RADOSGW service." The default value is radosgw.

CephRgwKey

The cephx key for the RADOSGW client. Can be created with ceph-authtool --gen-print-key.

CephValidationDelay

Interval (in seconds) in between validation checks. The default value is 30.

CephValidationRetries

Number of retry attempts for Ceph validation. The default value is 40.

CinderBackupBackend

The short name of the OpenStack Block Storage (cinder) Backup backend to use. The default value is swift.

CinderBackupRbdPoolName

Pool to use if Block Storage (cinder) Backup is enabled. The default value is backups.

CinderEnableRbdBackend

Whether to enable or not the Rbd backend for OpenStack Block Storage (cinder). The default value is False.

CinderRbdExtraPools

List of extra Ceph pools for use with RBD backends for OpenStack Block Storage (cinder). An extra OpenStack Block Storage (cinder) RBD backend driver is created for each pool in the list. This is in addition to the standard RBD backend driver associated with the CinderRbdPoolName.

CinderRbdPoolName

Pool to use for Block Storage (cinder) service. The default value is volumes.

DeploymentServerBlacklist

List of server hostnames to blacklist from any triggered deployments.

GlanceBackend

The short name of the OpenStack Image Storage (glance) backend to use. Set to rbd to use Ceph Storage.` The default value is swift.

GlanceRbdPoolName

Pool to use for Image Storage (glance) service. The default value is images.

GnocchiBackend

The short name of the OpenStack Telemetry Metrics (gnocchi) backend to use. Should be one of swift, rbd, file or s3. The default value is swift.

GnocchiRbdPoolName

Pool to use for Telemetry storage. The default value is metrics.

LocalCephAnsibleFetchDirectoryBackup

Filesystem path on undercloud to persist a copy of the data from the ceph-ansible fetch directory. Used as an alternative to backing up the fetch_directory in Swift. Path must be writable and readable by the user running ansible from config-download, e.g. the mistral user in the mistral-executor container is able to read/write to /var/lib/mistral/ceph_fetch.

ManilaCephFSCephFSAuthId

The CephFS user ID for Shared Filesystem Service (manila). The default value is manila.

ManilaCephFSDataPoolName

Pool to use for file share storage. The default value is manila_data.

ManilaCephFSDataPoolPGNum

Placement group count for the CephFS data pool for file share storage. The default value is 128.

ManilaCephFSMetadataPoolName

Pool to use for file share metadata storage. The default value is manila_metadata.

ManilaCephFSMetadataPoolPGNum

Placement group count for the CephFS metadata pool for file share storage. The default value is 128.

ManilaCephFSShareBackendName

Backend name of the CephFS share for file share storage. The default value is cephfs.

NovaEnableRbdBackend

Whether to enable the Ceph backend for Compute (nova). The default value is False.

NovaRbdPoolName

Pool to use for Compute storage. The default value is vms.