Skip to content

Commit

Permalink
tiup: add three docs (#5061)
Browse files Browse the repository at this point in the history
  • Loading branch information
Joyinqin authored Apr 1, 2021
1 parent 35bd044 commit 52f376b
Show file tree
Hide file tree
Showing 3 changed files with 135 additions and 0 deletions.
54 changes: 54 additions & 0 deletions tiup/tiup-command-telemetry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: tiup telemetry
---

# tiup telemetry

TiDB, TiUP, and TiDB Dashboard collect usage information by default and share the information with PingCAP to improve the product. For example, through this usage information, PingCAP learns about common TiDB cluster operations and thereby determines the priority of new features.

When TiUP telemetry is enabled, usage information is shared with PingCAP when TiUP commands are executed, including (but not limited to):

- Randomly generated telemetry identifiers.
- The execution status of the TiUP command, such as whether the command execution is successful and the duration of command execution.
- Situations using TiUP for deployment, such as target machine hardware information, component version number, and modified deployment configuration name.

The information below is not shared:

- The accurate name of the cluster
- The cluster topology
- The cluster configuration file

TiUP uses the `tiup telemetry` command to control telemetry.

> **Note:**
>
> This feature is enabled by default.
## Syntax

```shell
tiup telemetry <command>
```

`<command>` stands for sub-commands. For the list of supported sub-commands, refer to the commands section below.

## Commands

### status

The `tiup telemetry status` command is used to view the current telemetry settings and output the following information:

- `status`: specifies enabling or disabling the telemetry `(enable|disable)`.
- `uuid`: specifies the randomly generated telemetry identifiers.

### reset

The `tiup telemetry reset` command is used to reset the current telemetry identifier and replaces it with a new random identifier.

### enable

The `tiup telemetry enable` command is used to enable the telemetry.

### disable

The `tiup telemetry disable` command is used to disable the telemetry.
32 changes: 32 additions & 0 deletions tiup/tiup-component-cluster-audit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: tiup cluster audit
---

# tiup cluster audit

The `tiup cluster audit` command is used to view commands executed on all clusters in the history and the execution log of each command.

## Syntax

```sh
tiup cluster audit [audit-id] [flags]
```

- If you do not fill in the `[audit-id]`, the table of operation records is output in reverse chronological order. The first column is the `audit-id`.
- If you fill in the `[audit-id]`, it means checking the execution log of the specified `audit-id`.

## Option

### -h, --help

- Prints the help information.
- Data type: `Boolean`
- Default: false

## Outputs

- If `[audit-id]` is specified, the corresponding execution log is output.
- If `[audit-id]` is not specified, a table with the following fields is output:
- ID: the `audit-id` corresponding to the record
- Time: the execution time of the command corresponding to the record
- Command:the command corresponding to the record
49 changes: 49 additions & 0 deletions tiup/tiup-component-cluster-destroy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: tiup cluster destroy
---

# tiup cluster destroy

After an application goes offline, if you want to release the machines occupied by the cluster for use by other applications, you need to clean up the data on the cluster and the deployed binary files. To destroy the cluster, the `tiup cluster destroy` command performs the following operations:

- Stops the cluster.
- For each service, delete its log directory, deployment directory, and data directory.
- If the parent directory of the data directory or deployment directory of each service is created by tiup-cluster, also delete the parent directory.

## Syntax

```sh
tiup cluster destroy <cluster-name> [flags]
```

`<cluster-name>`: the name of the cluster to destroy.

## Options

### --force

- In some cases, some nodes in the cluster have been down, making it impossible to connect to the node through SSH for operation. At this time, you can use the `--force` option to ignore these errors.
- Data type: `Boolean`
- Default: false

### --retain-node-data

- Specifies the nodes that need to retain data. If you need to specify more than one node, use this option multiple times: `--retain-node-data <node-A> --retain-node-data <node-B>`.
- Data type: `StringArray`
- Default: empty

### --retain-role-data

- Specifies the role that needs to retain data. If you need to specify more than one role, use this option multiple times: `--retain-role-data <role-A> --retain-role-data <role-B>`.
- Data type: `StringArray`
- Default: empty

### -h, --help

- Prints the help information.
- Data type: `Boolean`
- Default: false

## Output

The execution log of the tiup-cluster.

0 comments on commit 52f376b

Please sign in to comment.