Configuration via CLI

1
$ ais config --help
2
NAME:
3
   ais config - Configure AIS cluster and individual nodes (in the cluster); configure CLI (tool)
4
5
USAGE:
6
   ais config command [arguments...] [command options]
7
8
COMMANDS:
9
   show     show CLI, cluster, or node configurations (nodes inherit cluster and have local)
10
   cluster  configure AIS cluster
11
   node     configure AIS node
12
   reset    reset (cluster | node | CLI) configuration to system defaults
13
   cli      display and change AIS CLI configuration
14
15
OPTIONS:
16
   --help, -h  show help

1
$ ais config cluster --help
2
NAME:
3
   ais config cluster - Configure AIS cluster.
4
   Examples:
5
     - 'ais config cluster --json'                    - show entire cluster config in JSON;
6
     - 'ais config cluster log'                       - show 'log' section;
7
     - 'ais config cluster log.level 4'               - set log level to 4;
8
     - 'ais config cluster log.modules ec xs'         - elevate verbosity for selected modules;
9
     - 'ais config cluster features S3-API-via-Root'  - enable feature flag;
10
     - 'ais config cluster features none'             - reset all feature flags;
11
     - 'ais config cluster log.modules none'          - reset log modules
12
13
USAGE:
14
   ais config cluster KEY=VALUE [KEY=VALUE...] [command options]
15
16
OPTIONS:
17
   --json, -j   JSON input/output
18
   --transient  Update config in memory without storing the change(s) on disk
19
   --help, -h   Show help

1
$ ais config node --help
2
NAME:
3
   ais config node - Configure AIS node.
4
   Each node in the cluster has 'inherited' (from cluster config) and 'local' configuration.
5
   Nodes can override inherited defaults with local values; use caution: local changes
6
   may cause inconsistent behavior across the cluster. Examples:
7
     - 'ais config node NODE local --json'              - show node's local config in JSON;
8
     - 'ais config node NODE inherited log'             - show 'log' section (inherited);
9
     - 'ais config node NODE local host_net --json'     - show node's network config;
10
     - 'ais config node NODE log.level 4'               - set node's log level;
11
     - 'ais config node NODE log.modules none'          - reset log modules;
12
     - 'ais config node NODE disk.iostat_time_long=4s'  - update disk timing (in re: "disk utilization smoothing")
13
14
USAGE:
15
   ais config node NODE_ID KEY=VALUE [KEY=VALUE...] [command options]
16
17
OPTIONS:
18
   --json, -j   JSON input/output
19
   --transient  Update config in memory without storing the change(s) on disk
20
   --help, -h   Show help

1
# show `ais config` subcommands:
2
$ ais config <TAB-TAB>
3
cli    cluster    node    reset    show

1
# select `cluster` configuration and see usage and options
2
$ ais config cluster --help

1
# show the entire cluster configuration in JSON
2
$ ais config cluster --json

1
# show one selected section (e.g., checksum) from the cluster config
2
$ ais config cluster checksum

1
# update one value (e.g., checksum type)
2
$ ais config cluster checksum.type=md5
3
4
# same using JSON-formatted values
5
$ ais config cluster checksum.type='{"type":"md5"}'

1
$ ais config cluster log.level 4
2
PROPERTY         VALUE
3
log.level        4
4
log.max_size     4MiB
5
log.max_total    128MiB
6
log.flush_time   40s
7
log.stats_time   1m
8
log.to_stderr    false
9
10
Cluster config updated
11
12
$ ais config cluster log.modules <TAB-TAB>
13
transport    memsys       fs           ec           ios          backend      mirror       downloader   s3
14
ais          cluster      reb          stats        xs           space        dsort        etl          none
15
16
$ ais config cluster log.modules space,s3
17
PROPERTY         VALUE
18
log.level        4 (modules: space,s3)
19
log.max_size     4MiB
20
log.max_total    128MiB
21
log.flush_time   40s
22
log.stats_time   1m
23
log.to_stderr    false
24
25
Cluster config updated

1
$ ais config cluster ec
2
PROPERTY                 VALUE
3
ec.objsize_limit         262144
4
ec.compression           never
5
ec.bundle_multiplier     2
6
ec.data_slices           1
7
ec.parity_slices         1
8
ec.enabled               false
9
ec.disk_only             false
10
11
# same in JSON:
12
13
$ ais config cluster ec --json
14
15
    "ec": {
16
        "objsize_limit": 262144,
17
        "compression": "never",
18
        "bundle_multiplier": 2,
19
        "data_slices": 1,
20
        "parity_slices": 1,
21
        "enabled": false,
22
        "disk_only": false
23
    }

1
# Select what to show: CLI config, cluster config, or any node's config:
2
3
$ ais show config <TAB-TAB>
4
cli           cluster       p[kdQp8080]   t[NBzt8081]

1
# For cluster config, use `TAB` completion to select a named section, or press Enter:
2
3
$ ais show config cluster <TAB-TAB>
4
5
downloader         net                proxy              config_version     keepalivetracker
6
checksum           disk               arch               tracing            fshc
7
ec                 get_batch          rebalance          tcb                resilver
8
transport          uuid               timeout            tco                ext
9
features           rate_limit         space              memsys             auth
10
versioning         log                lru                lastupdate_time    mirror
11
write_policy       chunks             client             distributed_sort   periodic

1
$ ais show config cluster --help
2
NAME:
3
   ais show config - show CLI, cluster, or node configurations (nodes inherit cluster and have local)
4
5
USAGE:
6
   ais show config cli | cluster [CONFIG SECTION OR PREFIX] | [command options]
7
      NODE_ID [ inherited | local | all [CONFIG SECTION OR PREFIX ] ]
