diff --git a/manifests/ringbuilder/create.pp b/manifests/ringbuilder/create.pp index a37f4c9c..1fde2cf6 100644 --- a/manifests/ringbuilder/create.pp +++ b/manifests/ringbuilder/create.pp @@ -7,7 +7,7 @@ # [*name*] The type of ring to create. Accepts object|container|account # [*part_power*] Number of partitions in the ring. (specified as the power of 2) # Optional. Defaults to 18 (2^18) -# [*replicas] Number of replicas to store. +# [*replicas*] Number of replicas to store. # Optional. Defaults to 3 # [*min_part_hours*] Time before a partition can be moved. # Optional. Defaults to 24. diff --git a/manifests/ringsync.pp b/manifests/ringsync.pp index bb956cc3..5e41fdb6 100644 --- a/manifests/ringsync.pp +++ b/manifests/ringsync.pp @@ -1,5 +1,8 @@ # == Define: swift::ringsync # +# [*ring_server*] +# (required) IP or hostname of ring servers +# define swift::ringsync( $ring_server ) { diff --git a/manifests/storage/disk.pp b/manifests/storage/disk.pp index 85c7c157..561fe051 100644 --- a/manifests/storage/disk.pp +++ b/manifests/storage/disk.pp @@ -13,10 +13,21 @@ # ATTENTION: You should not use the disk that your Operating System # is installed on (typically /dev/sda/). # -# =Parameters= -# $base_dir = '/dev', assumes local disk devices -# $mnt_base_dir = '/srv/node', base directory where disks are mounted to -# $byte_size = '1024', block size for the disk. For very large partitions, this should be larger +# === Parameters: +# +# [*base_dir*] +# (optional) The directory where the flat files will be stored that house +# the file system to be loop back mounted. +# Defaults to '/dev', assumes local disk devices +# +# [*mnt_base_dir*] +# (optional) The directory where the flat files that store the file system +# to be loop back mounted are actually mounted at. +# Defaults to '/srv/node', base directory where disks are mounted to +# +# [*byte_size*] +# (optional) The byte size that dd uses when it creates the file system. +# Defaults to '1024', block size for the disk. For very large partitions, this should be larger # # =Example= # diff --git a/manifests/storage/ext4.pp b/manifests/storage/ext4.pp index a866445b..2a96009c 100644 --- a/manifests/storage/ext4.pp +++ b/manifests/storage/ext4.pp @@ -1,15 +1,27 @@ # follow the instructions for creating a loopback device # for storage from: http://swift.openstack.org/development_saio.html # -# -# # this define needs to be sent a refresh signal to do anything # +# === Parameters: # -# [*title*] +# [*device*] +# (mandatory) An array of devices (prefixed or not by /dev) +# +# [*mnt_base_dir*] +# (optional) The directory where the flat files that store the file system +# to be loop back mounted are actually mounted at. +# Defaults to '/srv/node', base directory where disks are mounted to +# +# [*byte_size*] +# (optional) The byte size that dd uses when it creates the file system. +# Defaults to '1024', block size for the disk. For very large partitions, this should be larger +# It is recommened to use 1024 to ensure that the metadata can fit in a single inode. +# +# [*loopback*] +# (optional) Define if the device must be mounted as a loopback or not +# Defaults to false. # -# [*byte_size*] Byte size to use for every inode in the created filesystem. -# It is recommened to use 1024 to ensure that the metadata can fit in a single inode. define swift::storage::ext4( $device, $byte_size = '1024', diff --git a/manifests/storage/filter/recon.pp b/manifests/storage/filter/recon.pp index a44cc13c..6a8c5263 100644 --- a/manifests/storage/filter/recon.pp +++ b/manifests/storage/filter/recon.pp @@ -2,7 +2,7 @@ # Configure swift recon. # # == Parameters -# [cache_path] The path for recon cache +# [*cache_path*] The path for recon cache # Optional. Defaults to '/var/cache/swift/' # # == Dependencies diff --git a/manifests/storage/loopback.pp b/manifests/storage/loopback.pp index 4972764e..77d619a0 100644 --- a/manifests/storage/loopback.pp +++ b/manifests/storage/loopback.pp @@ -6,6 +6,30 @@ # - creates a file # - formats the file to be an xfs device and mounts it as a loopback device at /srv/node/$name # - sets up each mount point as a swift endpoint +# === Parameters: +# +# [*base_dir*] +# (optional) The directory where the flat files will be stored that house +# the file system to be loop back mounted. +# Defaults to '/dev', assumes local disk devices +# +# [*mnt_base_dir*] +# (optional) The directory where the flat files that store the file system +# to be loop back mounted are actually mounted at. +# Defaults to '/srv/node', base directory where disks are mounted to +# +# [*byte_size*] +# (optional) The byte size that dd uses when it creates the file system. +# Defaults to '1024', block size for the disk. For very large partitions, this should be larger +# +# [*seek*] +# (optional) The size of the file system that will be created. +# Defaults to 25000. +# +# [*fstype*] +# (optional) The filesystem type. +# Defaults to 'xfs'. +# define swift::storage::loopback( $base_dir = '/srv/loopback-device', $mnt_base_dir = '/srv/node', diff --git a/manifests/storage/mount.pp b/manifests/storage/mount.pp index 0ef11e83..e77e2bf2 100644 --- a/manifests/storage/mount.pp +++ b/manifests/storage/mount.pp @@ -3,6 +3,24 @@ # swift::storage::mount # # +# === Parameters: +# +# [*device*] +# (mandatory) An array of devices (prefixed or not by /dev) +# +# [*mnt_base_dir*] +# (optional) The directory where the flat files that store the file system +# to be loop back mounted are actually mounted at. +# Defaults to '/srv/node', base directory where disks are mounted to +# +# [*loopback*] +# (optional) Define if the device must be mounted as a loopback or not +# Defaults to false. +# +# [*fstype*] +# (optional) The filesystem type. +# Defaults to 'xfs'. +# define swift::storage::mount( $device, $mnt_base_dir = '/srv/node', diff --git a/manifests/storage/node.pp b/manifests/storage/node.pp index 7f7608db..fcaee1ad 100644 --- a/manifests/storage/node.pp +++ b/manifests/storage/node.pp @@ -4,6 +4,45 @@ # a storage endpoint for account, container, and object # on the same mount point # +# === Parameters: +# +# [*mnt_base_dir*] +# (optional) The directory where the flat files that store the file system +# to be loop back mounted are actually mounted at. +# Defaults to '/srv/node', base directory where disks are mounted to +# +# [*zone*] +# (required) Zone is the number of the zone this device is in. +# The zone parameter must be an integer. +# +# [*weight*] +# (optional) Weight is a float weight that determines how many partitions are +# put on the device relative to the rest of the devices in the cluster (a good +# starting point is 100.0xTB on the drive). +# Add each device that will be initially in the cluster. +# Defaults to 1. +# +# [*owner*] +# (optional) Owner (uid) of rsync server. +# Defaults to 'swift'. +# +# [*group*] +# (optional) Group (gid) of rsync server. +# Defaults to 'swift'. +# +# [*max_connections*] +# (optional) maximum number of simultaneous connections allowed. +# Defaults to 25. +# +# [*storage_local_net_ip*] +# (optional) The IP address of the storage server. +# Defaults to '127.0.0.1'. +# +# ==== DEPRECATED PARAMETERS +# +# [*manage_ring*] +# This parameter is deprecated and does nothing. +# define swift::storage::node( $mnt_base_dir, $zone, @@ -12,6 +51,7 @@ define swift::storage::node( $group = 'swift', $max_connections = 25, $storage_local_net_ip = '127.0.0.1', + # DEPRECATED PARAMETERS $manage_ring = true ) { diff --git a/manifests/storage/server.pp b/manifests/storage/server.pp index 6d47900a..5b3a0b71 100644 --- a/manifests/storage/server.pp +++ b/manifests/storage/server.pp @@ -8,23 +8,103 @@ # Mandatory. Usually 6000, 6001 and 6002 for respectively # object, container and account. # +# [*type*] +# (required) The type of device, e.g. account, object, or container. +# +# [*storage_local_net_ip*] +# (required) This is the ip that the storage service will bind to when it starts. +# +# [*devices*] +# (optional) The directory where the physical storage device will be mounted. +# Defaults to '/srv/node'. +# +# [*owner*] +# (optional) Owner (uid) of rsync server. +# Defaults to 'swift'. +# +# [*group*] +# (optional) Group (gid) of rsync server. +# Defaults to 'swift'. +# +# [*max_connections*] +# (optional) maximum number of simultaneous connections allowed. +# Defaults to 25. +# # [*incoming_chmod*] Incoming chmod to set in the rsync server. # Optional. Defaults to 0644 for maintaining backwards compatibility. # *NOTE*: Recommended parameter: 'Du=rwx,g=rx,o=rx,Fu=rw,g=r,o=r' -# This mask translates to 0755 for directories and 0644 for files. +# This mask translates to 0755 for directories and 0644 for files. # # [*outgoing_chmod*] Outgoing chmod to set in the rsync server. # Optional. Defaults to 0644 for maintaining backwards compatibility. # *NOTE*: Recommended parameter: 'Du=rwx,g=rx,o=rx,Fu=rw,g=r,o=r' -# This mask translates to 0755 for directories and 0644 for files. +# This mask translates to 0755 for directories and 0644 for files. # -# [*log_udp_host*] -# (optional) If not set, the UDP receiver for syslog is disabled. -# Defaults to undef. + +# [*pipeline*] +# (optional) Pipeline of applications. +# Defaults to ["${type}-server"]. # -# [*log_udp_port*] -# (optional) Port value for UDP receiver, if enabled. -# Defaults to undef. +# [*mount_check*] +# (optional) Whether or not check if the devices are mounted to prevent accidentally +# writing to the root device +# Defaults to false. +# +# [*user*] +# (optional) User to run as +# Defaults to 'swift'. +# +# [*workers*] +# (optional) Override the number of pre-forked workers that will accept +# connections. If set it should be an integer, zero means no fork. If unset, +# it will try to default to the number of effective cpu cores and fallback to +# one. Increasing the number of workers may reduce the possibility of slow file +# system operations in one request from negatively impacting other requests. +# See http://docs.openstack.org/developer/swift/deployment_guide.html#general-service-tuning +# Defaults to '1'. +# +# [*allow_versions*] +# (optional) Enable/Disable object versioning feature +# Defaults to 'false'. +# +# [*replicator_concurrency*] +# (optional) Number of replicator workers to spawn. +# Defaults to $::processorcount. +# +# [*updater_concurrency*] +# (optional) Number of updater workers to spawn. +# Defaults to $::processorcount. +# +# [*reaper_concurrency*] +# (optional) Number of reaper workers to spawn. +# Defaults to $::processorcount. +# +# [*log_facility*] +# (optional) Syslog log facility. +# Defaults to 'LOG_LOCAL2'. +# +# [*log_level*] +# (optional) Logging level. +# Defaults to 'INFO'. +# +# [*log_address*] +# Deprecated, this parameter does nothing. +# +# [*log_name*] +# (optional) Label used when logging. +# Defaults to "${type}-server". + +# [*log_udp_host*] +# (optional) If not set, the UDP receiver for syslog is disabled. +# Defaults to undef. +# +# [*log_udp_port*] +# (optional) Port value for UDP receiver, if enabled. +# Defaults to undef. +# +# [*config_file_path*] +# (optional) The configuration file name. +# Defaults to "${type}-server/${name}.conf". # define swift::storage::server( $type, diff --git a/manifests/storage/xfs.pp b/manifests/storage/xfs.pp index dc77942d..974ef7c0 100644 --- a/manifests/storage/xfs.pp +++ b/manifests/storage/xfs.pp @@ -1,8 +1,21 @@ -# [*title*] # -# [*byte_size*] Byte size to use for every inode in the created filesystem. -# It is recommened to use 1024 to ensure that the metadata can fit in a single inode. +# === Parameters: # +# [*device*] +# (mandatory) An array of devices (prefixed or not by /dev) +# +# [*mnt_base_dir*] +# (optional) The directory where the flat files that store the file system +# to be loop back mounted are actually mounted at. +# Defaults to '/srv/node', base directory where disks are mounted to +# +# [*byte_size*] +# (optional) Byte size to use for every inode in the created filesystem. +# Defaults to '1024'. It is recommened to use 1024 to ensure that the metadata can fit in a single inode. +# +# [*loopback*] +# (optional) Define if the device must be mounted as a loopback or not +# Defaults to false. # # Sample usage: #