mahendrapaipuri.ansible.ceems_exporter role – CEEMS Exporter

Note

This role is part of the mahendrapaipuri.ansible collection (version 0.3.2).

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 mahendrapaipuri.ansible.

To use it in a playbook, specify: mahendrapaipuri.ansible.ceems_exporter.

Entry point main – CEEMS Exporter

Synopsis

Parameters

Parameter

Comments

ceems_exporter_basic_auth_users

dictionary

Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.

ceems_exporter_binary_install_dir

string

Advanced

Directory to install ceems_exporter binary

Default: "/usr/local/bin"

ceems_exporter_binary_local_dir

string

Enables the use of local packages instead of those distributed on github.

The parameter may be set to a directory where the ceems_exporter binary is stored on the host where ansible is run.

This overrides the ceems_exporter_version parameter

ceems_exporter_binary_url

string

URL of the ceems exporter binaries .tar.gz file

Default: "https://github.com/{{ _ceems_exporter_repo }}/releases/download/v{{ ceems_exporter_version }}/ceems-{{ ceems_exporter_version }}.linux-{{ go_arch }}.tar.gz"

ceems_exporter_checksums_url

string

URL of the ceems exporter checksums file

Default: "https://github.com/{{ _ceems_exporter_repo }}/releases/download/v{{ ceems_exporter_version }}/sha256sums.txt"

ceems_exporter_cli_args

list / elements=string

Advanced

Additional CLI arguments that will be passed to CEEMS exporter

ceems_exporter_create_system_user_group

string

Advanced

Create system user and group for CEEMS exporter

Default: true

ceems_exporter_create_unique_jobids

string

Unique job IDs will be created based on SLURM job properties.

If SLURM epilog scripts are used, ceems_exporter_slurm_job_props_dir should be set to find files that contain job properties.

Default: false

ceems_exporter_disabled_collectors

list / elements=string

List of disabled collectors.

By default ceems_exporter disables collectors listed here.

ceems_exporter_emissions_country_code

string

ISO 3166-1 alpha-3 Country code to export emission data.

Default: "FR"

ceems_exporter_enabled_collectors

list / elements=string

List of dicts defining additionally enabled collectors and their configuration.

It adds collectors to those enabled by default.

Default: []

ceems_exporter_env_vars

dictionary

Advanced

Dict of environment variables that will be injected into systemd unit file

ceems_exporter_gpu_job_map_dir

string

Directory where files containing mapping of SLURM job ID to GPU ordinals are created by Epilog scripts.

Check the example scripts.

Default: ""

ceems_exporter_gpu_type

string

GPU type.

Currently, nVIDIA and AMD GPUs are supported.

Default: ""

ceems_exporter_http_server_config

dictionary

Config for HTTP/2 support.

Keys and values are the same as in ceems_exporter docs.

ceems_exporter_ipmi_dcmi_cmd

string

Full command to get power statistics from IPMI. Use absolute path to IPMI command.

Custom wrapper commands are also accepted as long as they give expected output.

Default: "sudo /usr/sbin/ipmi-dcmi --get-system-power-statistics"

ceems_exporter_skip_install

boolean

CEEMS exporter installation tasks gets skipped when set to true.

Choices:

  • false ← (default)

  • true

ceems_exporter_slurm_job_props_dir

string

Directory where files containing SLURM job properties are created by Epilog scripts.

Check the example scripts.

Default: ""

ceems_exporter_system_group

string

Advanced

System group for CEEMS exporter

Default: "ceemsexp"

ceems_exporter_system_user

string

Advanced

CEEMS exporter user

Default: "ceemsexp"

ceems_exporter_tls_server_config

dictionary

Configuration for TLS authentication.

Keys and values are the same as in ceems_exporter docs.

ceems_exporter_version

string

CEEMS exporter package version. Also accepts latest as parameter.

Default: "0.1.0"

ceems_exporter_web_listen_address

string

Address on which ceems exporter will listen

Default: "0.0.0.0:9010"

ceems_exporter_web_telemetry_path

string

Path under which to expose metrics

Default: "/metrics"

Authors

  • Mahendra Paipuri