e4_computer_engineering.beegfs.mgmtd role – Configure Beegfs Management 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.mgmtd.

Entry point main – Configure Beegfs Management services

New in e4_computer_engineering.beegfs 1.0.0

Synopsis

  • Install and configure Beegfs Management services.

Parameters

Parameter

Comments

mgmtd_auth_file_path

string

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

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

mgmtd_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"

mgmtd_conn_interfaces

list / elements=string

The list of interfaces to use by the daemon

The interfaces will be written to the file specified in `mgmtd_conn_interfaces_file`

Default: []

mgmtd_conn_mgmtd_port_tcp

string

The TCP port at which the management service is responding at

This option is documented in /etc/beegfs/beegfs-mgmt.conf or /etc/beegfs/beegfs-mgmtd.toml

Default: "8008"

mgmtd_conn_mgmtd_port_udp

string

The UDP port at which the management service is responding at

This option is documented in /etc/beegfs/beegfs-mgmt.conf or /etc/beegfs/beegfs-mgmtd.toml

Default: "8008"

mgmtd_deploy_auth_file

boolean

Deploy the connection auth file.

See `system_auth_file_path` for specifying the location of the auth file to deploy.

WARNING do not use the authfile provided in this role

Choices:

  • false

  • true ← (default)

mgmtd_enable_tls

boolean

Enable TLS support for gRPC communication in management service

When enabled (true), TLS certificates will be generated and deployed, and tls-disable will be set to false in beegfs-mgmtd.toml

When disabled (false), tls-disable will be set to true in beegfs-mgmtd.toml and certificate files will not be configured

This setting controls the gRPC TLS configuration, not the BeeMsg protocol

Choices:

  • false

  • true ← (default)

mgmtd_license_disable

string

Disable the license requirement for Beegfs Enterprise features

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

Choices:

  • "false" ← (default)

  • "true"

mgmtd_license_file_path

string

The location on local filesystem to deploy the license file from

Only used when license is enabled

Default: "{{ role_path }}/files/license.pem"

mgmtd_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-mgmt.conf

Choices:

  • "syslog" ← (default)

  • "file"

mgmtd_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

mgmtd_quota_enable_enforcement

string

Enable the quota enforcement feature

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

Choices:

  • "false" ← (default)

  • "true"

mgmtd_start_services

boolean

Start the `beegfs-mgmtd.service`

Choices:

  • false

  • true ← (default)

mgmtd_store_mgmtd_directory

string

The filesystem path where the management service will write its data

This option is documented in /etc/beegfs/beegfs-mgmt.conf or /etc/beegfs/beegfs-mgmtd.toml

Default: "/var/lib/beegfs/"

mgmtd_string_id

string

The string ID of the management server

This ID will be used in server-related log messages

To set to a common name in HA configurations where two mgmtd servers work in active/passive

Default: "{{ inventory_hostname_short }}"

mgmtd_sys_target_offline_timeout_secs

string

The timeout in seconds for the system target to be “Offline”

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

Default: "180"

mgmtd_tls_cert_file

string

Name of the TLS certificate file to be created

Default: "cert.pem"

mgmtd_tls_key_file

string

Name of the TLS key file to be created

Default: "cert.key"

mgmtd_tls_tmp_dir

string

Temporary directory for TLS cert and key files to be created on localhost

Default: "/tmp"

Authors

  • Davide Obbi