github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

CD-556 rename partition partial that's only used in CLI 

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
pull/21374/head
Aimee Ukasick 2024-06-24 14:03:33 -05:00
parent 830d1bf77f
commit 2daf499c7b
67 changed files with 74 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
website/content/api-docs/agent/index.mdx
View File

@ -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

16
website/content/api-docs/peering.mdx
View File

@ -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.
@ -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.
@ -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
@ -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
@ -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

2
website/content/commands/acl/auth-method/create.mdx
View File

@ -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'

2
website/content/commands/acl/auth-method/delete.mdx
View File

@ -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'

2
website/content/commands/acl/auth-method/list.mdx
View File

@ -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'

2
website/content/commands/acl/auth-method/read.mdx
View File

@ -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'

2
website/content/commands/acl/auth-method/update.mdx
View File

@ -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'

2
website/content/commands/acl/binding-rule/create.mdx
View File

@ -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'

2
website/content/commands/acl/binding-rule/delete.mdx
View File

@ -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'

2
website/content/commands/acl/binding-rule/list.mdx
View File

@ -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'

2
website/content/commands/acl/binding-rule/read.mdx
View File

@ -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'

2
website/content/commands/acl/binding-rule/update.mdx
View File

@ -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'

2
website/content/commands/acl/policy/create.mdx
View File

@ -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'

2
website/content/commands/acl/policy/delete.mdx
View File

@ -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'

2
website/content/commands/acl/policy/list.mdx
View File

@ -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'

2
website/content/commands/acl/policy/read.mdx
View File

@ -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'

2
website/content/commands/acl/policy/update.mdx
View File

@ -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'

2
website/content/commands/acl/role/create.mdx
View File

@ -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'

2
website/content/commands/acl/role/delete.mdx
View File

@ -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'

2
website/content/commands/acl/role/list.mdx
View File

@ -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'

2
website/content/commands/acl/role/read.mdx
View File

@ -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'

2
website/content/commands/acl/role/update.mdx
View File

@ -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'

2
website/content/commands/acl/templated-policy/preview.mdx
View File

@ -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'

2
website/content/commands/acl/token/clone.mdx
View File

@ -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'

2
website/content/commands/acl/token/create.mdx
View File

@ -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'

2
website/content/commands/acl/token/delete.mdx
View File

@ -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'

2
website/content/commands/acl/token/list.mdx
View File

@ -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'

2
website/content/commands/acl/token/read.mdx
View File

@ -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'

2
website/content/commands/acl/token/update.mdx
View File

@ -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'

2
website/content/commands/catalog/nodes.mdx
View File

@ -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

2
website/content/commands/catalog/services.mdx
View File

@ -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'

2
website/content/commands/config/delete.mdx
View File

@ -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

2
website/content/commands/config/list.mdx
View File

@ -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'

2
website/content/commands/config/read.mdx
View File

@ -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'

2
website/content/commands/config/write.mdx
View File

@ -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'

2
website/content/commands/connect/envoy.mdx
View File

@ -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'

2
website/content/commands/connect/redirect-traffic.mdx
View File

@ -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'

2
website/content/commands/intention/check.mdx
View File

@ -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'

2
website/content/commands/intention/create.mdx
View File

@ -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'

2
website/content/commands/intention/delete.mdx
View File

@ -37,7 +37,7 @@ Usage:
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx'

2
website/content/commands/intention/get.mdx
View File

@ -37,7 +37,7 @@ Usage:
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx'

2
website/content/commands/intention/match.mdx
View File

@ -40,7 +40,7 @@ Usage: `consul intention match [options] SRC_OR_DST`
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx'

2
website/content/commands/kv/delete.mdx
View File

@ -40,7 +40,7 @@ Usage: `consul kv delete [options] KEY_OR_PREFIX`
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx'

2
website/content/commands/kv/export.mdx
View File

@ -28,7 +28,7 @@ Usage: `consul kv export [options] [PREFIX]`
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx'

2
website/content/commands/kv/get.mdx
View File

