Skip to content

get-started: fix some descriptions and typos in tiup quick start doc #2813

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 5 commits into from
Apr 18, 2020
Merged

get-started: fix some descriptions and typos in tiup quick start doc #2813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2cb64df
get-started: fix some descriptions and typos in tiup quick start doc
Apr 18, 2020
9db3b7a
fix a grammar mistake
Apr 18, 2020
7361fed
fix backticks format
Apr 18, 2020
6d71ce2
change 登陆 -> 登录
Apr 18, 2020
29589c7
update tiup deploy
Apr 18, 2020
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
14 changes: 7 additions & 7 deletions how-to/deploy/orchestrated/tiup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -913,7 +913,7 @@ Usage:
Flags:
-h, --help help for deploy
-i, --identity_file string The path of the SSH identity file. If specified, public key authentication will be used.
--user string The user name to login via SSH. The user must has root (or sudo) privilege. (default "root")
--user string The user name to login via SSH. The user must have root (or sudo) privilege. (default "root")
-y, --yes Skip confirming the topology

# Usage 展示执行命令样例，<> 为必填项
Expand Down Expand Up @@ -1029,7 +1029,7 @@ ID Role Host Ports
tiup cluster start tidb-test
```

预期结果输出 `Started cluster tidb-test successfully` 标志启动成功。
预期结果输出 ```Started cluster `tidb-test` successfully``` 标志启动成功。

## 6. 验证集群运行状态

Expand Down Expand Up @@ -1068,7 +1068,7 @@ ID Role Host Ports Status

#### 查看 TiDB Dashboard 检查 TiDB Cluster 状态

- 通过 `{pd-leader-ip}:2379/dashboard` 登录 TiDB Dashboard，登陆用户和口令为 TiDB 数据库 root 用户和口令，如果你修改过数据库的 root 密码，则以修改后的密码为准，默认密码为空。
- 通过 `{pd-leader-ip}:2379/dashboard` 登录 TiDB Dashboard，登录用户和口令为 TiDB 数据库 root 用户和口令，如果你修改过数据库的 root 密码，则以修改后的密码为准，默认密码为空。

![TiDB-Dashboard](/media/tiup/tidb-dashboard.png)

Expand Down Expand Up @@ -1192,7 +1192,7 @@ Bye
tiup cluster stop tidb-test
```

预期结果输出 `Stopped cluster tidb-test successfully` 标志关闭成功。
预期结果输出 ```Stopped cluster `tidb-test` successfully``` 标志关闭成功。

## 8. 销毁集群

Expand All @@ -1208,7 +1208,7 @@ tiup cluster stop tidb-test
tiup cluster destroy tidb-test
```

预期结果输出 `Destroy cluster tidb-test successfully` 标志销毁成功。
预期结果输出 ```Destroy cluster `tidb-test` successfully``` 标志销毁成功。

## 9. 常见部署问题

Expand Down Expand Up @@ -1370,9 +1370,9 @@ v4.0.0-rc 2020-04-09T00:10:32+08:00 linux/amd64,darwi
nightly 2020-04-10T08:42:23+08:00 darwin/amd64,linux/amd64
```

### 如何查看 TiUP 支持管理的组件和版本
### 如何查看 TiUP 支持管理的组件

执行如下命令查看 TiUP 支持管理的组件和版本：
执行如下命令查看 TiUP 支持管理的组件：

```shell
tiup list
Expand Down
24 changes: 12 additions & 12 deletions how-to/get-started/quick-start-with-tidb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ category: how-to

# 如何快速体验 TiDB 集群

本文介绍如何快速体验 TiDB 分布式数据库。有以下 3 种体验方式供用户选择。

> **警告：**
>
> 对于生产环境，不要使用本文介绍的方式进行部署，而应使用 [TiUP 部署 TiDB 集群](/how-to/deploy/orchestrated/tiup.md)。

本文介绍如何快速体验 TiDB 分布式数据库。有以下 3 种体验方式供用户选择。

- [第一种：使用 TiDB-Wasm 一键体验 TiDB 数据库](#第一种使用-tidb-wasm-一键体验-tidb-数据库)
- [第二种：使用 TiUP Playground 快速部署本地测试环境](#第二种使用-tiup-playground-快速部署本地测试环境)
- [第三种：使用 TiUP cluster 模拟单机下的准生产测试环境](#第三种使用-tiup-cluster-模拟单机下的准生产测试环境)
Expand All @@ -22,7 +22,7 @@ category: how-to

TiDB-Wasm 是运行在浏览器中的 TiDB 数据库，打开网页即可使用。TiDB-Wasm 可直接进行 SQL 执行、兼容性验证等基本操作。

试用 TiDB-Wasm 直接点击网址：[https://tour.pingcap.com](https://tour.pingcap.com)，之后会在内存中构建 TiDB 数据库，预计耗时 10 秒左右。
直接点击网址试用 TiDB-Wasm：<https://tour.pingcap.com>，之后会在内存中构建 TiDB 数据库，预计耗时 10 秒左右。

## 第二种：使用 TiUP Playground 快速部署本地测试环境

Expand Down Expand Up @@ -77,15 +77,15 @@ TiDB-Wasm 是运行在浏览器中的 TiDB 数据库，打开网页即可使用
tiup playground
```

