Skip to content

Commit

Permalink
CD-556 rename partition partial that's only used in CLI
Browse files Browse the repository at this point in the history
Update CLI pages for partial rename

API: Add partial for partition as body option
API: Add partial for partition as query parameter

Update API peering and members pages
  • Loading branch information
aimeeu committed Jun 24, 2024
1 parent 830d1bf commit 2daf499
Show file tree
Hide file tree
Showing 67 changed files with 74 additions and 73 deletions.
2 changes: 2 additions & 0 deletions website/content/api-docs/agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,8 @@ The corresponding CLI command is [`consul members`](/consul/commands/members).
network segment). When querying a server, setting this to the special string `_all`
will show members in all segments.

@include 'http-api-query-parms-partition.mdx'

### Sample Request

```shell-session
Expand Down
16 changes: 5 additions & 11 deletions website/content/api-docs/peering.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@ The table below shows this endpoint's support for
and configuration entries such as `service-intentions`. This field must be a
valid DNS hostname label.

- `Partition` `(string: "")` - <EnterpriseAlert inline /> The admin partition that the
peering token is generated from. Uses `default` when not specified.
@include 'http-api-body-options-partition.mdx'

- `ServerExternalAddresses` `([]string: <optional>)` - The addresses for the cluster that generates the peering token. Addresses take the form `{host or IP}:port`.
You can specify one or more load balancers or external IPs that route external traffic to this cluster's Consul servers.
Expand Down Expand Up @@ -100,9 +99,7 @@ The table below shows this endpoint's support for
and configuration entries such as `service-intentions`. This field must be a
valid DNS hostname label.

- `Partition` `(string: "")` - <EnterpriseAlert inline /> The admin partition
that peers to the cluster that generated the peering token. Uses `default`
when not specified.
@include 'http-api-body-options-partition.mdx'

- `PeeringToken` `(string: <required>)` - The peering token fetched from the
peer cluster.
Expand Down Expand Up @@ -162,8 +159,7 @@ The table below shows this endpoint's support for

### Query Parameters

- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the partition of the peering
to read. If not specified will default to `default`.
@include 'http-api-query-parms-partition.mdx'

### Sample Request

Expand Down Expand Up @@ -235,8 +231,7 @@ The table below shows this endpoint's support for

### Query Parameters

- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the partition of the peerings
to delete. If not specified will default to `default`.
@include 'http-api-query-parms-partition.mdx'

### Sample Request

Expand Down Expand Up @@ -286,8 +281,7 @@ The table below shows this endpoint's support for

### Query Parameters

- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the partition of the peerings
to list. If not specified will default to `default`.
@include 'http-api-query-parms-partition.mdx'

### Sample Request

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/auth-method/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Usage: `consul acl auth-method create [options] [args]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/auth-method/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Usage: `consul acl auth-method delete [options]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/auth-method/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Usage: `consul acl auth-method list`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/auth-method/read.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Usage: `consul acl auth-method read [options] [args]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/auth-method/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Usage: `consul acl auth-method update [options] [args]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/binding-rule/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Usage: `consul acl binding-rule create [options] [args]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/binding-rule/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Usage: `consul acl binding-rule delete [options]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/binding-rule/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Usage: `consul acl binding-rule list`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/binding-rule/read.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Usage: `consul acl binding-rule read [options] [args]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/binding-rule/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Usage: `consul acl binding-rule update [options] [args]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/policy/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Usage: `consul acl policy create [options] [args]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/policy/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Usage: `consul acl policy delete [options]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/policy/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Usage: `consul acl policy list`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/policy/read.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Usage: `consul acl policy read [options] [args]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/policy/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Usage: `consul acl policy update [options] [args]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/role/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Usage: `consul acl role create [options] [args]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/role/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Usage: `consul acl role delete [options]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/role/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Usage: `consul acl role list`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/role/read.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Usage: `consul acl role read [options] [args]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/role/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Usage: `consul acl role update [options] [args]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/templated-policy/preview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Usage: `consul acl templated-policy preview [options] [args]`

### Enterprise options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/token/clone.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Usage: `consul acl token clone [options]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/token/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Usage: `consul acl token create [options] [args]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/token/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Usage: `consul acl token delete [options]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/token/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Usage: `consul acl token list`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/token/read.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Usage: `consul acl token read [options] [args]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/acl/token/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ instead.

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/catalog/nodes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Usage: `consul catalog nodes [options]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

#### API Options

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/catalog/services.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Usage: `consul catalog services [options]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/config/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ config entry. This is used in combination with the -cas flag.

@include 'http_api_namespace_options.mdx'

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

#### API Options

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/config/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Usage: `consul config list [options]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/config/read.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Usage: `consul config read [options]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/config/write.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Usage: `consul config write [options] FILE`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/connect/envoy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ compatibility with Envoy and prevent potential issues. Default is `false`.

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/connect/redirect-traffic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Usage: `consul connect redirect-traffic [options]`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/intention/check.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Usage: `consul intention check [options] SRC DST`

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/intention/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ are not supported from commands, but may be from the corresponding HTTP endpoint

#### Enterprise Options

@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'

@include 'http_api_namespace_options.mdx'

Expand Down
Loading

0 comments on commit 2daf499

Please sign in to comment.