align pingcap/docs-cn#3463 and pingcap/docs-cn#3425

yikeke · yikeke · commit bebb1eded39e · 2020-06-28T17:50:18.000+08:00
diff --git a/overview.md b/overview.md
@@ -11,7 +11,7 @@ aliases: ['/docs/dev/overview/']
 
 TiDB can be deployed on-premise or in-cloud. The following deployment options are officially supported by PingCAP:
 
-- [TiUP Deployment](/production-deployment-using-tiup.md): This guide describes how to deploy TiDB using [TiUP](https://github.com/pingcap-incubator/tiup). It is strongly recommended for production deployment.
+- [TiUP Deployment](/production-deployment-using-tiup.md): This guide describes how to deploy TiDB using [TiUP](https://github.com/pingcap/tiup). It is strongly recommended for production deployment.
 - [Docker Deployment](/test-deployment-using-docker.md): This guide describes how to deploy TiDB using Docker.
 - [Docker Compose Deployment](/deploy-test-cluster-using-docker-compose.md): This guide describes how to deploy TiDB using Docker compose. You can follow this guide to quickly deploy a TiDB cluster for testing and development on your local drive.
 - Kubernetes Deployment:
diff --git a/production-offline-deployment-using-tiup.md b/production-offline-deployment-using-tiup.md
@@ -15,7 +15,7 @@ You can either download the official package, or manually pack a component packa
 
 ### Download the official TiUP offline component package
 
-Download the prepared offline mirror package at <http://download.pingcap.org> by running the following command:
+Download the prepared offline mirror package at `http://download.pingcap.org` by running the following command:
 
 {{< copyable "shell-regular" >}}
 
diff --git a/tiup/tiup-cluster.md b/tiup/tiup-cluster.md
@@ -63,7 +63,7 @@ tiup cluster deploy <cluster-name> <version> <topology.yaml> [flags]
 
 This command requires you to provide the cluster name, the TiDB cluster version, and a topology file of the cluster.
 
-To write a topology file, refer to [the example](https://github.com/pingcap-incubator/tiup-cluster/blob/master/examples/topology.example.yaml). The following file is an example of the simplest topology:
+To write a topology file, refer to [the example](https://github.com/pingcap/tiup/blob/master/examples/topology.example.yaml). The following file is an example of the simplest topology:
 
 > **Note:**
 >
diff --git a/tiup/tiup-mirror.md b/tiup/tiup-mirror.md
@@ -7,176 +7,85 @@ aliases: ['/docs/dev/tiup/tiup-mirrors/','/docs/dev/reference/tools/tiup/mirrors
 
 # Create a Private Mirror
 
-When creating a private cloud, usually, you need to use an isolated network environment, where the official mirror of TiUP is not accessible. Therefore, you can create a private mirror, which is mainly implemented by the `mirrors` component. You can also use `mirrors` for offline deployment.
+When creating a private cloud, usually, you need to use an isolated network environment, where the official mirror of TiUP is not accessible. Therefore, you can create a private mirror, which is mainly implemented by the `mirror` command. You can also use the `mirror` command for offline deployment.
 
-## TiUP `mirrors` overview
+## TiUP `mirror` overview
 
-Execute the following command to get the help information of the `mirrors` component:
+Execute the following command to get the help information of the `mirror` command:
 
 {{< copyable "shell-regular" >}}
 
 ```bash
-tiup mirrors --help
+tiup mirror --help
 ```
 
-```
-Starting component `mirrors`: /Users/joshua/.tiup/components/mirrors/v0.0.1/mirrors
-Build a local mirrors and download all selected components
+```bash
+The 'mirror' command is used to manage a component repository for TiUP, you can use
+it to create a private repository, or to add new component to an existing repository.
+The repository can be used either online or offline.
+It also provides some useful utilities to help managing keys, users and versions
+of components or the repository itself.
 Usage:
-  tiup mirrors <target-dir> [global-version] [flags]
-Examples:
-  tiup mirrors local-path --arch amd64,arm --os linux,darwin    # Specify the architectures and OSs
-  tiup mirrors local-path --full                                # Build a full local mirrors
-  tiup mirrors local-path --tikv v4                             # Specify the version via prefix
-  tiup mirrors local-path --tidb all --pd all                   # Download all version for specific component
+  tiup mirror <command> [flags]
+Available Commands:
+  init        Initialize an empty repository
+  sign        Add signatures to a manifest file
+  genkey      Generate a new key pair
+  clone       Clone a local mirror from remote mirror and download all selected components
+  publish     Publish a component
 Flags:
-      --overwrite                   Overwrite the exists tarball
-  -f, --full                        Build a full mirrors repository
-  -a, --arch strings                Specify the downloading architecture (default [amd64])
-  -o, --os strings                  Specify the downloading os (default [linux,darwin])
-      --tidb strings                Specify the versions for component tidb
-      --tikv strings                Specify the versions for component tikv
-      --pd strings                  Specify the versions for component pd
-      --playground strings          Specify the versions for component playground
-      --client strings              Specify the versions for component client
-      --prometheus strings          Specify the versions for component prometheus
-      --package strings             Specify the versions for component package
-      --grafana strings             Specify the versions for component grafana
-      --alertmanager strings        Specify the versions for component alertmanager
-      --blackbox_exporter strings   Specify the versions for component blackbox_exporter
-      --node_exporter strings       Specify the versions for component node_exporter
-      --pushgateway strings         Specify the versions for component pushgateway
-      --tiflash strings             Specify the versions for component tiflash
-      --drainer strings             Specify the versions for component drainer
-      --pump strings                Specify the versions for component pump
-      --cluster strings             Specify the versions for component cluster
-      --mirrors strings             Specify the versions for component mirrors
-      --bench strings               Specify the versions for component bench
-      --insight strings             Specify the versions for component insight
-      --doc strings                 Specify the versions for component doc
-      --ctl strings                 Specify the versions for component ctl
-  -h, --help                        help for tiup
+  -h, --help          help for mirror
+      --repo string   Path to the repository
+Global Flags:
+      --skip-version-check   Skip the strict version check, by default a version must be a valid SemVer string
+Use "tiup mirror [command] --help" for more information about a command.
 ```
 
-The basic usage of the `tiup mirrors` command is as follows:
+The `tiup mirror clone` command is used to build a local mirror. The basic usage is as follows:
 
 {{< copyable "shell-regular" >}}
 
 ```bash
-tiup mirrors <target-dir> [global-version] [flags]
+tiup mirror clone <target-dir> [global-version] [flags]
 ```
 
 - `target-dir`: used to specify the directory in which cloned data is stored.
 - `global-version`: used to quickly set a global version for all components.
 
-The `tiup mirrors` command provides many optional flags (might provide more in the future). These flags can be divided into the following categories according to their intended usages:
+The `tiup mirror clone` command provides many optional flags (might provide more in the future). These flags can be divided into the following categories according to their intended usages:
 
-- Determines whether to overwrite local packages
+- Determines whether to use prefix matching to match the version when cloning
 
-    The `--overwrite` flag determines whether to overwrite the local package with the package of the official mirror, if the specified `<target-dir>` directory contains the package you need to download. If you set this flag, the local package is overwritten.
+    If the `--prefix` flag is specified, the version number is matched by prefix for the clone. For example, if you specify `--prefix` as "v4.0.0", then "v4.0.0-rc.1", "v4.0.0-rc.2", and "v4.0.0" are matched.
 
 - Determines whether to use the full clone
 
     If you specify the `--full` flag, you can clone the official mirror fully.
 
     > **Note:**
     >
-    > If `--full` and the other flags are not specified, only some meta information is cloned.
+    > If `--full`, `global-version` flags, and the component versions are not specified, only some meta information is cloned.
 
 - Determines whether to clone packages from the specific platform
 
     If you want to clone packages only for a specific platform, use `-os` and `-arch` to specify the platform. For example:
 
-    - Execute the `tiup mirros <target-dir> --os=linux` command to clone for linux.
-    - Execute the `tiup mirros <target-dir> --arch=amd64` command to clone for amd64.
-    - Execute the `tiup mirros <target-dir> --os=linux --arch=amd64` command to clone for linux/amd64.
+    - Execute the `tiup mirror clone <target-dir> [global-version] --os=linux` command to clone for linux.
+    - Execute the `tiup mirror clone <target-dir> [global-version] --arch=amd64` command to clone for amd64.
+    - Execute the `tiup mirror clone <target-dir> [global-version] --os=linux --arch=amd64` command to clone for linux/amd64.
 
 - Determines whether to clone a specific version of a package
 
     If you want to clone only one version (not all versions) of a component, use `--<component>=<version>` to specify this version. For example:
 
-    - Execute the `tiup mirrors <target-dir> --tidb v4` command to clone the v4 version of the TiDB component.
-    - Execute the `tiup mirros <target-dir> --tidb v4 --tikv all` command to clone the v4 version of the TiDB component and all versions of the TiKV component.
-    - Execute the `tiup mirrors <target-dir> v4.0.0-rc` command to clone the v4.0.0-rc version of all components in a cluster.
+    - Execute the `tiup mirror clone <target-dir> --tidb v4.0.0` command to clone the v4.0.0 version of the TiDB component.
+    - Execute the `tiup mirror clone <target-dir> --tidb v4.0.0 --tikv all` command to clone the v4.0.0 version of the TiDB component and all versions of the TiKV component.
+    - Execute the `tiup mirror clone <target-dir> v4.0.0` command to clone the v4.0.0 version of all components in a cluster.
 
 ## Usage examples
 
-This section introduces the usage examples of `mirrors`, including offline installation of a TiDB cluster, and the creation of a private mirror.
-
-### Install a TiDB cluster offline using TiUP
-
-If you want to install a TiDB cluster of the v4.0.0-rc version in an isolated environment, take the following steps:
-
-1. Pull the required components on a machine connected to the external network:
-
-    {{< copyable "shell-regular" >}}
-
-    ```bash
-    tiup mirrors package --os=linux v4.0.0-rc
-    ```
-
-    Then a `package` directory is created in the current directory. This `package` directory contains necessary components packages to start a cluster.
-
-2. Use the `tar` command to pack the components package and send this package to the control machine that is in the isolated environment:
-
-    {{< copyable "shell-regular" >}}
-
-    ```bash
-    tar czvf package.tar.gz package
-    ```
-
-    Then `package.tar.gz` is an isolated, offline environment.
-
-3. After sending the package to the control machine of the target cluster, execute the following command to install TiUP:
-
-    {{< copyable "shell-regular" >}}
-
-    ```bash
-    tar xzvf package.tar.gz
-    cd package
-    sh local_install.sh
-    ```
-
-4. Follow the instructions to finish the installation of TiUP, and then deploy the TiDB cluster:
-
-    {{< copyable "shell-regular" >}}
-
-    ```bash
-    export TIUP_MIRRORS=/path/to/mirror
-    tiup cluster deploy <cluster-name> <cluster-version> <topology-file>
-    tiup cluster start <cluster-name>
-    ```
+This section introduces the usage examples of the `mirror` command.
 
-    `/path/to/mirror` refers to where `<target-dir>` (in `tiup mirrors <target-dir>`) is. If `/tmp/package` refers to where `<target-dir>` is, execute the following command instead:
-
-    {{< copyable "shell-regular" >}}
-
-    ```bash
-    export TIUP_MIRRORS=/tmp/package
-    ```
-
-After you complete the deployment, refer to [Deploy and Maintain an Online TiDB Cluster Using TiUP](/tiup/tiup-cluster.md) for more details of the cluster operations.
-
-### Create a private mirror
-
-The process of creating a private mirror is similar to that of creating an offline installer. The only difference is that, to create a private mirror, you need to upload the content of the `package` directory to CDN or a file server. Execute the following command to create a private mirror:
-
-{{< copyable "shell-regular" >}}
-
-```bash
-cd package
-python -m SimpleHTTPServer 8000
-```
-
-Now you have created a private mirror at <http://127.0.0.1:8000>.
-
-Then execute the following command to install TiUP using the private mirror:
-
-{{< copyable "shell-regular" >}}
-
-```bash
-export TIUP_MIRRORS=http://127.0.0.1:8000
-curl $TIUP_MIRRORS/install.sh | sh
-```
+### Deploy a TiDB Cluster Offline Using TiUP
 
-After importing the `PATH` variable, you can start to use TiUP. Make sure that the `TIUP_MIRRORS` variable points to the private mirror.
+Refer to [Deploy a TiDB Cluster Offline Using TiUP](/production-offline-deployment-using-tiup.md#manually-pack-an-offline-component-package-using-tiup-mirror-clone) to install the TiUP offline mirror, deploy a TiDB cluster, and start it.
diff --git a/tiup/tiup-overview.md b/tiup/tiup-overview.md
@@ -61,16 +61,11 @@ Available Commands:
   update      Update tiup components to the latest version
   status      List the status of instantiated components
   clean       Clean the data of instantiated components
+  mirror      Manage a repository mirror for TiUP components
   help        Help about any command or component
 
-Available Components:
-  playground          Bootstrap a local TiDB cluster
-  client              A simple mysql client to connect TiDB
-  package             A toolbox to package tiup component
-  cluster             Deploy a TiDB cluster for production
-  mirrors             Build a local mirrors and download all selected components
-  bench               Benchmark database with different workloads
-  doc                 Online document for TiDB
+Components Manifest:
+  use "tiup list" to fetch the latest components manifest
 
 Flags:
   -B, --binary <component>[:version]   Print binary path of a specific version of a component <component>[:version]
@@ -79,7 +74,7 @@ Flags:
   -h, --help                           help for tiup
       --skip-version-check             Skip the strict version check, by default a version must be a valid SemVer string
   -T, --tag string                     Specify a tag for component instance
-      --version                        version for tiup
+  -v, --version                        version for tiup
 
 Component instances with the same "tag" will share a data directory ($TIUP_HOME/data/$tag):
   $ tiup --tag mycluster playground
@@ -108,11 +103,11 @@ The output is long but you can focus on only two parts:
     - update: used to update the component version 
     - status: used to view the running history of components
     - clean: used to clear the running log of components
+    - mirror: used to clone a private mirror from the official mirror
     - help: used to print out help information
 - Available components
     - playground: used to start a TiDB cluster locally
     - client: used to connect to a TiDB cluster in a local machine
-    - mirrors: used to clone a private mirror from an official mirror
     - cluster: used to deploy a TiDB cluster for production environments
     - bench: used to stress test the database
     - doc: used to open online document

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ tiup cluster deploy <cluster-name> <version> <topology.yaml> [flags]`
`63`	`63`
`64`	`64`	`This command requires you to provide the cluster name, the TiDB cluster version, and a topology file of the cluster.`
`65`	`65`
`66`		`-To write a topology file, refer to [the example](https://github.com/pingcap-incubator/tiup-cluster/blob/master/examples/topology.example.yaml). The following file is an example of the simplest topology:`
	`66`	`+To write a topology file, refer to [the example](https://github.com/pingcap/tiup/blob/master/examples/topology.example.yaml). The following file is an example of the simplest topology:`
`67`	`67`
`68`	`68`	`> Note:`
`69`	`69`	`>`