e4_computer_engineering.beegfs.storaged role – Configure Beegfs Storage services

Note

This role is part of the e4_computer_engineering.beegfs collection (version 2.2.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install e4_computer_engineering.beegfs.

To use it in a playbook, specify: e4_computer_engineering.beegfs.storaged.

Entry point main – Configure Beegfs Storage services

New in e4_computer_engineering.beegfs 1.0.0

Synopsis

  • Install and configure Beegfs Storage services.

Parameters

Parameter

Comments

storaged_auth_file_path

string

The location on local filesystem to deploy the connection auth file from

Default: "{{ role_path }}/files/conn.auth"

storaged_beegfs_version

string / required

The Beegfs version that will be used https://doc.beegfs.io/latest/release_notes.html

Choices:

  • "7.4.1"

  • "7.4.2"

  • "7.4.3"

  • "7.4.4"

  • "7.4.5"

  • "7.4.6"

  • "8.1"

  • "8.2"

storaged_filesystem_alloc_size

string

XFS allocation size for buffered I/O

Default: "131072k"

storaged_filesystem_inode_size

integer

Inode size in bytes for the filesystem

Default: 512

storaged_filesystem_log_bufs

integer

Number of XFS log buffers

Default: 8

storaged_filesystem_log_unit

string

XFS log buffer size

Default: "128k"

storaged_filesystem_log_version

integer

XFS log version

Default: 2

storaged_filesystem_options

string

Mount options for the storage filesystem

Default: "defaults,noatime,nodiratime,seclabel,swalloc,attr2,largeio,inode64,nofail, allocsize={{ storaged_filesystem_alloc_size }}, logbufs={{ storaged_filesystem_log_bufs }}, logbsize={{ storaged_filesystem_log_unit }}"

storaged_filesystem_purge

boolean

Whether to purge existing filesystem data before creating new filesystem

WARNING - This will destroy all data on the device

Choices:

  • false ← (default)

  • true

storaged_filesystem_quota_options

string

Additional mount options for quota support on XFS

Default: ",uqnoenforce,gqnoenforce"

storaged_filesystem_strip_unit

string

XFS stripe unit size

Default: "128k"

storaged_filesystem_strip_width

integer

XFS stripe width (number of data disks in RAID)

Default: 8

storaged_filesystem_type

string

The filesystem type to use for storage targets

Choices:

  • "ext4"

  • "xfs" ← (default)

storaged_populate_etc_hosts

boolean

Whether to populate /etc/hosts file with Beegfs cluster nodes addresses

When enabled, all nodes in the inventory will be added to /etc/hosts

This is useful when DNS is not available or for testing environments

Not executed inside Docker/container environments

Choices:

  • false ← (default)

  • true

storaged_server_targets

list / elements=dictionary

The list of storage targets and their parameters for each storage server

conn_interfaces

list / elements=string

The list of interfaces to use by the daemon

This list will be used in the `conn_interfaces_file`

Default: []

conn_mgmtd_port_tcp

string

The TCP port at which the management service is responding at

This option is used and documented in the file /etc/beegfs/beegfs-storage.conf

Default: "8008"

conn_mgmtd_port_udp

string

The UDP port at which the management service is responding at

This option is used and documented in the file /etc/beegfs/beegfs-storage.conf

Default: "8008"

conn_rdma_buf_num

string

The RDMA buffer count allocated for the communication

conn_rdma_buf_num * conn_rdma_buf_size

This option is used and documented in the file /etc/beegfs/beegfs-storage.conf

Default: "70"

conn_rdma_buf_size

string

The RDMA buffer size allocated for communication

conn_rdma_buf_num * conn_rdma_buf_size

This option is used and documented in the file /etc/beegfs/beegfs-storage.conf

Default: "8192"

conn_storage_port_tcp

string

The TCP port at which the storage service is responding at

This option is used and documented in the file /etc/beegfs/beegfs-storage.conf

Default: "8013"

conn_storage_port_udp

string

The UDP port at which the storage service is responding at

This option is used and documented in the file /etc/beegfs/beegfs-storage.conf

Default: "8013"

device

string / required

Name of the device that will mount the beegfs storage partition

Note that /dev/ must be omitted because it is already present in the path of the device

log_type

string

Where log entries for the Beegfs management daemon should go

This option is used and documented in the file /etc/beegfs/beegfs-storage.conf

Choices:

  • "syslog" ← (default)

  • "file"

mirrorgroup_id

string

An ID that must be unique among metadata and storage target mirror group definitions

Even if Beegfs allows to have the same ID definition among metadata and storage mirrror groups we do not support it

You must specify the same mirrorgroup id in two and only two storage targets to have a mirror relationship created

The order in which the targets appear in the storaged_server_targets structure defines if these are primaries or secondaries

Default: ""

quota_enable_enforcement

string

Enable the quota enforcement feature

This option is used and documented in the file /etc/beegfs/beegfs-storage.conf

Choices:

  • "false" ← (default)

  • "true"

storagepool_desc

string

A name for the storagepool that the target must be part of

The name must be unique inside the cluster

Default: ""

storagepool_id

string

The storage pool id to assign the storage target

The name must be unique inside the cluster

Default: "1"

sys_mgmtd_host

string

The address at which the management service is responding at

This option is used and documented in the file /etc/beegfs/beegfs-storage.conf

Default: "localhost"

sys_target_offline_timeout_secs

string

Timeout in seconds before the target is considered “Offline”

This option is used and documented in the file /etc/beegfs/beegfs-storage.conf

Default: "180"

target_id

string

The ID to assign to the storage target object

Albeit not required by Beegfs, the ID needs to be unique in the cluster

The ID is used to create the target directory mountpoint `/data/beegfs_storage/t<target_id>`

The ID is used to setup the Buddy Mirror relationship

The ID is used to setup the Storage Pool membership

Default: "1"

tune_file_read_size

string

The file read size from filesystem

This option is used and documented in the file /etc/beegfs/beegfs-storage.conf

Default: "1024k"

tune_file_write_size

string

The file write size on filesystem

This option is used and documented in the file /etc/beegfs/beegfs-storage.conf

Default: "1024k"

tune_num_workers

string

Number of worker threads to assign to the beegfs-storage.service

This option is used and documented in the file /etc/beegfs/beegfs-storage.conf

Default: "12"

storaged_start_services

boolean

Start the `beegfs-storage.service` or `beegfs-storage@.service`

Choices:

  • false

  • true ← (default)

Authors

  • Davide Obbi