mahendrapaipuri.ansible.ceems_api_server role – CEEMS API Server

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_api_server.

Entry point main – CEEMS API Server

Synopsis

Parameters

Parameter

Comments

ceems_api_server_admin_users

list / elements=string

List of admin users for ceems API server.

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_create_system_user_group

string

Advanced

Create system user and group for CEEMS API server

Default: true

ceems_api_server_data_backup_interval

string

A DB backup will be created at this interval.

Units Supported: y, w, d, h, m, s, ms

Default: ""

ceems_api_server_data_backup_path

string

Directory where DB back ups are stored.

To achieve fault tolerance this directory should be on a different physical disk than actual DB or on a network file system.

Default: ""

ceems_api_server_data_path

string

Directory where data files of ceems API server are created.

These files include the SQLite database.

Default: "/var/lib/ceems"

ceems_api_server_data_retention_period

string

Compute unit data will be retained for this period in the DB.

Units Supported: y, w, d, h, m, s, ms

Default: "1y"

ceems_api_server_data_update_interval

string

DB will be updated from backend batch scheduler at this interval.

This must be not too small nor too large. Use based on your platform job churn.

Units Supported: y, w, d, h, m, s, ms

Default: "15m"

ceems_api_server_env_vars

dictionary

Advanced

Environment variables will be passed to CEEMS API server

ceems_api_server_extra_configs

dictionary

Advanced

Extra configuration files for CEEMS API server. These files will be created in CEEMS API server config dir with the same name as key of the argument dict.

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_resource_manager

string

Name of the backend resource manager.

Currently only SLURM is supported.

Choices:

  • "slurm" ← (default)

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_version

string

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

Default: "0.1.0"

ceems_api_server_web_listen_address

string

Address on which ceems API server will listen

Default: "0.0.0.0:9020"

Authors

  • Mahendra Paipuri