docs: remove partition subcommand usage headings

This commit is contained in:
Jared Kirschner 2022-04-06 15:18:54 -07:00
parent bfe79b7b34
commit 903c71618a
1 changed files with 2 additions and 31 deletions

View File

@ -77,12 +77,6 @@ This subcommand has the following characteristics:
| [Blocking Queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint | | [Blocking Queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint |
| [Agent Caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint | | [Agent Caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint |
#### Usage
```shell-session
consul partition create <OPTIONS>
```
The admin partition is created according to the values specified in the options. You can specify the following options: The admin partition is created according to the values specified in the options. You can specify the following options:
| Option | Description | Default | Required | | Option | Description | Default | Required |
@ -107,7 +101,7 @@ $ consul partition create -name "webdev" -description "Partition for admin of we
### `write` ### `write`
The `write` subcommand sends a request to the server to create a new admin partition or update an existing partition from its full definition. The `write` subcommand sends a request to the server to create a new admin partition or update an existing partition from its full definition. You can specify an admin partition definition file or use values from `stdin`.
This subcommand has the following characteristics: This subcommand has the following characteristics:
| Characteristic | Value | | Characteristic | Value |
@ -117,11 +111,6 @@ This subcommand has the following characteristics:
| [Blocking Queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint | | [Blocking Queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint |
| [Agent Caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint | | [Agent Caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint |
#### Usage
You can specify an admin partition definition file or use values from `stdin`
in either JSON or HCL format.
Use the following syntax to write from file: Use the following syntax to write from file:
```shell-session ```shell-session
@ -134,7 +123,7 @@ Use the following syntax to write from `stdin`:
consul partition write <OPTIONS> - consul partition write <OPTIONS> -
``` ```
Refer to the [Admin Partition Definition](#partition-definition) section for details about the supported parameters. The definition file or `stdin` values can be provided in JSON or HCL format. Refer to the [Admin Partition Definition](#admin-partition-definition) section for details about the supported parameters.
You can specify the following options: You can specify the following options:
@ -168,12 +157,6 @@ This subcommand has the following characteristics:
| [Blocking Queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint | | [Blocking Queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint |
| [Agent Caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint | | [Agent Caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint |
#### Usage
```shell-session
consul partition read <OPTIONS> <PARTITION_NAME>
```
The admin partition is created according to the values specified in the options. You can specify the following options: The admin partition is created according to the values specified in the options. You can specify the following options:
| Option | Description | Default | Required | | Option | Description | Default | Required |
@ -205,12 +188,6 @@ This subcommand has the following characteristics:
| [Blocking Queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint | | [Blocking Queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint |
| [Agent Caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint | | [Agent Caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint |
#### Usage
```shell-session
consul partition list <OPTIONS>
```
The admin partition is created according to the values specified in the options. You can specify the following options: The admin partition is created according to the values specified in the options. You can specify the following options:
| Option | Description | Default | Required | | Option | Description | Default | Required |
@ -256,12 +233,6 @@ This subcommand has the following characteristics:
| [Blocking Queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint | | [Blocking Queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint |
| [Agent Caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint | | [Agent Caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint |
#### Usage
```shell-session
$ consul partition delete <PARTITION_NAME>
```
In the following example, the `webdev-bu` partition is deleted: In the following example, the `webdev-bu` partition is deleted:
```shell-session ```shell-session