Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion tidb-cloud/ticloud-auth-login.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ticloud auth login
summary: ticloud auth login` のリファレンス。
---

# ticloud認証ログイン {#ticloud-auth-login}
# ticloud auth login {#ticloud-auth-login}

TiDB Cloudで認証する:

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/ticloud-completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ticloud completion
summary: ticloud 補完` のリファレンス。
---

# ticloudの完了 {#ticloud-completion}
# ticloud completion {#ticloud-completion}

TiDB Cloud CLI の指定されたシェルの自動補完スクリプトを生成します。

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/ticloud-help.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ticloud help
summary: ticloud help` のリファレンス。
---

# ticloudヘルプ {#ticloud-help}
# ticloud help {#ticloud-help}

TiDB Cloud CLI の任意のコマンドのヘルプ情報を取得します。

Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-command-mirror-publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ tiup mirror publish <comp-name> <version> <tarball> <entry> [flags]
>
> `--os` `any`に設定する場合は、 `--arch` `any`に設定する必要があります。

### --説明 {#desc}
### --desc {#desc}

- コンポーネントの説明を指定します。
- データ型: `String`
Expand All @@ -72,7 +72,7 @@ tiup mirror publish <comp-name> <version> <tarball> <entry> [flags]
- データ型: `STRING`
- デフォルト: NULL

### --スタンドアロン {#standalone}
### --standalone {#standalone}

- コンポーネントをスタンドアロンで実行できるかどうかを制御します。このオプションは現在**利用できません**。
- データ型: `BOOLEAN`
Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-command-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ tiup update [component1][:version] [component2..N] [flags]
- データ型: `BOOLEAN`
- このオプションはデフォルトで無効になっており、デフォルト値は`false`です。このオプションを有効にするには、コマンドにこのオプションを追加し、値`true`を渡すか、値を渡さないかのいずれかを選択します。

### --毎晩 {#nightly}
### --nightly {#nightly}

- 指定されたコンポーネントをナイトリーバージョンに更新します。このオプションを指定した`tiup update`コマンドは、 `tiup update <component>:nightly`コマンドと同等です。
- データ型: `BOOLEAN`
Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-component-cluster-audit-cleanup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: tiup cluster audit cleanup
summary: tiup cluster audit cleanup` コマンドは、`tiup cluster` コマンドによって生成されたログをクリーンアップするために使用されます。ログの保持日数を指定したり、ヘルプ情報を表示したりするオプションがあります。出力結果から、ログのクリーンアップが正常に完了したことを確認できます。
---

# tiup cluster auditクリーンアップ {#tiup-cluster-audit-cleanup}
# tiup cluster audit cleanup {#tiup-cluster-audit-cleanup}

`tiup cluster audit cleanup`コマンドは、 `tiup cluster`コマンドの実行中に生成されたログをクリーンアップするために使用されます。

Expand All @@ -15,7 +15,7 @@ tiup cluster audit cleanup [flags]

## オプション {#options}

### --保持日数 {#retain-days}
### --retain-days {#retain-days}

- ログを保持する日数を指定します。
- データ型: `INT`
Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-cluster-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ tiup cluster check <topology.yml | cluster-name> [flags]
>
> このオプションは、 `--cluster`オプションが false の場合にのみ有効です。それ以外の場合、このオプションの値は`${TIUP_HOME}/storage/cluster/clusters/<cluster-name>/ssh/id_rsa`に固定されます。

### -p, --パスワード {#p-password}
### -p, --password {#p-password}

- ターゲットマシンに接続するときにパスワードを使用してログインします。
- クラスターに`--cluster`オプションが追加された場合、パスワードはクラスターのデプロイ時にトポロジ ファイルに指定されたユーザーのパスワードになります。
Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-component-cluster-destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ tiup cluster destroy <cluster-name> [flags]
- データ型: `Boolean`
- このオプションはデフォルトで無効になっており、デフォルト値は`false`です。このオプションを有効にするには、コマンドにこのオプションを追加し、値`true`を渡すか、値を渡さないかのいずれかを選択します。

