cloud-configurations

Warning

The commands listed in this section are for internal use by CrateDB Cloud sysadmins (superusers) only. They are listed here only to clarify their function, since they appear in the full commands list available under --help.

The cloud-configurations command allows you to list, get and set configuration keys of CrateDB Cloud.

Usage: croud cloud-configurations [-h] {set,get,list} ...

cloud-configurations list

Note

This command is only available for superusers.

List all configurations of CrateDB Cloud. Optionally it returns organization or user specific values.

Usage: croud cloud-configurations list [-h] [--org-id ORG_ID]
                                       [--user-id USER_ID] [--region REGION]
                                       [--output-fmt {table,wide,json,yaml}]
                                       [--sudo]

Optional Arguments

--org-id

Optionally get the values for a certain organization. Defaults to the global configuration values.

--user-id

Optionally get the values for a certain user. Defaults to the global configuration values.

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ croud cloud-configurations list \
    --org-id f6c39580-5719-431d-a508-0cee4f9e8209 --sudo
+-------------------------------------------------+-------------+--------------------------------------+-----------+
| key                                             | value       | organization_id                      | user_id   |
|-------------------------------------------------+-------------+--------------------------------------|-----------|
| CRATEDB_CLOUD_SETTING_ONE                       | 100         |                                      |           |
| CRATEDB_CLOUD_SETTING_ORG_SPECIFIC              | 1024        | f6c39580-5719-431d-a508-0cee4f9e8209 |           |
| CRATEDB_CLOUD_SETTING_THREE                     | 30          |                                      |           |
+-------------------------------------------------+-------------+--------------------------------------+-----------+

cloud-configurations get

Note

This command is only available for superusers.

Get a single configuration value. Optionally it returns the organization or user specific value.

Usage: croud cloud-configurations get [-h] --key KEY [--org-id ORG_ID]
                                      [--user-id USER_ID] [--region REGION]
                                      [--output-fmt {table,wide,json,yaml}]
                                      [--sudo]

Required Arguments

--key

The configuration key to get.

Optional Arguments

--org-id

Optionally get the value for a certain organization. Defaults to the global configuration value.

--user-id

Optionally get the value for a certain user. Defaults to the global configuration value.

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ croud cloud-configurations get \
    --key CRATEDB_CLOUD_SETTING_ORG_SPECIFIC \
    --org-id f6c39580-5719-431d-a508-0cee4f9e8209 \
    --sudo
+-------------------------------------------------+-------------+--------------------------------------+-----------+
| key                                             | value       | organization_id                      | user_id   |
|-------------------------------------------------+-------------+--------------------------------------|-----------|
| CRATEDB_CLOUD_SETTING_ORG_SPECIFIC              | 1024        | f6c39580-5719-431d-a508-0cee4f9e8209 |           |
+-------------------------------------------------+-------------+--------------------------------------+-----------+

cloud-configurations set

Note

This command is only available for superusers.

Set a configuration value of CrateDB Cloud either globally or for a single organization or user only.

Usage: croud cloud-configurations set [-h] --key KEY --value VALUE
                                      [--org-id ORG_ID] [--user-id USER_ID]
                                      [--region REGION]
                                      [--output-fmt {table,wide,json,yaml}]
                                      [--sudo]

Required Arguments

--key

The configuration key to set.

--value

The configuration value to use.

Optional Arguments

--org-id

Override the value for a single organization only.

--user-id

Override the value for a single user only.

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ croud cloud-configurations set \
    --key CRATEDB_CLOUD_SETTING_ORG_SPECIFIC \
    --value 2048 \
    --org-id f6c39580-5719-431d-a508-0cee4f9e8209 \
    --sudo
+-------------------------------------------------+-------------+--------------------------------------+-----------+
| key                                             | value       | organization_id                      | user_id   |
|-------------------------------------------------+-------------+--------------------------------------|-----------|
| CRATEDB_CLOUD_SETTING_ORG_SPECIFIC              | 2048        | f6c39580-5719-431d-a508-0cee4f9e8209 |           |
+-------------------------------------------------+-------------+--------------------------------------+-----------+
==> Success: Configuration updated.