puppet-manila/manifests/backend/netapp.pp
Takashi Kajinami a37c133988 Add max_over_subscription_ratio parameter
... to each driver configurations, so that users can customize this
option in individual driver sections.

Note that this option works only when the driver supports thin
provisioning.

Change-Id: I8b6fd6a14f77f56c6b42a9977fe81b64698b5db4
2024-03-19 01:06:22 +00:00

195 lines
9.0 KiB
Puppet

# == define: manila::backend::netapp
#
# Configures Manila to use the NetApp unified share driver
# Compatible for multiple backends
#
# === Parameters
#
# [*driver_handles_share_servers*]
# (required) 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.
#
# [*netapp_login*]
# (required) Administrative user account name used to access the storage
# system.
#
# [*netapp_password*]
# (required) Password for the administrative user account specified in the
# netapp_login parameter.
#
# [*netapp_server_hostname*]
# (required) The hostname (or IP address) for the storage system.
#
# [*share_backend_name*]
# (optional) Name of the backend in manila.conf that
# these settings will reside in
# Defaults to $::name.
#
# [*backend_availability_zone*]
# (Optional) Availability zone for this share backend.
# If not set, the storage_availability_zone option value
# is used as the default for all backends.
# Defaults to $facts['os_service_default'].
#
# [*netapp_transport_type*]
# (optional) The transport protocol used when communicating with
# the storage system or proxy server. Valid values are
# http or https.
# Defaults to $facts['os_service_default'].
#
# [*netapp_storage_family*]
# (optional) The storage family type used on the storage system; valid
# values are ontap_cluster for clustered Data ONTAP.
# Defaults to $facts['os_service_default'].
#
# [*netapp_server_port*]
# (optional) The TCP port to use for communication with the storage system
# or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP
# and 443 for HTTPS.
# Defaults to $facts['os_service_default'].
#
# [*netapp_volume_name_template*]
# (optional) NetApp volume name template.
# Defaults to $facts['os_service_default'].
#
# [*netapp_vserver*]
# (optional) This option specifies the storage virtual machine (previously
# called a Vserver) name on the storage cluster on which provisioning of
# shared file systems should occur. This option only applies
# when the option driver_handles_share_servers is set to False.
# Defaults to $facts['os_service_default'].
#
# [*netapp_vserver_name_template*]
# (optional) Name template to use for new vserver. This option only applies
# when the option driver_handles_share_servers is set to True.
# Defaults to $facts['os_service_default'].
#
# [*netapp_lif_name_template*]
# (optional) Logical interface (LIF) name template. This option only applies
# when the option driver_handles_share_servers is set to True.
# Defaults to $facts['os_service_default'].
#
# [*netapp_aggregate_name_search_pattern*]
# (optional) Pattern for searching available aggregates
# for provisioning.
# Defaults to $facts['os_service_default'].
#
# [*netapp_root_volume_aggregate*]
# (optional) Name of aggregate to create root volume on. This option only
# applies when the option driver_handles_share_servers is set to True.
# Defaults to $facts['os_service_default'].
#
# [*netapp_root_volume*]
# (optional) Root volume name. This option only applies when the option
# driver_handles_share_servers is set to True.
# Defaults to $facts['os_service_default']
#
# [*netapp_port_name_search_pattern*]
# (optional) Pattern for overriding the selection of network ports on which
# to create Vserver LIFs.
# Defaults to $facts['os_service_default'].
#
# [*netapp_trace_flags*]
# (optional) This option is a comma-separated list of options (valid values
# include method and api) that controls which trace info is written to the
# Manila logs when the debug level is set to True.
# Defaults to $facts['os_service_default'].
#
# [*reserved_share_percentage*]
# (optional) The percentage of backend capacity reserved.
# Defaults to: $facts['os_service_default']
#
# [*reserved_share_from_snapshot_percentage*]
# (optional) The percentage of backend capacity reserved. Used for shares
# created from the snapshot.
# Defaults to: $facts['os_service_default']
#
# [*reserved_share_extend_percentage*]
# (optional) The percentage of backend capacity reserved for share extend
# operation.
# Defaults to: $facts['os_service_default']
#
# [*max_over_subscription_ratio*]
# (optional) Float representation of the over subscription ratio when thin
# provisionig is involved.
# Defaults to: $facts['os_service_default']
#
# [*package_ensure*]
# (optional) Ensure state for package. Defaults to 'present'.
#
# === Examples
#
# manila::backend::netapp { 'myBackend':
# driver_handles_share_servers => true,
# netapp_login => 'clusterAdmin',
# netapp_password => 'password',
# netapp_server_hostname => 'netapp.mycorp.com',
# netapp_storage_family => 'ontap_cluster',
# netapp_transport_type => 'https',
# }
#
define manila::backend::netapp (
$driver_handles_share_servers,
String[1] $netapp_login,
String[1] $netapp_password,
String[1] $netapp_server_hostname,
$share_backend_name = $name,
$backend_availability_zone = $facts['os_service_default'],
$netapp_transport_type = $facts['os_service_default'],
$netapp_storage_family = $facts['os_service_default'],
$netapp_server_port = $facts['os_service_default'],
$netapp_volume_name_template = $facts['os_service_default'],
$netapp_vserver = $facts['os_service_default'],
$netapp_vserver_name_template = $facts['os_service_default'],
$netapp_lif_name_template = $facts['os_service_default'],
$netapp_aggregate_name_search_pattern = $facts['os_service_default'],
$netapp_root_volume_aggregate = $facts['os_service_default'],
$netapp_root_volume = $facts['os_service_default'],
$netapp_port_name_search_pattern = $facts['os_service_default'],
$netapp_trace_flags = $facts['os_service_default'],
$reserved_share_percentage = $facts['os_service_default'],
$reserved_share_from_snapshot_percentage = $facts['os_service_default'],
$reserved_share_extend_percentage = $facts['os_service_default'],
$max_over_subscription_ratio = $facts['os_service_default'],
$package_ensure = 'present',
) {
include manila::deps
include manila::params
$netapp_share_driver = 'manila.share.drivers.netapp.common.NetAppDriver'
manila_config {
"${share_backend_name}/share_driver": value => $netapp_share_driver;
"${share_backend_name}/driver_handles_share_servers": value => $driver_handles_share_servers;
"${share_backend_name}/netapp_login": value => $netapp_login;
"${share_backend_name}/netapp_password": value => $netapp_password, secret => true;
"${share_backend_name}/netapp_server_hostname": value => $netapp_server_hostname;
"${share_backend_name}/share_backend_name": value => $share_backend_name;
"${share_backend_name}/backend_availability_zone": value => $backend_availability_zone;
"${share_backend_name}/netapp_transport_type": value => $netapp_transport_type;
"${share_backend_name}/netapp_storage_family": value => $netapp_storage_family;
"${share_backend_name}/netapp_server_port": value => $netapp_server_port;
"${share_backend_name}/netapp_volume_name_template": value => $netapp_volume_name_template;
"${share_backend_name}/netapp_vserver": value => $netapp_vserver;
"${share_backend_name}/netapp_vserver_name_template": value => $netapp_vserver_name_template;
"${share_backend_name}/netapp_lif_name_template": value => $netapp_lif_name_template;
"${share_backend_name}/netapp_aggregate_name_search_pattern": value => $netapp_aggregate_name_search_pattern;
"${share_backend_name}/netapp_root_volume_aggregate": value => $netapp_root_volume_aggregate;
"${share_backend_name}/netapp_root_volume": value => $netapp_root_volume;
"${share_backend_name}/netapp_port_name_search_pattern": value => $netapp_port_name_search_pattern;
"${share_backend_name}/netapp_trace_flags": value => $netapp_trace_flags;
"${share_backend_name}/reserved_share_percentage": value => $reserved_share_percentage;
"${share_backend_name}/reserved_share_from_snapshot_percentage": value => $reserved_share_from_snapshot_percentage;
"${share_backend_name}/reserved_share_extend_percentage": value => $reserved_share_extend_percentage;
"${share_backend_name}/max_over_subscription_ratio": value => $max_over_subscription_ratio;
}
ensure_packages('nfs-client', {
name => $::manila::params::nfs_client_package_name,
ensure => $package_ensure,
tag => 'manila-support-package',
})
}