configctl#

NAME

configctl -- Manipulate cluster configuration in the backend database.

USAGE

configctl

[-h | --help] [-v | --verbose] [-q | --quiet] [-c | --config CONFIG] [--safe]

DESCRIPTION

This is an advanced configuration tool that directly manipulates the cluster configuration in the backend database. configctl is often used for authentication configuration. Most actions use a key path argument to identify which key(s) to act on. You can provide a list of keys, a comma-separated list of keys, or jq-style period-separated identifiers. For example, auth_config keycloak base_url, auth_config,keycloak,base_url, or auth_config.keycloak.base_url. Provide the value of the key as a comma-separated list.

Top-level keys:

  • auth_config: Typically used for Keycloak integration. Sets the base URL for the Keycloak server, the auth secret to communicate with the Keycloak server, and so on.

  • role_config: List of roles and set of permissions for each role.

  • accept_new_nodes: Sets method for accepting new nodes. When set to False, only nodes with known MAC addresses are sent an IP address to join the cluster. When set to True, any node requesting an IP address can join the cluster. Set to False by default.

  • aim_config: Stores values related to ICE ClusterWare AIM Service.

  • db_version: DO NOT MODIFY. Set by ClusterWare software.

  • default_distro: Default distribution used in image creation.

  • default_group: UID of the attribute group used as the default group for all nodes.

  • naming: Default naming pool pattern.

The tool resides in /opt/scyld/clusterware/bin/configctl and must be executed by user root.

OPTIONAL ARGUMENTS

-h, --help

Print usage message and exit. Ignore trailing args, parse and ignore preceding args.

-v, --verbose

Increase verbosity.

-q, --quiet

Decrease verbosity.

-c, --config CONFIG

Specify a client configuration file CONFIG.

--safe

"Safe" mode: only allow overwriting of leaf entries

DATABASE ACTIONS

show

Show all of the values in the cluster configuration.

dump

Dump all cluster configuration information (compact output).

get

Get the value of a key.

set

Set the value of a key. If they key does not exist, set creates the key and sets the value. Use with -x to force exit if the key does not exist.

clear

Clear (delete) the value of a key.

EXAMPLES

configctl get 'auth_config,keycloak,base_url'

Get the value of the base_url key, which is nested under auth_config and keycloak.

configctl set auth_config.keycloak.base_url=http://10.2.3.4:8080

Set the value of the Keycloak base URL.

RETURN VALUES

Upon successful completion, configctl returns 0. On failure, an error message is printed to stderr and configctl returns 1.