Skip to content

Update command-line-flags-for-tikv-configuration.md (#2943) #3115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ti-srebot merged 2 commits into from
Jul 2, 2020
Merged

Update command-line-flags-for-tikv-configuration.md (#2943) #3115

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44549b0
cherry pick #2943 to release-4.0
TomShawn Jul 2, 2020
7fe4ee6
Merge branch 'release-4.0' into release-4.0-ac39a14a58c6
ti-srebot Jul 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion command-line-flags-for-tikv-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,23 @@ TiKV supports some readable unit conversions for command line parameters.

- The server advertise address for client traffic from outside
- Default: ${addr}
- If the client cannot connect to TiKV through the default monitoring address because of Docker or NAT network, you must manually set the advertise address explicitly.
- If the client cannot connect to TiKV through the `--addr` address because of Docker or NAT network, you must manually set the `--advertise-addr` address.
- For example, the internal IP address of Docker is 172.17.0.1, while the IP address of the host is 192.168.100.113 and the port mapping is set to `-p 20160:20160`. In this case, you can set `--advertise-addr` to "192.168.100.113:20160". The client can find this service through 192.168.100.113:20160.

## `--status-addr`

+ The port through which the TiKV service status is listened
+ Default: "20180"
+ The Prometheus can access this status information via `http://host:status_port/metrics`.
+ The Profile can access this status information via `http://host:status_port/debug/pprof/profile`.

## `--advertise-status-addr`

- The address through which TiKV accesses service status from outside.
- Default: The value of `--status-addr` is used.
- If the client cannot connect to TiKV through the `--status-addr` address because of Docker or NAT network, you must manually set the `--advertise-status-addr` address.
- For example, the internal IP address of Docker is `172.17.0.1`, while the IP address of the host is `192.168.100.113` and the port mapping is set to `-p 20180:20180`. In this case, set `\-\-advertise-status-addr="192.168.100.113:20180"`. The client can find this service through `192.168.100.113:20180`.

## `-C, --config`

- The config file
Expand Down