### --ノードデータを保持 {#retain-node-data}
### --retain-node-data {#retain-node-data}

- データを保持する必要があるノードを指定します。複数のノードを指定する必要がある場合は、このオプションを複数回使用します( `--retain-node-data <node-A> --retain-node-data <node-B>` )。
- データ型: `StringArray`
- デフォルト: 空

### --ロールデータを保持する {#retain-role-data}
### --retain-role-data {#retain-role-data}

- データを保持する必要があるロールを指定します。複数のロールを指定する必要がある場合は、このオプションを複数回使用します( `--retain-role-data <role-A> --retain-role-data <role-B>` )。
- データ型: `StringArray`
Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-component-cluster-display.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,14 @@ tiup cluster display <cluster-name> [flags]
- デフォルト値: `false`
- このオプションを有効にするには、このオプションをコマンドに追加し、値`true`を渡すか、値を渡さないようにします。

### --稼働時間 {#uptime}
### --uptime {#uptime}

- このオプションを有効にすると、ノードの`uptime`情報が表示されます。このオプションはデフォルトでは無効です。
- データ型: `BOOLEAN`
- デフォルト値: `false`
- このオプションを有効にするには、このオプションをコマンドに追加し、値`true`を渡すか、値を渡さないようにします。

### --ステータスタイムアウト {#status-timeout}
### --status-timeout {#status-timeout}

