Skip to content

op-guide, tikv: update tidb and tikv docker compose steps #635

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
merged 6 commits into from
Sep 29, 2018
Merged

op-guide, tikv: update tidb and tikv docker compose steps #635

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
01fe0af
op-guide: move buildFrom to buildPath for docker compose guide
lilin90 Sep 27, 2018
333a615
op-guide: modify yaml to yml
lilin90 Sep 27, 2018
2184ed5
op-guide: address comments
lilin90 Sep 28, 2018
3ba490e
op-guide: update wording to address the comment
lilin90 Sep 28, 2018
cf62a04
tikv: improve code
lilin90 Sep 28, 2018
a36f6bb
op-guide: update `vim` in TiDB docker compose
lilin90 Sep 29, 2018
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
12 changes: 5 additions & 7 deletions op-guide/docker-compose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,24 +85,22 @@ To customize the cluster, you can edit the `docker-compose.yml` file directly. I

```bash
cd tidb-docker-compose
cp compose/values.yaml values.yaml
vim values.yaml
vi compose/values.yaml # custom the cluster size, docker image, port mapping and so on
Copy link

Choose a reason for hiding this comment

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

In other guides we use vim, for some users on some older systems they may get vi instead of vim if they type vi, which could lead to some confusion.

```

You can modify the configuration in `values.yaml`, such as the cluster size, TiDB image version, and so on.

[tidb-vision](https://github.com/pingcap/tidb-vision) is the data visualization interface of the TiDB cluster, used to visually display the PD scheduling on TiKV data. If you do not need this component, leave `tidbVision` empty.
[tidb-vision](https://github.com/pingcap/tidb-vision) is the data visualization interface of the TiDB cluster, used to visually display the PD scheduling on TiKV data. If you do not need this component, comment out the `tidbVision` field.
Copy link
Member

Choose a reason for hiding this comment

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

comment out the tidbVision section.


For PD, TiKV, TiDB and tidb-vision, you can build Docker images from GitHub source code or local files for development and testing.

- To build the image of a component from GitHub source code, you need to leave the `image` field empty and set `buildFrom` to `remote`.
- To build PD, TiKV or TiDB images from the locally compiled binary file, you need to leave the `image` field empty, set `buildFrom` to `local` and copy the compiled binary file to the corresponding `pd/bin/pd-server`, `tikv/bin/tikv-server`, `tidb/bin/tidb-server`.
- To build the tidb-vision image from local, you need to leave the `image` field empty, set `buildFrom` to `local` and copy the tidb-vision project to `tidb-vision/tidb-vision`.
- To build PD, TiKV or TiDB images from the locally compiled binary file, you need to comment out the `image` field and copy the compiled binary file to the corresponding `pd/bin/pd-server`, `tikv/bin/tikv-server`, `tidb/bin/tidb-server`.
- To build the tidb-vision image from local, you need to comment out the `image` field and copy the tidb-vision project to `tidb-vision/tidb-vision`.

4. Generate the `docker-compose.yml` file.

```bash
helm template -f values.yaml compose > generated-docker-compose.yml
helm template compose > generated-docker-compose.yml
```

5. Create and start the cluster using the generated `docker-compose.yml` file.
Expand Down