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.

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

Jump to bottom

*: update some dead links #1543

Merged
merged 2 commits into from May 21, 2019
Merged

*: update some dead links #1543

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a9a75f
update links
rleungx May 20, 2019
24e616c
address comments
rleungx May 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Expand Up @@ -8,7 +8,7 @@

PD is the abbreviation for Placement Driver. It is used to manage and schedule the [TiKV](https://github.com/tikv/tikv) cluster.

PD supports distribution and fault-tolerance by embedding [etcd](https://github.com/etcd-io/etcd).
PD supports distribution and fault-tolerance by embedding [etcd](https://github.com/etcd-io/etcd).

## Build

Expand All @@ -19,11 +19,11 @@ PD supports distribution and fault-tolerance by embedding [etcd](https://github.

### Command flags

See [configuration](https://github.com/pingcap/docs/blob/master/op-guide/configuration.md#placement-driver-pd).
See [configuration](https://github.com/pingcap/docs/blob/master/dev/reference/configuration/pd-server/configuration.md).

### Single Node with default ports

You can run `pd-server` directly on your local machine, if you want to connect to PD from outside,
You can run `pd-server` directly on your local machine, if you want to connect to PD from outside,
you can let PD listen on the host IP.

```bash
Expand Down Expand Up @@ -75,20 +75,20 @@ X-Etcd-Cluster-Id: 33dc747581249309

You can use the following command to build a PD image directly:

```
```sh
Copy link
Contributor

Choose a reason for hiding this comment

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

There are both bash and sh in the doc. Would you like to unify them?

docker build -t pingcap/pd .
```

Or you can also use following command to get PD from Docker hub:

```
```sh
docker pull pingcap/pd
```

Run a single node with Docker:
Run a single node with Docker:

```bash
# Set correct HostIP here.
# Set correct HostIP here.
export HostIP="192.168.199.105"

docker run -d -p 2379:2379 -p 2380:2380 --name pd pingcap/pd \
Expand All @@ -103,9 +103,9 @@ docker run -d -p 2379:2379 -p 2380:2380 --name pd pingcap/pd \

### Cluster

PD is a component in TiDB project, you must run it with TiDB and TiKV together, see
[TiDB-Ansible](https://github.com/pingcap/docs/blob/master/op-guide/ansible-deployment.md) to learn
how to set up the cluster and run them.
PD is a component in TiDB project, you must run it with TiDB and TiKV together, see
[TiDB-Ansible](https://github.com/pingcap/docs/blob/master/dev/how-to/deploy/orchestrated/ansible.md)
to learn how to set up the cluster and run them.

You can also use [Docker](https://github.com/pingcap/docs/blob/master/op-guide/docker-deployment.md) to
run the cluster.
You can also use [Docker](https://github.com/pingcap/docs/blob/master/dev/how-to/deploy/orchestrated/docker.md)
to run the cluster.