- ノードステータス情報を取得するためのタイムアウト期間を指定します。
- データ型: `INT`
Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-cluster-meta-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: tiup cluster meta backup
summary: TiUPメタファイルは、クラスタの運用と保守に不可欠です。定期的にファイルをバックアップするには、tiup cluster meta backup`コマンドを使用してください。クラスタ名を確認するには、`tiup dm listコマンドを使用してください。`--file`オプションでターゲットディレクトリを指定してください。ヘルプ情報を表示するには、`-h, --helpコマンドを使用してください。出力には、tiup-clusterの実行ログが含まれます。
---

# tiup クラスタメタバックアップ {#tiup-cluster-meta-backup}
# tiup cluster meta backup {#tiup-cluster-meta-backup}

TiUPメタファイルはクラスタの運用保守(OM)に使用されます。このファイルが失われると、 TiUPを使用してクラスタを管理できなくなります。このような状況を回避するには、 `tiup cluster meta backup`コマンドを使用してTiUPメタファイルを定期的にバックアップしてください。

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-cluster-meta-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: tiup cluster meta restore
summary: TiUPメタファイルを復元するには、クラスター名とバックアップファイルのパスを指定して「tiup cluster meta restore」コマンドを使用します。復元操作は現在のメタファイルを上書きするため、ファイルが失われた場合にのみ実行してください。「-h」または「--help」オプションを指定するとヘルプ情報が出力。出力には、 tiup-clusterの実行ログが含まれます。
---

# tiup クラスタ メタ リストア {#tiup-cluster-meta-restore}
# tiup cluster meta restore {#tiup-cluster-meta-restore}

TiUPメタ ファイルを復元するには、 `tiup cluster meta restore`コマンドを使用してバックアップ ファイルから復元できます。

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-cluster-scale-out.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ tiup cluster scale-out <cluster-name> <topology.yaml> [flags]
- データ型: `STRING`
- コマンドでこのオプションを指定しない場合は、デフォルトで`~/.ssh/id_rsa`ファイルを使用してターゲット マシンに接続します。

### -p, --パスワード {#p-password}
### -p, --password {#p-password}

- ターゲットマシンへの接続に使用するパスワードを指定します。このオプションと`-i/--identity_file`同時に使用しないでください。
- データ型: `BOOLEAN`
Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-component-cluster-tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ tiup cluster tls <cluster-name> <enable/disable> [flags]

## オプション {#options}

### --クリーン証明書 {#clean-certificate}
### --clean-certificate {#clean-certificate}

- TLSを無効にする場合は、このオプションを使用して以前に生成された証明書を削除してください。
- データタイプ: `BOOLEAN`
Expand All @@ -35,7 +35,7 @@ tiup cluster tls <cluster-name> <enable/disable> [flags]
- デフォルト: `false`
- このオプションを指定しない場合、クラスターが既に要求された状態にある場合は、操作はスキップされます。

### --証明書を再読み込み {#reload-certificate}
### --reload-certificate {#reload-certificate}

- TLSを有効にする場合は、このオプションを使用して証明書を再生成してください。
- データタイプ: `BOOLEAN`
Expand Down
6 changes: 3 additions & 3 deletions tiup/tiup-component-cluster-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ tiup cluster upgrade <cluster-name> <version> [flags]
- データ型: `STRINGS`
- このオプションが設定されていない場合、Node Exporter のバージョンはクラスターのバージョンと一致したままになります。

### --再起動タイムアウト {#restart-timeout}
### --restart-timeout {#restart-timeout}

- ローリング アップグレード中にコンポーネントをアップグレードした後の待機時間を指定します。
- データ型: `STRINGS` [`golang time.ParseDuration`](https://pkg.go.dev/time#ParseDuration)で解析できるすべての型がサポートされます。
Expand All @@ -129,7 +129,7 @@ tiup cluster upgrade <cluster-name> <version> [flags]
- データ型: `BOOLEAN`
- このオプションはデフォルトで値`false`で無効になっています。このオプションを有効にするには、コマンドにこのオプションを追加し、値`true`を渡すか、値を渡さないでください。

### ---アップグレード前スクリプト {#pre-upgrade-script}
### ---pre-upgrade-script {#pre-upgrade-script}

> **Warning:**
>
Expand All @@ -139,7 +139,7 @@ tiup cluster upgrade <cluster-name> <version> [flags]
- データ型: `STRINGS`
- このオプションは、アップグレードするノードで実行されるスクリプトのパスを指定します。

### ---アップグレード後のスクリプト {#post-upgrade-script}
### ---post-upgrade-script {#post-upgrade-script}

> **Warning:**
>
Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-component-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ tiup cluster [command] [flags]
- データ型: `UINT`
- コマンドでこのオプションを指定しない場合、各ステップの最大待機時間は`120`秒になります。

### -y, --はい {#y-yes}
### -y, --yes {#y-yes}

- すべてのリスクのある操作の2次確認をスキップします。スクリプトを使用してTiUPを呼び出す場合を除き、このオプションの使用は推奨されません。
- このオプションはデフォルトで値`false`で無効になっています。このオプションを有効にするには、コマンドにこのオプションを追加し、値`true`を渡すか、値を渡さないでください。

### -v, --バージョン {#v-version}
### -v, --version {#v-version}

- TiUP クラスタの現在のバージョンを出力します。
- データ型: `BOOLEAN`
Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-component-dm-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: tiup dm deploy
summary: tiup dm deploy`コマンドは、新しいクラスタをデプロイするために使用されます。クラスタ名、バージョン、および用意したトポロジファイルが必要です。オプションのフラグとして、ユーザー名、IDファイル、パスワード、ヘルプなどがあります。出力はデプロイメントログです。
---

# tiup dm デプロイ {#tiup-dm-deploy}
# tiup dm deploy {#tiup-dm-deploy}

`tiup dm deploy`コマンドは、新しいクラスターをデプロイするために使用されます。

Expand Down Expand Up @@ -31,7 +31,7 @@ tiup dm deploy <cluster-name> <version> <topology.yaml> [flags]
- データ型: `STRING`
- デフォルト: `~/.ssh/id_rsa`

### -p, --パスワード {#p-password}
### -p, --password {#p-password}

- ターゲットマシンへの接続に使用するパスワードを指定します。このオプションと`-i/--identity_file`同時に使用しないでください。
- データ型: `BOOLEAN`
Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-dm-destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: tiup dm destroy
summary: tiup dm destroy`コマンドはクラスタを停止し、各サービスのログ、デプロイメント、データディレクトリを削除し、`tiup-dm`によって作成された親ディレクトリも削除します。構文は`tiup dm destroy <cluster-name> [flags]`です。オプション`-h, --helpはヘルプ情報を出力。出力はtiup-dmの実行ログです。
---