8
9
OPTIONS:
10
   --json, -j  json input/output
11
   --help, -h  show help

1
# For a specific node, choose inherited, local, or both:
2
3
$ ais show config t[NBzt8081] <TAB-TAB>
4
inherited   local

1
$ ais show config CASGt8088 local
2
PROPERTY                         VALUE
3
confdir                          /home/divaturi/.ais8
4
log_dir                          /tmp/ais/8/log
5
host_net.hostname
6
host_net.hostname_intra_control
7
host_net.hostname_intra_data
8
host_net.port                    8088
9
host_net.port_intra_control      9088
10
host_net.port_intra_data         10088
11
fspaths.paths                    /tmp/ais/mp1/8,/tmp/ais/mp2/8,/tmp/ais/mp3/8,/tmp/ais/mp4/8,/tmp/ais/mp5/8
12
test_fspaths.root                /tmp/ais
13
test_fspaths.count               5
14
test_fspaths.instance            8

1
$ ais show config CASGt8088 inherited
2
PROPERTY                                 VALUE                                                           DEFAULT
3
auth.enabled                             false                                                           -
4
auth.secret                              **********                                                      -
5
backend.conf                             map[]                                                           -
6
checksum.enable_read_range               false                                                           -
7
checksum.type                            xxhash                                                          -
8
checksum.validate_cold_get               true                                                            -
9
checksum.validate_obj_move               false                                                           -
10
checksum.validate_warm_get               false                                                           -
11
client.client_long_timeout               30m                                                             -
12
# only 10 lines of output shown

1
$ ais show config cluster lru
2
PROPERTY                 VALUE
3
lru.dont_evict_time      1s
4
lru.capacity_upd_time    10m
5
lru.enabled              true
6
7
$ ais show config cluster space
8
PROPERTY                 VALUE
9
space.cleanupwm          70
10
space.lowwm              80
11
space.highwm             90
12
space.out_of_space       95

1
$ ais config cluster <TAB-TAB>
2
Display all 108 possibilities? (y or n)
3
4
$ ais config cluster timeout.<TAB-TAB>
5
timeout.cplane_operation    timeout.max_host_busy       timeout.send_file_time
6
timeout.join_startup_time   timeout.max_keepalive       timeout.startup_time

1
$ ais config cluster lru.enabled
2
PROPERTY         VALUE
3
lru.enabled      true
4
5
$ ais config cluster lru.enabled=false
6
{
7
    "lru.enabled": "false"
8
}
9
10
Cluster config updated

1
$ ais config cluster periodic.stats_time=10s disk.disk_util_low_wm=40
2
Config has been updated successfully.

1
$ ais config node CMhHp8082 periodic.stats_time=10s disk.disk_util_low_wm=40
2
Config has been updated successfully.

1
# Reset all nodes to cluster defaults:
2
3
$ ais config reset
4
config successfully reset for all nodes

1
# Reset a specific node:
2
3
$ ais config reset CMhHp8082
4
config for node "CMhHp8082" successfully reset

1
$ ais config cli
2
3
PROPERTY                         VALUE
4
aliases                          cp => 'bucket cp'; create => 'bucket create'; evict => 'bucket evict';
5
                                 ls => 'bucket ls'; rmb => 'bucket rm'; start => 'job start';
6
                                 blob-download => 'job start blob-download'; download => 'job start download';
7
                                 dsort => 'job start dsort'; stop => 'job stop'; wait => 'job wait';
8
                                 get => 'object get'; mpu => 'object multipart-upload'; prefetch => 'object prefetch';
9
                                 put => 'object put'; rmo => 'object rm'; space-cleanup => 'storage cleanup';
10
                                 scrub => 'storage validate'
11
auth.url                         http://127.0.0.1:52001
12
cluster.client_ca_tls
13
cluster.client_crt
14
cluster.client_crt_key
15
cluster.default_ais_host         http://127.0.0.1:8080
16
cluster.default_docker_host      http://172.50.0.2:8080
17
cluster.skip_verify_crt          false
18
cluster.url                      http://127.0.0.1:8080
19
default_provider                 ais
20
no_color                         false
21
no_more                          false
22
timeout.http_timeout             0s
23
timeout.tcp_timeout              60s
24
verbose                          false

1
$ ais config cli --path
2
/home/user/.ais/cli/cli.json

1
$ ais config cli timeout.tcp_timeout 61s
2
"timeout.tcp_timeout" set to: "61s" (was: "60s")
3
4
$ ais config cli --json
5
{
6
    "cluster": {
7
        "url": "http://127.0.0.1:8080",
8
        "default_ais_host": "http://127.0.0.1:8080",
9
        "default_docker_host": "http://172.50.0.2:8080",
10
        "client_crt": "",
11
        "client_crt_key": "",
12
        "client_ca_tls": "",
13
        "skip_verify_crt": false
14
    },
15
    "timeout": {
16
        "tcp_timeout": "60s",
17
        "http_timeout": "0s"
18
    },
19
    "auth": {
20
        "url": "http://127.0.0.1:52001"
21
    },
22
    "aliases": {
23
        "wait": "job wait",
24
        "cp": "bucket cp",
25
        "ls": "bucket ls",
26
        "prefetch": "object prefetch",
27
        "rmo": "object rm",
28
        "dsort": "job start dsort",
29
        "get": "object get",
30
        "rmb": "bucket rm",
31
        "start": "job start",
32
        "put": "object put",
33
        "stop": "job stop",
34
        "blob-download": "job start blob-download",
35
        "create": "bucket create",
36
        "download": "job start download",
37
        "evict": "bucket evict"
38
    },
39
    "default_provider": "ais",
40
    "no_color": false,
41
    "verbose": false,
42
    "no_more": false
43
}