puppet-manila/manifests/backend/cephfs.pp
Goutham Pacha Ravi 2388d7510d Deprecate cephfs_enable_snapshots parameter
Manila has deprecated this parameter and
will remove it in a future release.

[1] https://review.opendev.org/736827/
Partially-Implements: bp update-cephfs-drivers
Change-Id: Ie205685105d1190bdcf9ced9c69c9a67a5146b06
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2020-08-12 10:31:44 -07:00

117 lines
4.4 KiB
Puppet

# ==define manila::backend::cephfs
#
# === Parameters
#
# [*driver_handles_share_servers*]
# (optional) Denotes whether the driver should handle the responsibility of
# managing share servers. This must be set to false if the driver is to
# operate without managing share servers.
# Defaults to: False
#
# [*share_backend_name*]
# (optional) Name of the backend in manila.conf that
# these settings will reside in
# Defaults to: $name
#
# [*cephfs_conf_path*]
# (optional) Path to cephfs config.
# Defaults to: $state_path/ceph.conf
#
# [*cephfs_auth_id*]
# (optional) cephx user id for Manila
# Defaults to: manila
#
# [*cephfs_cluster_name*]
# (optional) Name of the cephfs cluster the driver will connect to.
# Defaults to: ceph
#
# [*cephfs_ganesha_server_ip*]
# (optional) IP of a server where Ganesha service runs on.
# Defaults to: undef
#
# [*cephfs_ganesha_export_ips*]
# (optional) List of IPs on which Ganesha provides NFS share service.
# Defaults to: undef
#
# [*cephfs_ganesha_server_is_remote*]
# (required) Whether the Ganesha service is remote or colocated on the
# same node where the Share service runs.
# Defaults to $::os_service_default
#
# [*cephfs_ganesha_server_username*]
# (optional) The username to use when logging on the remote node
# hosting the Ganesha service
# Defaults to: undef
#
# [*cephfs_ganesha_server_password*]
# (optional) The password to use when logging on the remote node
# hosting the Ganesha service
# Defaults to: undef
#
# [*cephfs_ganesha_path_to_private_key*]
# (optional) The secret key to use when logging on the remote node
# hosting the Ganesha service (preveals on server_password)
# Defaults to: undef
#
# [*cephfs_volume_mode*]
# (optional) octal rwx permissions for CephFS backing volumes,
# snapshots, and groups of volumes and snapshots.
# Defaults to $::os_service_default
#
# [*cephfs_protocol_helper_type*]
# (optional) Sets helper type for CephFS driver, can be CEPHFS or NFS
# Defaults to: CEPHFS
#
# === DEPRECATED PARAMETERS
#
# [*cephfs_enable_snapshots*]
# (optional) If set to True, then Manila will utilize ceph snapshots.
# Defaults to: False
#
define manila::backend::cephfs (
$driver_handles_share_servers = false,
$share_backend_name = $name,
$cephfs_conf_path = '$state_path/ceph.conf',
$cephfs_auth_id = 'manila',
$cephfs_cluster_name = 'ceph',
$cephfs_ganesha_server_ip = undef,
$cephfs_ganesha_export_ips = undef,
$cephfs_ganesha_server_is_remote = $::os_service_default,
$cephfs_ganesha_server_username = undef,
$cephfs_ganesha_server_password = undef,
$cephfs_ganesha_path_to_private_key = undef,
$cephfs_volume_mode = $::os_service_default,
$cephfs_protocol_helper_type = 'CEPHFS',
# DEPRECATED PARAMETERS
$cephfs_enable_snapshots = undef,
) {
include manila::deps
$share_driver = 'manila.share.drivers.cephfs.driver.CephFSDriver'
manila_config {
"${name}/driver_handles_share_servers": value => $driver_handles_share_servers;
"${name}/share_backend_name": value => $share_backend_name;
"${name}/share_driver": value => $share_driver;
"${name}/cephfs_conf_path": value => $cephfs_conf_path;
"${name}/cephfs_auth_id": value => $cephfs_auth_id;
"${name}/cephfs_cluster_name": value => $cephfs_cluster_name;
"${name}/cephfs_ganesha_server_ip": value => $cephfs_ganesha_server_ip;
"${name}/cephfs_ganesha_export_ips": value => $cephfs_ganesha_export_ips;
"${name}/cephfs_ganesha_server_is_remote": value => $cephfs_ganesha_server_is_remote;
"${name}/cephfs_ganesha_server_username": value => $cephfs_ganesha_server_username;
"${name}/cephfs_ganesha_server_password": value => $cephfs_ganesha_server_password;
"${name}/cephfs_ganesha_path_to_private_key": value => $cephfs_ganesha_path_to_private_key;
"${name}/cephfs_volume_mode": value => $cephfs_volume_mode;
"${name}/cephfs_protocol_helper_type": value => $cephfs_protocol_helper_type;
}
if $cephfs_enable_snapshots != undef {
warning('The option cephfs_enable_snapshots has been deprecated and will be removed in a future release.')
manila_config {
"${name}/cephfs_enable_snapshots": value => $cephfs_enable_snapshots
}
}
}