# tiup dm 破壊 {#tiup-dm-destroy}
# tiup dm destroy {#tiup-dm-destroy}

アプリケーションがオフラインになった後、クラスターが占有していたマシンを解放して他のアプリケーションで使用できるようにするには、クラスター上のデータとデプロイされたバイナリファイルをクリーンアップする必要があります。クラスターを破棄するには、 `tiup dm destroy`コマンドで以下の操作を実行します。

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-dm-prune.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: tiup dm prune
summary: クラスターをスケールさせる際、etcd内の少量のメタデータがクリーンアップされない場合がありますが、通常は問題にはなりません。必要に応じて、「tiup dm prune」コマンドを手動で実行してメタデータをクリーンアップできます。コマンド構文は「tiup dm prune <cluster-name> [flags]」です。オプション「-h, --help」を指定するとヘルプ情報が出力、クリーンアッププロセスのログが出力されます。
---

# tiup dm プルーン {#tiup-dm-prune}
# tiup dm prune {#tiup-dm-prune}

クラスターをスケールインする際(/tiup/tiup-component-dm-scale-in.md)、etcd内の少量のメタデータがクリーンアップされませんが、通常は問題ありません。メタデータをクリーンアップする必要がある場合は、 `tiup dm prune`コマンドを手動で実行してください。

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-dm-restart.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: tiup dm restart
summary: tiup dm restart`コマンドは、指定されたクラスタ内のサービスを再起動するために使用されます。再起動中は、サービスは利用できません。構文は`tiup dm restart <cluster-name> [flags]`です。オプションには、再起動するノードを指定する-N、再起動するノードの役割を指定する-R、ヘルプ情報を表示する-hがあります。出力は、サービス再起動プロセスのログです。
---

# tiup dm 再起動 {#tiup-dm-restart}
# tiup dm restart {#tiup-dm-restart}

コマンド`tiup dm restart` 、指定されたクラスターのすべてまたは一部のサービスを再起動するために使用されます。

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-dm-scale-out.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ tiup dm scale-out <cluster-name> <topology.yaml> [flags]
- データ型: `STRING`
- コマンドでこのオプションを指定しない場合は、デフォルトで`~/.ssh/id_rsa`ファイルを使用してターゲット マシンに接続します。

### -p, --パスワード {#p-password}
### -p, --password {#p-password}

- ターゲットマシンへの接続に使用するパスワードを指定します。このオプションと`-i/--identity_file`同時に使用しないでください。
- データ型: `BOOLEAN`
Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-dm-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: tiup dm start
summary: tiup dm start コマンドは、指定されたクラスタのサービスを起動するために使用されます。構文は「tiup dm start <cluster-name> [flags]」です。オプションには、ノードを指定する -N/--node、ロールを指定する -R/--role、ヘルプ情報を表示する -h/--help があります。出力はサービス起動のログです。
---

# tiup dm スタート {#tiup-dm-start}
# tiup dm start {#tiup-dm-start}

`tiup dm start`コマンドは、指定されたクラスターのサービスのすべてまたは一部を開始するために使用されます。

Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-component-dm.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ tiup dm [command] [flags]
- データ型: `UINT`
- コマンドでこのオプションを指定しない場合、各ステップの最大待機時間は`120`秒になります。

### -y, --はい {#y-yes}
### -y, --yes {#y-yes}

- すべてのリスクのある操作の2次確認をスキップします。スクリプトを使用してTiUPを呼び出す場合を除き、このオプションの使用は推奨されません。
- データ型: `BOOLEAN`
- このオプションはデフォルトで値`false`で無効になっています。このオプションを有効にするには、コマンドにこのオプションを追加し、値`true`を渡すか、値を渡さないでください。

### -v, --バージョン {#v-version}
### -v, --version {#v-version}

- TiUP DMの現在のバージョンを印刷します。
- データ型: `BOOLEAN`
Expand Down
Loading