Skip to content
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.

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

op-guide: add advertise-address to TiDB configuration #543

Merged
merged 4 commits into from
Aug 6, 2018
Merged
Changes from 1 commit
Commits
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
6 changes: 6 additions & 0 deletions op-guide/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ TiDB, TiKV and PD are configurable using command-line flags and environment vari

The default TiDB ports are 4000 for client requests and 10080 for status report.

### `--advertise-address`

- The IP address that advertise the TiDB server.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-> The IP address used to access the TiDB server

- Default: ""
- TiDB will store some information to PD such as `advertise-address`. Please make sure `advertise-address` is a public IP, such as 172.16.30.8, Otherwise `advertise-address` will be meaningless.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update this sentence to the following version (pay attention to extra whitespaces):

TiDB stores some information to PD, such as advertise-address. Make sure advertise-address is a public IP, such as 172.16.30.8. Otherwise, advertise-address is meaningless.


Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

172.16.0.0/12 is a private IP network segment.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can reference kubernetes document about advertise-address https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/

### `--binlog-socket`

- The TiDB services use the unix socket file for internal connections, such as the Pump service
Expand Down