e4_computer_engineering.beegfs.client role – Deploy Beegfs client services

Note

This role is part of the e4_computer_engineering.beegfs collection (version 2.1.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.client.

Entry point main – Deploy Beegfs client services

New in e4_computer_engineering.beegfs 1.0.0

Synopsis

  • Install and configure Beegfs client services for single and multi cluster environments.

Parameters

Parameter

Comments

client_auth_file_path

string

The path to the authentication file used by the client

The file is used to authenticate the client with the management service

Default: "/etc/beegfs/conn.auth"

client_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.0"

client_build_kernel_modules

boolean

Build the client kernel modules

Choices:

  • false

  • true ← (default)

client_clusters

list / elements=dictionary

The list of clusters and their parameters for each client instance

client_dir_paths

list / elements=dictionary

The list of directory paths relative to the Beegfs mountpoint with custom striping rules

beegfs_path

string / required

The path relative to the Beegfs mountpoint where the directory should exist

You need the `client_start_services` option set to true to create directories

chunk_size

string

the chunk size set for the specific path relative to the beegfs mountpoint

This parameter is documented here https://doc.beegfs.io/latest/advanced_topics/striping.html

fs_path

string

The path relative to the root filesystem where the directory should be bind mounted

pattern

string

this parameter sets the pattern for the specific path

this parameter is documented in https://doc.beegfs.io/latest/advanced_topics/striping.html

client_tls_tmp_dir

string

path to the TLS certificate needed by Beegfs

Default: ""

conn_client_port_udp

string

The UDP port at which the client service is responding at

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

Default: "8004"

conn_helperd_port_tcp

string

The TCP port at which the helperd service is responding at

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

Default: "8006"

conn_interfaces

list / elements=string

The list of interfaces to use by the daemon

The list is used in the `conn_interfaces_file`

Default: []

conn_max_internode_num

string

The maximum number of internode connections

this option is used and documented in the file /etc/beegfs/beegfs-client.conf

Default: "12"

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-client.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-client.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-client.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-client.conf

Default: "8192"

conn_rdma_meta_buf_num

string

The RDMA meta 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-client.conf

Default: "70"

conn_rdma_meta_buf_size

string

The RDMA meta 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-client.conf

Default: "8192"

quota_enabled

string

Enable the quota enforcement feature

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

Choices:

  • "false" ← (default)

  • "true"

sys_acls_enabled

string

Enable the ACL feature

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

Choices:

  • "false" ← (default)

  • "true"

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-client.conf

Default: "localhost"

sys_xattrs_enabled

string

Enable the storing of extra attributes feature

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

Choices:

  • "false" ← (default)

  • "true"

tune_file_cache_buf_size

string

The cache buffer size on client side

Must accomodate for conn_rdma_buf_num * conn_rdma_buf_size

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

Default: "1048576"

client_dkms_install

boolean

Install the client kernel modules using DKMS

Enabling this option will add the EPEL repo on RHEL like systems

Enabling this option will install the package `beegfs-client-dkms` instead of `beegfs-client`

For more information https://doc.beegfs.io/latest/advanced_topics/client_dkms.html

Choices:

  • false ← (default)

  • true

client_enable_beeond

boolean

install Beegfs Beeond packages on the node

Choices:

  • false ← (default)

  • true

client_install_kernel_dev

boolean

Install the kernel development packages

Needed to build the client kernel modules

If the kernel* is filtered out from package manager, it breaks the Ansible module

Choices:

  • false

  • true ← (default)

client_ofed_libs_path

string

The filesystem path where the OFED kernel libraries are located

Needed by the client to build with RDMA support

client_start_services

boolean

Start the `beegfs-client|neegfs-helperd.service` or `beegfs-client|beegfs-helperd@.service`

If set to false, it won’t be possible to create directories in the Beegfs mountpoint

Choices:

  • false

  • true ← (default)

Authors

  • Davide Obbi