@ -56,7 +56,7 @@ Usage: `consul kv get [options] [KEY_OR_PREFIX]`
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx'

2
website/content/commands/kv/import.mdx
View File

@ -31,7 +31,7 @@ Usage: `consul kv import [options] [DATA]`
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx'

2
website/content/commands/kv/put.mdx
View File

@ -59,7 +59,7 @@ Usage: `consul kv put [options] KEY [DATA]`
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx'

2
website/content/commands/members.mdx
View File

@ -56,7 +56,7 @@ Usage: `consul members [options]`
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
#### API Options

2
website/content/commands/namespace/create.mdx
View File

@ -61,7 +61,7 @@ from the CLI arguments.
#### API Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_options_client.mdx'

2
website/content/commands/namespace/delete.mdx
View File

@ -30,7 +30,7 @@ Usage: `consul namespace delete <name>`
#### API Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_options_client.mdx'

2
website/content/commands/namespace/list.mdx
View File

@ -42,7 +42,7 @@ Usage: `consul namespace list`
#### API Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_options_client.mdx'

2
website/content/commands/namespace/read.mdx
View File

@ -41,7 +41,7 @@ Usage: `consul namespace read <name>`
#### API Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_options_client.mdx'

2
website/content/commands/namespace/update.mdx
View File

@ -68,7 +68,7 @@ with the existing namespace definition.
#### API Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_options_client.mdx'

2
website/content/commands/namespace/write.mdx
View File

@ -40,7 +40,7 @@ or HCL format. See [here](/consul/docs/enterprise/namespaces#namespace-definitio
#### API Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_options_client.mdx'

2
website/content/commands/peering/delete.mdx
View File

@ -34,7 +34,7 @@ Usage: `consul peering delete [options] -name <peer name>`
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
#### API Options

2
website/content/commands/peering/establish.mdx
View File

@ -36,7 +36,7 @@ Usage: `consul peering establish [options] -name <peer name> -peering-token <tok
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
#### API Options

2
website/content/commands/peering/exported-services.mdx
View File

@ -31,7 +31,7 @@ Usage: `consul peering exported-services [options] -name <peer name>`
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
#### API Options

2
website/content/commands/peering/generate-token.mdx
View File

@ -43,7 +43,7 @@ You can specify one or more load balancers or external IPs that route external t
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
#### API Options

2
website/content/commands/peering/list.mdx
View File

@ -30,7 +30,7 @@ Usage: `consul peering list [options]`
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
#### API Options

2
website/content/commands/peering/read.mdx
View File

@ -31,7 +31,7 @@ Usage: `consul peering read [options] -name <peer name>`
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
#### API Options

2
website/content/commands/services/deregister.mdx
View File

@ -43,7 +43,7 @@ This flexibility makes it easy to pair the command with the
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx'

2
website/content/commands/services/export.mdx
View File

@ -40,7 +40,7 @@ Usage: consul services export [options] -name <service name> -consumer-peers <ot
- `-consumer-partitions=<string>` - A comma-separated list of admin partitions within the
same datacenter to export the service to. This flag is optional when `-consumer-peers` is specified.
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx'

2
website/content/commands/services/exported-services.mdx
View File

@ -32,7 +32,7 @@ Usage: `consul services exported-services [options]`
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
#### API Options

2
website/content/commands/services/register.mdx
View File

@ -78,7 +78,7 @@ The following fields specify identical parameters in a standard service definiti
#### Enterprise Options
@include 'http_api_partition_options.mdx'
@include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx'

0
website/content/partials/http_api_partition_options.mdx → website/content/partials/cli-http-api-partition-options.mdx
View File

3
website/content/partials/http-api-body-options-partition.mdx Normal file
View File

@ -0,0 +1,3 @@
- `Partition` `(string: "")` - <EnterpriseAlert inline /> The admin partition that the
peering token is generated from. Uses `default` when not specified.

2
website/content/partials/http-api-query-parms-partition.mdx Normal file
View File

@ -0,0 +1,2 @@
- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the partition of the peering
to read. If not specified, defaults to `default`.