Files
puppet-swift/manifests/storage/disk.pp
Takashi Kajinami e888e9c0d3 disk: Expose more options
... so that users can use this wrapper with more flexible customization
about filesystems and mounts. Also, this introduces the new filesystem
type parameter so that this common implementation can be used when ext4
is used.

Change-Id: Ib60576fc593f36c36a0e0bd03611a568e21913e9
2024-02-27 09:24:20 +09:00

127 lines
4.2 KiB
Puppet

# This Puppet resource is based on the following
# instructions for creating a disk device:
# https://docs.openstack.org/swift/latest/development_saio.html
#
# ==Add a raw disk to a swift storage node==
#
# It will do two steps to create a disk device:
# - creates a disk table, use the whole disk instead
# to make the partition (e.g. use sdb as a whole)
# - formats the partition to an xfs device and
# mounts it as a block device at /srv/node/$name
#
# ATTENTION: You should not use the disk that your Operating System
# is installed on (typically /dev/sda/).
#
# === 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
#
# [*ext_args*]
# (optional) The external command that will be used in parted command.
# Default to ''. For making partitions, it would be 'mkpart primary 0% 100%'.
#
# [*manage_partition*]
# (optional) If set to false, skip calling parted which can, in some cases,
# increase the load on the server. This is to set to false only after the
# server is fully setup or if the partition was created outside of puppet.
# Defaults to true.
#
# [*filesystem_type*]
# (optional) The filesystem deployed on the device. Currently only ext4 and
# xfs are supported.
# Defaults to 'xfs'.
#
# [*mount_type*]
# (optional) Define if the device is mounted by the device partition path,
# UUID, or filesystem label.
# Defaults to 'path'.
#
# [*manage_filesystem*]
# (optional) If set to false, skip creating filesystem. This is to set to
# false only after the server is fully setup, or if the filesystem was
# created outside of puppet.
# Defaults to true.
#
# [*label*]
# (optional) Filesystem label.
# Defaults to $name.
#
# =Example=
#
# Simply add one disk sdb:
#
# swift::storage::disk { "sdb":}
#
# Add more than one disks and overwrite byte_size:
#
# swift::storage::disk {['sdb','sdc','sdd']:
# byte_size => '2048',
# }
#
# TODO(yuxcer): maybe we can remove param $base_dir
#
define swift::storage::disk(
Stdlib::Absolutepath $base_dir = '/dev',
Stdlib::Absolutepath $mnt_base_dir = '/srv/node',
$byte_size = '1024',
$ext_args = '',
Boolean $manage_partition = true,
Enum['ext4', 'xfs'] $filesystem_type = 'xfs',
Enum['path', 'uuid', 'label'] $mount_type = 'path',
Boolean $manage_filesystem = true,
String[1] $label = $name,
) {
include swift::deps
include swift::params
if(!defined(File[$mnt_base_dir])) {
file { $mnt_base_dir:
ensure => directory,
owner => 'root',
group => 'root',
require => Anchor['swift::config::begin'],
before => Anchor['swift::config::end'],
}
}
if $manage_partition {
exec { "create_partition_label-${name}":
command => "parted -s ${base_dir}/${name} mklabel gpt ${ext_args}",
path => ['/usr/bin/', '/sbin','/bin'],
onlyif => ["test -b ${base_dir}/${name}","parted ${base_dir}/${name} print|tail -1|grep 'Error'"],
before => Anchor['swift::config::end'],
}
if $filesystem_type == 'xfs' {
Exec["create_partition_label-${name}"] ~> Swift::Storage::Xfs[$name]
} else {
Exec["create_partition_label-${name}"] ~> Swift::Storage::Ext4[$name]
}
}
create_resources("swift::storage::${filesystem_type}", { $name => {
'device' => "${base_dir}/${name}",
'mnt_base_dir' => $mnt_base_dir,
'byte_size' => $byte_size,
'loopback' => false,
'mount_type' => $mount_type,
'manage_filesystem' => $manage_filesystem,
'label' => $label,
}})
}