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

op-guide, tikv: update docker compose deployment #496

Merged
merged 4 commits into from
Jun 15, 2018
Merged

op-guide, tikv: update docker compose deployment #496

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
93e9a18
op-guide, tikv: update docker compose deployment
lilin90 Jun 12, 2018
c86eb38
op-guide: add the TiSpark section
lilin90 Jun 14, 2018
cf2620d
op-guide: add a 5-minute tutorial link
lilin90 Jun 14, 2018
f0de44f
op-guide: update wording
lilin90 Jun 15, 2018
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
65 changes: 59 additions & 6 deletions op-guide/docker-compose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
---
title: TiDB Docker Compose Deployment
summary: Deploy a TiDB testing cluster with a single command using Docker Compose.
category: operations
---

# TiDB Docker Compose Deployment

This document describes how to quickly deploy TiDB using [Docker Compose](https://docs.docker.com/compose/overview).
This document describes how to quickly deploy a TiDB testing cluster with a single command using [Docker Compose](https://docs.docker.com/compose/overview).

With Docker Compose, you can use a YAML file to configure application services in multiple containers. Then, with a single command, you can create and start all the services from your configuration.

You can use Docker Compose to deploy a TiDB test cluster with a single command. It is required to use Docker 17.06.0 or later.
## Prerequisites

Make sure you have installed the following items on your machine:

- Docker (17.06.0 or later)
- Docker Compose
- Git

## Deploy TiDB using Docker Compose

Expand All @@ -22,7 +29,8 @@ You can use Docker Compose to deploy a TiDB test cluster with a single command.
2. Create and start the cluster.

```bash
cd tidb-docker-compose && docker-compose up -d
cd tidb-docker-compose && docker-compose pull # Get the latest Docker images
docker-compose up -d
```

3. Access the cluster.
Expand Down Expand Up @@ -59,7 +67,7 @@ To customize the cluster, you can edit the `docker-compose.yml` file directly. I

For macOS, you can also install Helm using the following command in Homebrew:

```
```bash
brew install kubernetes-helm
```

Expand All @@ -77,7 +85,7 @@ To customize the cluster, you can edit the `docker-compose.yml` file directly. I
vim values.yaml
```

Modify the configuration in `values.yaml`, such as the cluster size, TiDB image version, and so on.
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.

Expand All @@ -96,6 +104,7 @@ To customize the cluster, you can edit the `docker-compose.yml` file directly. I
5. Create and start the cluster using the generated `docker-compose.yml` file.

```bash
docker-compose -f generated-docker-compose.yaml pull # Get the latest Docker images
docker-compose -f generated-docker-compose.yml up -d
```

Expand All @@ -111,4 +120,48 @@ To customize the cluster, you can edit the `docker-compose.yml` file directly. I
- Default account name: admin
- Default password: admin

If tidb-vision is enabled, you can access the cluster data visualization interface: <http://localhost:8010>.
If tidb-vision is enabled, you can access the cluster data visualization interface: <http://localhost:8010>.

## Access the Spark shell and load TiSpark

Insert some sample data to the TiDB cluster:

```bash
$ docker-compose exec tispark-master bash
$ cd /opt/spark/data/tispark-sample-data
$ mysql -h tidb -P 4000 -u root < dss.ddl
```

After the sample data is loaded into the TiDB cluster, you can access the Spark shell using `docker-compose exec tispark-master /opt/spark/bin/spark-shell`.

```bash
$ docker-compose exec tispark-master /opt/spark/bin/spark-shell
...
Spark context available as 'sc' (master = local[*], app id = local-1527045927617).
Spark session available as 'spark'.
Welcome to
____ __
/ __/__ ___ _____/ /__
_\ \/ _ \/ _ `/ __/ '_/
/___/ .__/\_,_/_/ /_/\_\ version 2.1.1
/_/

Using Scala version 2.11.8 (Java HotSpot(TM) 64-Bit Server VM, Java 1.8.0_172)
Type in expressions to have them evaluated.
Type :help for more information.

scala> import org.apache.spark.sql.TiContext
...
scala> val ti = new TiContext(spark)
...
scala> ti.tidbMapDatabase("TPCH_001")
...
scala> spark.sql("select count(*) from lineitem").show
+--------+
|count(1)|
+--------+
| 60175|
+--------+
```

Here is [a 5-minute tutorial](https://www.pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/) that shows you how to spin up a standard TiDB cluster using Docker Compose on your local computer (installed with macOS).
Copy link
Member

Choose a reason for hiding this comment

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

Does this require macOS?

Copy link
Member Author

Choose a reason for hiding this comment

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

@tennix Currently yes. Ref: https://pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/

Copy link
Member

Choose a reason for hiding this comment

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

Ok, seems that only the first section involves macOS. Maybe we need update that document to include Linux

Copy link
Member Author

Choose a reason for hiding this comment

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

We'll update it soon after testing.

34 changes: 23 additions & 11 deletions tikv/deploy-tikv-docker-compose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,56 +1,68 @@
---
title: Install and Deploy TiKV Using Docker Compose
category: user guide
summary: Quickly deploy a TiKV testing cluster using Docker Compose.
category: operations
---

# Install and Deploy TiKV Using Docker Compose

This guide describes how to quickly deploy a TiKV cluster using [Docker Compose](https://github.com/pingcap/tidb-docker-compose/). Currently, this installation method only supports the Linux system.
This guide describes how to quickly deploy a TiKV testing cluster using [Docker Compose](https://github.com/pingcap/tidb-docker-compose/).

> **Note:** Currently, this installation method only supports the Linux system.

## Prerequisites

- Install Docker and Docker Compose.
Make sure you have installed the following items on your machine:

```
- Docker (17.06.0 or later) and Docker Compose

```bash
sudo yum install docker docker-compose
```

- Install Helm.
- Helm

```
```bash
curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash
```

- Git

```
sudo yum install git
```

## Install and deploy

1. Download `tidb-docker-compose`.

```
```bash
git clone https://github.com/pingcap/tidb-docker-compose.git
```

2. Edit the `compose/values.yaml` file to configure `networkMode` to `host` and comment the TiDB section out.

```
```bash
cd tidb-docker-compose/compose
networkMode: host
```

3. Generate the `generated-docker-compose.yml` file.

```
```bash
helm template compose > generated-docker-compose.yml
```

4. Create and start the cluster using the `generated-docker-compose.yml` file.

```
```bash
docker-compose -f generated-docker-compose.yaml pull # Get the latest Docker images
docker-compose -f generated-docker-compose.yml up -d
```

You can check whether the TiKV cluster has been successfully deployed using the following command:

```
```bash
curl localhost:2379/pd/api/v1/stores
```

Expand Down