Administrate the System Configuration¶

The configuration of SEAL Operator is kept in the Consul key value store and can be administrated by SEAL Operator CLI. Below the most common commands and options are being described.

Hint - best practise

Always export the current configuration of SEAL Operator before you attempt any changes. Make changes to the exported file and re-import the changed settings. This way you can be sure the current configuration is being used as basis.

Alternatively, you can use the Consul to change the SEAL Operator configuration.

Commands¶

export¶

The command exports the current configuration of SEAL Operator into a YAML file.

command: export
parameter: relative or absolute path and file name where to save the configuration in
example:
```
operator config export <filename>.yml
```

get¶

The command reads the value for the system key given as parameter. If no file destination is given output goes to stdout.

command: get
parameter: name of the key, f.e. ALLOWED_OIDC_CLIENTS

example:

operator config get ALLOWED_OIDC_CLIENTS --file data.txt

import¶

The command imports the configuration from the specified YAML file into the Consul key value store.

command: import
parameter: relative or absolute path and file name of the YAML file you want to import
example:
```
operator config import <filename>.yml
```

set¶

The command sets the value for the system key given as parameter from the file specified by the --file option.

command: set
parameter: name of the key, f.e. ALLOWED_OIDC_CLIENTS

example:

operator config set ALLOWED_OIDC_CLIENTS --file changed_template.json

template¶

The command generates a JSON template for the key given as parameter. The template will be saved to the file specified by the --file option. If no file is specified, the output will go to stdout. The changed template can be set as value by the command set.

command: template
parameter: ALLOWED_OIDC_CLIENTS

example:

operator config template ALLOWED_OIDC_CLIENTS --file template.json

Hint - difference between template and get

The template command will always just generate a template without consideration of the current value of the key. If you want to get the current value of the key, use the get command instead.

Options¶

--file¶

This option specifies the file where the output is to be saved or the input to be taken from. Available for get, set and template commands.

option: --file

example:

operator config template ALLOWED_OIDC_CLIENTS --file template.json

--insecure¶

By specifying the --insecure option, the certificate won't be checked by the client. This is especially helpful when using self-signed certificates.

option: --insecure
example:
```
operator config <command> --insecure
```

--purge¶

When this option is used with the import command the old configuration will be deleted before the import.

option: --purge

example:

operator config import <filename>.yml --purge

--token¶

If the Consul key value store has been secured by a token, specify the token with this option. By default, no token is used. For more information about the token, refer to CONSUL_TOKEN.

option: --token
example: Export the configuration from a secured Consul key value store
```
operator config export <filename>.yml --token <consul_token>
```