Summary:
Runtime config command:
```
./yba runtime-config
Manage YugabyteDB Anywhere runtime configurations
Usage:
yba runtime-config [flags]
yba runtime-config [command]
Aliases:
runtime-config, runtime-configuration, runtime
Available Commands:
key-info Get information about runtime configuration keys
scope Get information about runtime configuration scope
Flags:
-h, --help help for runtime-config
Global Flags:
-a, --apiToken string YugabyteDB Anywhere api token.
--config string Config file, defaults to $HOME/.yba-cli.yaml
--debug Use debug mode, same as --logLevel debug.
--disable-color Disable colors in output. (default false)
-H, --host string YugabyteDB Anywhere Host (default "http://localhost:9000")
-l, --logLevel string Select the desired log level format. Allowed values: debug, info, warn, error, fatal. (default "info")
-o, --output string Select the desired output format. Allowed values: table, json, pretty. (default "table")
--timeout duration Wait command timeout, example: 5m, 1h. (default 168h0m0s)
--wait Wait until the task is completed, otherwise it will exit immediately. (default true)```
Key Info command:
```
./yba runtime-config key-info
Get information about runtime configuration keys
Usage:
yba runtime-config key-info [flags]
yba runtime-config key-info [command]
Available Commands:
describe Describe a YugabyteDB Anywhere runtime configuration key info
list List runtime configuration key info
Flags:
-h, --help help for key-info
Global Flags:
-a, --apiToken string YugabyteDB Anywhere api token.
--config string Config file, defaults to $HOME/.yba-cli.yaml
--debug Use debug mode, same as --logLevel debug.
--disable-color Disable colors in output. (default false)
-H, --host string YugabyteDB Anywhere Host (default "http://localhost:9000")
-l, --logLevel string Select the desired log level format. Allowed values: debug, info, warn, error, fatal. (default "info")
-o, --output string Select the desired output format. Allowed values: table, json, pretty. (default "table")
--timeout duration Wait command timeout, example: 5m, 1h. (default 168h0m0s)
--wait Wait until the task is completed, otherwise it will exit immediately. (default true)
```
Key info list:
```
./yba runtime-config key-info list
List runtime configuration key info
Usage:
yba runtime-config key-info list [flags]
Aliases:
list, ls
Examples:
yba runtime-config key-info list
Flags:
-h, --help help for list
```
Key info get
```
./yba runtime-config key-info describe
Describe a runtime configuration key info in YugabyteDB Anywhere
Usage:
yba runtime-config key-info describe [flags]
Aliases:
describe, get
Examples:
yba runtime-config key-info describe --name <key>
Flags:
-n, --name string [Required] The key to be described.
-h, --help help for describe
```
Scope commands:
```
./yba runtime-config scope
Get information about runtime configuration scope
Usage:
yba runtime-config scope [flags]
yba runtime-config scope [command]
Available Commands:
describe Describe a YugabyteDB Anywhere runtime configuration scope
key Manage YugabyteDB Anywhere runtime configuration scope keys
list List runtime configuration scopes
Flags:
-h, --help help for scope
```
List scope:
```
./yba runtime-config scope list
List runtime configuration scopes
Usage:
yba runtime-config scope list [flags]
Aliases:
list, ls
Examples:
yba runtime-config scope list
Flags:
-h, --help help for list
```
Get scope conf entries
```
./yba runtime-config scope describe
Describe a runtime configuration scope in YugabyteDB Anywhere and list all configurations under it.
Usage:
yba runtime-config scope describe [flags]
Aliases:
describe, get
Examples:
yba runtime-config scope describe --uuid <scope>
Flags:
-u, --uuid string [Required] The scope UUID to be described.
-h, --help help for describe
```
Key commands:
```
./yba runtime-config scope key
Manage YugabyteDB Anywhere runtime configuration scope keys
Usage:
yba runtime-config scope key [flags]
yba runtime-config scope key [command]
Available Commands:
delete Delete a YugabyteDB Anywhere runtime configuration scope key value
get Get a YugabyteDB Anywhere runtime configuration scope key value
set Set a YugabyteDB Anywhere runtime configuration scope key value
Flags:
-h, --help help for key
```
Get key
```
./yba runtime-config scope key get
Get a runtime configuration scope key value in YugabyteDB Anywhere
Usage:
yba runtime-config scope key get [flags]
Aliases:
get, fetch
Examples:
yba runtime-config scope key get --uuid <scope> --name <key-name>
Flags:
-u, --uuid string [Required] The scope UUID of the key to be fetched.
-n, --name string [Required] The key name to be fetched.
-h, --help help for get
```
Set key:
```
./yba runtime-config scope key set
Set a runtime configuration scope key value in YugabyteDB Anywhere
Usage:
yba runtime-config scope key set [flags]
Aliases:
set, put
Examples:
yba runtime-config scope key set --uuid <scope> --name <key-name> --value <value>
Flags:
-u, --uuid string [Required] The scope UUID of the key to be set.
-n, --name string [Required] The key name to be set.
-v, --value string [Required] The value to be set.
-h, --help help for set
```
Delete key:
```
./yba runtime-config scope key delete
Delete a runtime configuration scope key value in YugabyteDB Anywhere
Usage:
yba runtime-config scope key delete [flags]
Aliases:
delete, remove, rm
Examples:
yba runtime-config scope key delete --uuid <scope> --name <key-name> --value <value>
Flags:
-u, --uuid string [Required] The scope UUID of the key to be deleted.
-n, --name string [Required] The key name to be deleted.
-h, --help help for delete
```
Test Plan:
List key info:
`./yba runtime-config key-info list`
```
Key Name Scope Data Type
yb.taskGC.task_retention_duration Task Garbage Collection Retention Duration CUSTOMER Duration
yb.cloud.enabled Cloud Enabled CUSTOMER Boolean
yb.universe.auth.is_enforced Enforce Auth CUSTOMER Boolean
yb.ui.enable_dedicated_nodes Enable dedicated nodes CUSTOMER Boolean
yb.customer_task_db_query_limit Max Number of Customer Tasks to fetch CUSTOMER Integer
yb.proxy_endpoint_timeout Proxy Endpoint Timeout CUSTOMER Duration
yb.perf_advisor.cleanup.rec_retention_duration Perf Recommendation Collection Retention Duration CUSTOMER Duration
yb.perf_advisor.cleanup.pa_run_retention_duration Perf Advisor Run Retention Duration CUSTOMER Duration
yb.ui.show_cost Show costs in UI CUSTOMER Boolean
yb.releases.download_helm_chart_http_timeout Helm chart http download timeout CUSTOMER Duration
yb.ui.metrics.enable_download_pdf Enable downloading metrics as a PDF CUSTOMER Boolean
yb.ui.feature_flags.provider_redesign Use Redesigned Provider UI CUSTOMER Boolean
yb.ui.feature_flags.edit_in_use_provider Enable partial editing of in use providers CUSTOMER Boolean
yb.ui.xcluster.dr.show_xcluster_config Show underlying xCluster configs from DR setup CUSTOMER Boolean
yb.ui.xcluster.enable_skip_bootstrapping Enable the option to skip creating a full copy for xCluster operations CUSTOMER Boolean
yb.universe.user_tags.is_enforced Enforce User Tags CUSTOMER Boolean
yb.universe.user_tags.enforced_tags Enforced User Tags List CUSTOMER Key Value SetMultimap
yb.aws.enable_imdsv2_support Enable IMDSv2 CUSTOMER Boolean
yb.ui.feature_flags.enable_troubleshooting Enables Troubleshooting for the Universe CUSTOMER Boolean
yb.backupGC.number_of_retries Backup Garbage Collector Number of Retries CUSTOMER Integer
yb.tls.enable_config_validation Enable Certificate Config Validation CUSTOMER Boolean
yb.metrics.default_points Default Metric Graph Point Count CUSTOMER Integer
yb.task_info_db_query_batch_size Fetch Batch Size of Task Info CUSTOMER Integer
yb.internal.allow_unsupported_instances Allow Unsupported Instances PROVIDER Boolean
```
Key info get
`./yba runtime-config key-info describe -n yb.internal.allow_unsupported_instances`
```
General
Key Name Scope Data Type
yb.internal.allow_unsupported_instances Allow Unsupported Instances PROVIDER Boolean
Key Info Details
Tags Help Text
PUBLIC Enabling removes supported instance type filtering on AWS providers.
```
List Scope:
`./yba runtime-config scope list `
```
UUID Type Mutable Scope
00000000-0000-0000-0000-000000000000 GLOBAL true
f33e3c9b-75ab-4c30-80ad-cba85646ea39 CUSTOMER true
3dc8045b-7a33-4148-b521-b662b5fb9896 PROVIDER true
cb745e57-3c78-4675-bdd0-33a92e079dd3 PROVIDER true
133fc4a0-758d-4130-a82c-14aa1aa0e1ed PROVIDER true
d68fef15-df24-4ca0-992a-90d51c5ffb11 PROVIDER true
0f032006-e898-4a66-ac59-b4f8b17f1187 PROVIDER true
42106807-d197-462f-82f5-6cd70929ac3d PROVIDER true
78c2dbf9-6694-4136-afac-3c2207254db2 PROVIDER true
e72e5a7b-4ae1-4d8f-8988-1d4fb2ee659e PROVIDER true
d93ea39b-f660-4d8d-b103-4687272e8e75 PROVIDER true
```
Get scope entries
`./yba runtime-config scope describe -u 00000000-0000-0000-0000-000000000000`
```
General
UUID Type Mutable Scope
00000000-0000-0000-0000-000000000000 GLOBAL true
Configuration Entries
Config Entry 1: Details
Inherited Key Value
false yb.user.disable_v1_api_token true
```
Reviewers: sneelakantan, asharma
Reviewed By: asharma
Subscribers: yugaware
Differential Revision: https://phorge.dev.yugabyte.com/D39757
