mahendrapaipuri.ansible.ceems_api_server role – CEEMS API Server

Note

This role is part of the mahendrapaipuri.ansible collection (version 0.4.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_api_server.

Entry point main – CEEMS API Server

Synopsis

Parameters

Parameter

Comments

ceems_api_server_basic_auth_users

dictionary

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

ceems_api_server_binary_install_dir

string

Advanced

Directory to install CEEMS API server binary

Default: "/usr/local/bin"

ceems_api_server_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_api_server binary is stored on the host where ansible is run.

This overrides the ceems_api_server_version parameter

ceems_api_server_binary_url

string

URL of the ceems API server binaries .tar.gz file

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

ceems_api_server_checksums_url

string

URL of the ceems API server checksums file

Default: "https://github.com/{{ _ceems_api_server_repo }}/releases/download/v{{ ceems_api_server_version }}/sha256sums.txt"

ceems_api_server_cli_args

list / elements=string

Advanced

Additional CLI arguments that will be passed to CEEMS API server

ceems_api_server_clusters_config

list / elements=dictionary

List of clusters that are monitored by CEEMS.

Each element in list be of `cluster_config`

ceems_api_server_config

dictionary / required

CEEMS API server config. Configuration under key `ceems_api_server` docs

These files include the SQLite database.

ceems_api_server_create_system_user_group

string

Advanced

Create system user and group for CEEMS API server

Default: true

ceems_api_server_env_vars

dictionary

Advanced

Environment variables will be passed to CEEMS API server

ceems_api_server_http_server_config

dictionary

Config for HTTP/2 support.

Keys and values are the same as in ceems_api_server docs.

ceems_api_server_skip_install

boolean

CEEMS API server installation tasks gets skipped when set to true.

Choices:

  • false ← (default)

  • true

ceems_api_server_system_group

string

Advanced

System group for CEEMS API server server

Default: "ceems"

ceems_api_server_system_user

string

Advanced

CEEMS API server user

Default: "ceems"

ceems_api_server_tls_server_config

dictionary

Configuration for TLS authentication.

Keys and values are the same as in ceems_api_server docs.

ceems_api_server_updaters_config

list / elements=dictionary

List of updaters used by CEEMS.

Each element in list be of `updater_config`

ceems_api_server_version

string

CEEMS API server package version. Also accepts latest as parameter.

Default: "0.4.1"

ceems_api_server_web_listen_address

string

Address on which ceems API server will listen

Default: "0.0.0.0:9020"

Authors

  • Mahendra Paipuri