e4_computer_engineering.beegfs.mon role – Configure Beegfs Monitoring 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.mon.

Entry point main – Configure Beegfs Monitoring services

New in e4_computer_engineering.beegfs 1.0.0

Synopsis

  • Install and configure Beegfs Monitoring services.

Parameters

Parameter

Comments

mon_auth_file_path

string

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

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

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

mon_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: []

mon_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-mon.conf

Default: "8008"

mon_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-mon.conf

Default: "8008"

mon_db_bucket

string

The name to give to the Influxdb v2 database

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

Default: "beegfs_mon"

mon_db_database

string

The name to give to the Influxdb v1 database

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

Default: "beegfs_mon"

mon_db_host_port

string

The port at which the `mon_db_hostname` is responding

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

Default: "9122"

mon_db_hostname

string

The network address at which the metrics database service is responding

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

Default: "localhost"

mon_db_retention_duration

string

The retention for the data points in Influxdb expressed in the form `^[0-9]+[smhdw]$`

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

Default: "1d"

mon_db_type

string

The database type where Beegfs monitoring service will ship the metrics

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

Choices:

  • "influxdb"

  • "cassandra"

Default: "influxdbv2"

mon_influxdbv1_password

string

The password used to connect to the Influxdb v1 instance

This option is used and documented in the file /etc/beegfs/beegfs-mon.auth

Default: ""

mon_influxdbv1_username

string

The username used to connect to the Influxdb v1 instance

This option is used and documented in the file /etc/beegfs/beegfs-mon.auth

Default: ""

mon_influxdbv2_organization

string

The organization used to connect to the Influxdb v2 instance

This option is used and documented in the file /etc/beegfs/beegfs-mon.auth

Default: ""

mon_influxdbv2_token

string

The token used to connect to the Influxdb v2 instance

This option is used and documented in the file /etc/beegfs/beegfs-mon.auth

Default: ""

mon_log_type

string

Where log entries for the Beegfs monitoring daemon should go

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

Choices:

  • "syslog" ← (default)

  • "file"

mon_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

mon_ship_to_influxdb_exporter

boolean

Send the metrics to the [influxdb_exporter](https://github.com/prometheus/influxdb_exporter)

Choices:

  • false ← (default)

  • true

mon_start_services

boolean

Start the `beegfs-mon.service`

Choices:

  • false ← (default)

  • true

mon_sys_mgmtd_host

string

The network address at which the Beegfs management service is responding

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

Default: "localhost"

Authors

  • Davide Obbi