- 也可以指定版本以及组件实例个数：
- 也可以指定 TiDB 版本以及各组件实例个数，命令类似于：

{{< copyable "shell-regular" >}}

```shell
tiup playground v4.0.0-rc --db 2 --pd 3 --kv 3 --monitor
```

上述命令会在本地下载并启动一个 v4.0.0-rc 版本的集群，`--monitor` 表示同时部署监控组件。运行结果将显示集群的访问方式：
上述命令会在本地下载并启动一个 `v4.0.0-rc` 版本的集群，`--monitor` 表示同时部署监控组件。运行结果将显示集群的访问方式：

```log
CLUSTER START SUCCESSFULLY, Enjoy it ^-^
Expand Down Expand Up @@ -145,7 +145,7 @@ TiDB-Wasm 是运行在浏览器中的 TiDB 数据库，打开网页即可使用
- 部署主机[关闭防火墙](/how-to/deploy/orchestrated/tiup.md#如何关闭部署机器的防火墙)或者开放 TiDB 集群的节点间所需端口
- 目前 TiUP 仅支持在 x86_64 (AMD64) 架构上部署 TiDB 集群（TiUP 将在 4.0 GA 时支持在 ARM 架构上部署）
- 在 AMD64 架构下，建议使用 CentOS 7.3 及以上版本 Linux 操作系统
- 在 ARM 架构下，建议使用 CentOS 7.6 1810 版本 Linux 操作系操作步骤：
- 在 ARM 架构下，建议使用 CentOS 7.6 1810 版本 Linux 操作系统

### 实施部署

Expand Down Expand Up @@ -179,7 +179,7 @@ TiDB-Wasm 是运行在浏览器中的 TiDB 数据库，打开网页即可使用

4. 由于模拟多机部署，需要通过 `root` 用户调大 sshd 服务的连接数限制：

1. 修改 /etc/ssh/sshd_config 将 `MaxSessions` 调至 20。
1. 修改 `/etc/ssh/sshd_config` 将 `MaxSessions` 调至 20。
2. 重启 sshd 服务：

{{< copyable "shell-regular" >}}
Expand All @@ -190,11 +190,11 @@ TiDB-Wasm 是运行在浏览器中的 TiDB 数据库，打开网页即可使用

5. 创建并启动集群

按下面的配置模板，编辑配置文件，命名为 `topology.yaml`，其中：
按下面的配置模板，编辑配置文件，命名为 `topo.yaml`，其中：

- `user: "tidb"` 表示通过 `tidb` 系统用户来做集群的内部管理（部署会自动创建），默认使用 22 端口通过 ssh 登陆目标机器
- 设置 `replication.enable-placement-rules` 这个 PD 参数来确保 TiFlash 正常运行
- host 改为本部署主机的 IP
- `user: "tidb"`：表示通过 `tidb` 系统用户（部署会自动创建）来做集群的内部管理，默认使用 22 端口通过 ssh 登录目标机器
- `replication.enable-placement-rules`：设置这个 PD 参数来确保 TiFlash 正常运行
- `host`：设置为本部署主机的 IP

配置模板如下：

Expand Down Expand Up @@ -264,7 +264,7 @@ TiDB-Wasm 是运行在浏览器中的 TiDB 数据库，打开网页即可使用
```

- 参数 `<cluster-name>` 表示设置集群名称
- 参数 `<tidb-version>` 表示设置集群版本，可以通过 `tiup list tidb --refresh` 命令来选择当前支持部署的 TiDB 版本
- 参数 `<tidb-version>` 表示设置集群版本，可以通过 `tiup list tidb --refresh` 命令来查看当前支持部署的 TiDB 版本

按照引导，输入”y”及 root 密码，来完成部署：

Expand Down