summaryrefslogtreecommitdiffstats
path: root/docs/part-2/3_xds-cli/1_config.md
blob: 82506ee377d49b1f34e984e58093b6bc26e7d3fc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# Configuration

`xds-cli` configuration is defined either by environment variables or by
setting command line options.

Configuration through environment variables may also be defined in a file that
will be sourced by `xds-cli` on start-up.

Use `--config|-c` option or set `XDS_CONFIG` environment variable to specify the config file to use.

So configuration is driven either by environment variables or by command line
options or using a config file knowing that the following priority order is used:

1. use option value (for example use project ID set by `--id` option),
1. else use variable `XDS_xxx` (for example `XDS_PROJECT_ID` variable) when a
   config file is specified with `--config|-c` option,
1. else use `XDS_xxx` (for example `XDS_PROJECT_ID`) environment variable

<!-- section-note -->
**Note:**

All parameters after a double dash (--) are considered as the command
to execute on xds-server.
<!-- end-section-note -->

## Global Options / Configuration variables

Following is the list of global options across all sub-commands.

__`--config|-c` option or `XDS_CONFIG` env variable__

Env config file to source on startup

__`--log|-l` option or `XDS_LOGLEVEL` env variable__

Logging level, supported levels are:

- panic
- fatal
- error
- warn
- info
- debug

Default level is "error".

**`--rpath` option or `XDS_PATH` env variable**

Relative path into project

**`timestamp|-ts` option or `XDS_TIMESTAMP` env variable**

Prefix output with timestamp

**`url` option or `XDS_AGENT_URL` env variable**

Local XDS agent url (default: "localhost:8800")