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

*: update the confusing statements #468

Merged
merged 7 commits into from
May 28, 2018
Merged

*: update the confusing statements #468

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
aeef195
Fix the wrong statement
QueenyJin May 15, 2018
a9db873
Fix a typo
QueenyJin May 15, 2018
6365ca0
Fix the statement
QueenyJin May 16, 2018
4ca4316
Fix the quotation mark
QueenyJin May 16, 2018
7c6f7ad
Update the statement of tikv-ctl
QueenyJin May 17, 2018
ce59b3d
Update the MySQL related statement
QueenyJin May 17, 2018
ba65b01
Update the statement regarding the MySQL client
QueenyJin May 17, 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
6 changes: 2 additions & 4 deletions dev-guide/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

## Overview

Note: **The easiest way to deploy TiDB is to use the official binary package directly, see [Binary Deployment](../op-guide/binary-deployment.md).**
Note: **The easiest way to deploy TiDB is to use TiDB Ansible, see [Ansible Deployment](../op-guide/ansible-deployment.md).**

If you want to build the TiDB project, deploy the binaries to other machines and run them, you can follow this guide.

Check the [supported platforms](./requirements.md#supported-platforms) and [prerequisites](./requirements.md#prerequisites) first.
Before you start, check the [supported platforms](./requirements.md#supported-platforms) and [prerequisites](./requirements.md#prerequisites) first.

## Building and installing TiDB components

Expand Down
2 changes: 2 additions & 0 deletions op-guide/ansible-deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,8 @@ To deploy TiDB using a normal user account, take the following steps:

## Test the cluster

Note: Because TiDB is compatible with MySQL, you can use MySQL client to connect to TiDB directly. Before you start TiDB, make sure to install MySQL client first.
Copy link

Choose a reason for hiding this comment

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

Installing before starting TiDB is not necessary. I think the last sentence can be removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If users don’t have MySQL client installed, how can they test their connection to TiDB? I believe TiDB doesn’t have a client yet...

Copy link

Choose a reason for hiding this comment

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

They need a MySQL client, yes! But they don't necessarily need one before installing TiDB. I think maybe Because TiDB is compatible with MySQL, you must use MySQL client to connect to TiDB directly. is appropriate?


It is recommended to configure load balancing to provide uniform SQL interface.

1. Connect to the TiDB cluster using the MySQL client.
Expand Down
16 changes: 14 additions & 2 deletions op-guide/binary-deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,9 @@ The key's randomart image is:

TiDB provides the official binary installation package that supports Linux. For the operating system, it is recommended to use Redhat 7.3+, CentOS 7.3+ and higher versions.

### Operating system: Linux (Redhat 7+, CentOS 7+)
> Note: Because TiDB is compatible with MySQL, you can use MySQL client to connect to TiDB directly. Before you start TiDB, make sure to install MySQL client first.
Copy link

Choose a reason for hiding this comment

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

Installing before starting TiDB is not necessary. I think the last sentence can be removed.


### Download and extract the package on each node

```
# Download the package.
Expand Down Expand Up @@ -207,19 +209,29 @@ Follow the steps below to start PD, TiKV and TiDB:
--log-file=pd.log
```

2. Start TiKV on Node2, Node3 and Node4.
2. Log in and start TiKV on other nodes: Node2, Node3 and Node4:

On Node2:

```bash
./bin/tikv-server --pd="192.168.199.113:2379" \
--addr="192.168.199.114:20160" \
--data-dir=tikv1 \
--log-file=tikv.log
```

On Node3:

```bash
./bin/tikv-server --pd="192.168.199.113:2379" \
--addr="192.168.199.115:20160" \
--data-dir=tikv2 \
--log-file=tikv.log
```

On Node4:

```bash
./bin/tikv-server --pd="192.168.199.113:2379" \
--addr="192.168.199.116:20160" \
--data-dir=tikv3 \
Expand Down
3 changes: 1 addition & 2 deletions tools/tikv-control.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ category: tools

# TiKV Control User Guide

TiKV Control (`tikv-ctl`) is a command line tool of TiKV, used to manage the cluster. When you compile TiKV, the `tikv-ctl` command is also compiled at the same time. If the cluster is deployed using Ansible, the binary file also exist in the corresponding `tidb-ansible/resources/bin` directory.

TiKV Control (`tikv-ctl`) is a command line tool of TiKV, used to manage the cluster. When you compile TiKV, the `tikv-ctl` command is also compiled at the same time. If the cluster is deployed using Ansible, the `tikv-ctl` binary file exists in the corresponding `tidb-ansible/resources/bin` directory. If the cluster is deployed using the binary, the `tikv-ctl` file is in the `bin` directory together with other files such as `tidb-server`, `pd-server`, `tikv-server`, etc.
## General options

`tikv-ctl` provides two operation modes:
Expand Down