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>
This commit is contained in:
Goutham Pacha Ravi 2020-08-11 17:44:56 -07:00
parent 23287bc88e
commit 2388d7510d
3 changed files with 33 additions and 11 deletions

View File

@ -25,10 +25,6 @@
# (optional) Name of the cephfs cluster the driver will connect to.
# Defaults to: ceph
#
# [*cephfs_enable_snapshots*]
# (optional) If set to True, then Manila will utilize ceph snapshots.
# Defaults to: False
#
# [*cephfs_ganesha_server_ip*]
# (optional) IP of a server where Ganesha service runs on.
# Defaults to: undef
@ -66,13 +62,18 @@
# (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_enable_snapshots = false,
$cephfs_ganesha_server_ip = undef,
$cephfs_ganesha_export_ips = undef,
$cephfs_ganesha_server_is_remote = $::os_service_default,
@ -81,6 +82,8 @@ define manila::backend::cephfs (
$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
@ -94,7 +97,6 @@ define manila::backend::cephfs (
"${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_enable_snapshots": value => $cephfs_enable_snapshots;
"${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;
@ -102,6 +104,13 @@ define manila::backend::cephfs (
"${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;
"${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
}
}
}

View File

@ -0,0 +1,11 @@
---
deprecations:
- |
The parameter 'manila::backend::cephfs::cephfs_enable_snapshots' has been
deprecated. Manila's CephFS driver has changed the default behavior in
the Victoria cycle to always support snapshots, because they are fully
supported in Ceph Nautilus, the minimum version of Ceph supported by
Manila. Since the ``cephfs_enable_snapshots`` config option will be removed
in a future release, we recommend that you stop relying on it. Manila's
snapshots can be disabled by virtue of share type extra specs if
desired.

View File

@ -11,14 +11,15 @@ describe 'manila::backend::cephfs' do
:cephfs_conf_path => '$state_path/ceph.conf',
:cephfs_auth_id => 'manila',
:cephfs_cluster_name => 'ceph',
:cephfs_enable_snapshots => true,
:cephfs_protocol_helper_type => 'NFS',
:cephfs_ganesha_server_ip => '10.0.0.1',
:cephfs_ganesha_export_ips => '10.0.0.1,1001::1001',
:cephfs_ganesha_server_is_remote => true,
:cephfs_ganesha_server_username => 'ganeshadmin',
:cephfs_ganesha_path_to_private_key => '/readable/by/manila.key',
:cephfs_volume_mode => '0775'
:cephfs_volume_mode => '0775',
# deprecated parameters
:cephfs_enable_snapshots => true,
}
end
@ -33,8 +34,6 @@ describe 'manila::backend::cephfs' do
'manila')
is_expected.to contain_manila_config('cephfs/cephfs_cluster_name').with_value(
'ceph')
is_expected.to contain_manila_config('cephfs/cephfs_enable_snapshots').with_value(
true)
is_expected.to contain_manila_config('cephfs/cephfs_protocol_helper_type').with_value(
'NFS')
is_expected.to contain_manila_config('cephfs/cephfs_ganesha_server_ip').with_value(
@ -50,6 +49,9 @@ describe 'manila::backend::cephfs' do
is_expected.to contain_manila_config('cephfs/cephfs_ganesha_path_to_private_key').with_value(
'/readable/by/manila.key'
)
# deprecated parameters
is_expected.to contain_manila_config('cephfs/cephfs_enable_snapshots').with_value(
true)
end
end