From 4a9a75f97fb44cb3e742b06d61412c127237f4d3 Mon Sep 17 00:00:00 2001 From: Ryan Leung Date: Mon, 20 May 2019 16:10:37 +0800 Subject: [PATCH 1/2] update links Signed-off-by: Ryan Leung --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 73a0c68f0ce..544829a6382 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -75,20 +75,20 @@ X-Etcd-Cluster-Id: 33dc747581249309 You can use the following command to build a PD image directly: -``` +```sh 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 \ @@ -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. From 24e616c0f704a3be802c581465d2f983bf14c332 Mon Sep 17 00:00:00 2001 From: Ryan Leung Date: Tue, 21 May 2019 14:05:16 +0800 Subject: [PATCH 2/2] address comments Signed-off-by: Ryan Leung --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 544829a6382..da65c27a01b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# PD +# PD [![TravisCI Build Status](https://travis-ci.org/pingcap/pd.svg?branch=master)](https://travis-ci.org/pingcap/pd) ![GitHub release](https://img.shields.io/github/release/pingcap/pd.svg) @@ -6,7 +6,7 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/pingcap/pd)](https://goreportcard.com/report/github.com/pingcap/pd) [![codecov](https://codecov.io/gh/pingcap/pd/branch/master/graph/badge.svg)](https://codecov.io/gh/pingcap/pd) -PD is the abbreviation for Placement Driver. It is used to manage and schedule the [TiKV](https://github.com/tikv/tikv) cluster. +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). @@ -19,7 +19,7 @@ PD supports distribution and fault-tolerance by embedding [etcd](https://github. ### Command flags -See [configuration](https://github.com/pingcap/docs/blob/master/dev/reference/configuration/pd-server/configuration.md). +See [PD Configuration Flags](https://pingcap.com/docs/dev/reference/configuration/pd-server/configuration/#pd-configuration-flags). ### Single Node with default ports @@ -27,7 +27,7 @@ You can run `pd-server` directly on your local machine, if you want to connect t you can let PD listen on the host IP. ```bash -# Set correct HostIP here. +# Set correct HostIP here. export HostIP="192.168.199.105" pd-server --name="pd" \ @@ -60,9 +60,9 @@ X-Etcd-Cluster-Id: 33dc747581249309 { "clientURLs": [ "http://192.168.199.105:2379" - ], - "id": "f62e88a6e81c149", - "name": "pd", + ], + "id": "f62e88a6e81c149", + "name": "pd", "peerURLs": [ "http://192.168.199.105:2380" ] @@ -75,13 +75,13 @@ X-Etcd-Cluster-Id: 33dc747581249309 You can use the following command to build a PD image directly: -```sh +```bash docker build -t pingcap/pd . ``` Or you can also use following command to get PD from Docker hub: -```sh +```bash docker pull pingcap/pd ``` @@ -104,8 +104,8 @@ 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/dev/how-to/deploy/orchestrated/ansible.md) +[TiDB-Ansible](https://pingcap.com/docs/dev/how-to/deploy/orchestrated/ansible/#deploy-tidb-using-ansible) to learn how to set up the cluster and run them. -You can also use [Docker](https://github.com/pingcap/docs/blob/master/dev/how-to/deploy/orchestrated/docker.md) +You can also use [Docker](https://pingcap.com/docs/dev/how-to/deploy/orchestrated/docker/#deploy-tidb-using-docker) to run the cluster.