From 9806b7c268afa4d749a670911202c6c6648a39d8 Mon Sep 17 00:00:00 2001 From: Mark Anderson Date: Tue, 14 Dec 2021 17:55:21 -0800 Subject: [PATCH] Website fixups for admin partitions (#11842) * Website fixups for admin partitions Signed-off-by: Mark Anderson --- .../content/commands/acl/auth-method/create.mdx | 2 ++ .../content/commands/acl/auth-method/delete.mdx | 2 ++ .../content/commands/acl/auth-method/list.mdx | 2 ++ .../content/commands/acl/auth-method/read.mdx | 2 ++ .../content/commands/acl/auth-method/update.mdx | 2 ++ .../commands/acl/binding-rule/create.mdx | 2 ++ .../commands/acl/binding-rule/delete.mdx | 2 ++ .../content/commands/acl/binding-rule/list.mdx | 2 ++ .../content/commands/acl/binding-rule/read.mdx | 2 ++ .../commands/acl/binding-rule/update.mdx | 2 ++ website/content/commands/acl/policy/create.mdx | 2 ++ website/content/commands/acl/policy/delete.mdx | 2 ++ website/content/commands/acl/policy/list.mdx | 2 ++ website/content/commands/acl/policy/read.mdx | 2 ++ website/content/commands/acl/policy/update.mdx | 2 ++ website/content/commands/acl/role/create.mdx | 2 ++ website/content/commands/acl/role/delete.mdx | 2 ++ website/content/commands/acl/role/list.mdx | 2 ++ website/content/commands/acl/role/read.mdx | 2 ++ website/content/commands/acl/role/update.mdx | 2 ++ website/content/commands/acl/token/clone.mdx | 2 ++ website/content/commands/acl/token/create.mdx | 2 ++ website/content/commands/acl/token/delete.mdx | 2 ++ website/content/commands/acl/token/list.mdx | 2 ++ website/content/commands/acl/token/read.mdx | 2 ++ website/content/commands/acl/token/update.mdx | 2 ++ website/content/commands/catalog/nodes.mdx | 4 ++++ website/content/commands/catalog/services.mdx | 2 ++ website/content/commands/config/delete.mdx | 2 ++ website/content/commands/config/list.mdx | 2 ++ website/content/commands/config/read.mdx | 2 ++ website/content/commands/config/write.mdx | 2 ++ website/content/commands/connect/envoy.mdx | 2 ++ website/content/commands/connect/expose.mdx | 12 +++++++----- .../commands/connect/redirect-traffic.mdx | 2 ++ website/content/commands/intention/check.mdx | 2 ++ website/content/commands/intention/create.mdx | 2 ++ website/content/commands/intention/delete.mdx | 2 ++ website/content/commands/intention/get.mdx | 2 ++ website/content/commands/intention/index.mdx | 17 ++++++++++------- website/content/commands/intention/match.mdx | 2 ++ website/content/commands/kv/delete.mdx | 2 ++ website/content/commands/kv/export.mdx | 2 ++ website/content/commands/kv/get.mdx | 2 ++ website/content/commands/kv/import.mdx | 2 ++ website/content/commands/kv/put.mdx | 2 ++ website/content/commands/members.mdx | 4 ++++ website/content/commands/namespace/create.mdx | 2 ++ website/content/commands/namespace/delete.mdx | 2 ++ website/content/commands/namespace/list.mdx | 2 ++ website/content/commands/namespace/read.mdx | 2 ++ website/content/commands/namespace/update.mdx | 2 ++ website/content/commands/namespace/write.mdx | 2 ++ .../content/commands/services/deregister.mdx | 2 ++ website/content/commands/services/register.mdx | 2 ++ .../partials/http_api_partition_options.mdx | 1 + 56 files changed, 128 insertions(+), 12 deletions(-) create mode 100644 website/content/partials/http_api_partition_options.mdx diff --git a/website/content/commands/acl/auth-method/create.mdx b/website/content/commands/acl/auth-method/create.mdx index 5a24f18bc6..f6fe84eeb8 100644 --- a/website/content/commands/acl/auth-method/create.mdx +++ b/website/content/commands/acl/auth-method/create.mdx @@ -70,6 +70,8 @@ Usage: `consul acl auth-method create [options] [args]` verified identity attributes returned from the auth method during login to determine if the namespace rule applies. Added in Consul 1.8.0. +@include 'http_api_partition_options.mdx' + ## Examples Create a new Kubernetes auth method: diff --git a/website/content/commands/acl/auth-method/delete.mdx b/website/content/commands/acl/auth-method/delete.mdx index 7bd27ed20b..b0a0a10c04 100644 --- a/website/content/commands/acl/auth-method/delete.mdx +++ b/website/content/commands/acl/auth-method/delete.mdx @@ -27,6 +27,8 @@ Usage: `consul acl auth-method delete [options]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Delete an auth method: diff --git a/website/content/commands/acl/auth-method/list.mdx b/website/content/commands/acl/auth-method/list.mdx index f092f348d4..bb911a913c 100644 --- a/website/content/commands/acl/auth-method/list.mdx +++ b/website/content/commands/acl/auth-method/list.mdx @@ -30,6 +30,8 @@ Usage: `consul acl auth-method list` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Default listing. diff --git a/website/content/commands/acl/auth-method/read.mdx b/website/content/commands/acl/auth-method/read.mdx index e24a230e8e..f24c78a855 100644 --- a/website/content/commands/acl/auth-method/read.mdx +++ b/website/content/commands/acl/auth-method/read.mdx @@ -32,6 +32,8 @@ Usage: `consul acl auth-method read [options] [args]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Get auth method details: diff --git a/website/content/commands/acl/auth-method/update.mdx b/website/content/commands/acl/auth-method/update.mdx index 78712007ec..db70c72e41 100644 --- a/website/content/commands/acl/auth-method/update.mdx +++ b/website/content/commands/acl/auth-method/update.mdx @@ -75,6 +75,8 @@ Usage: `consul acl auth-method update [options] [args]` verified identity attributes returned from the auth method during login to determine if the namespace rule applies. Added in Consul 1.8.0. +@include 'http_api_partition_options.mdx' + ## Examples Update an auth method: diff --git a/website/content/commands/acl/binding-rule/create.mdx b/website/content/commands/acl/binding-rule/create.mdx index 5f69d044da..381ded2463 100644 --- a/website/content/commands/acl/binding-rule/create.mdx +++ b/website/content/commands/acl/binding-rule/create.mdx @@ -43,6 +43,8 @@ Usage: `consul acl binding-rule create [options] [args]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Create a new binding rule that binds to a service identity: diff --git a/website/content/commands/acl/binding-rule/delete.mdx b/website/content/commands/acl/binding-rule/delete.mdx index 7e9094e19f..d6ada8d9bb 100644 --- a/website/content/commands/acl/binding-rule/delete.mdx +++ b/website/content/commands/acl/binding-rule/delete.mdx @@ -28,6 +28,8 @@ Usage: `consul acl binding-rule delete [options]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Delete a binding rule: diff --git a/website/content/commands/acl/binding-rule/list.mdx b/website/content/commands/acl/binding-rule/list.mdx index 459508c085..1e7a1018cf 100644 --- a/website/content/commands/acl/binding-rule/list.mdx +++ b/website/content/commands/acl/binding-rule/list.mdx @@ -30,6 +30,8 @@ Usage: `consul acl binding-rule list` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Default listing. diff --git a/website/content/commands/acl/binding-rule/read.mdx b/website/content/commands/acl/binding-rule/read.mdx index 301b0ac515..550dc24788 100644 --- a/website/content/commands/acl/binding-rule/read.mdx +++ b/website/content/commands/acl/binding-rule/read.mdx @@ -33,6 +33,8 @@ Usage: `consul acl binding-rule read [options] [args]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Get binding rule details: diff --git a/website/content/commands/acl/binding-rule/update.mdx b/website/content/commands/acl/binding-rule/update.mdx index 163379d2b4..a424141578 100644 --- a/website/content/commands/acl/binding-rule/update.mdx +++ b/website/content/commands/acl/binding-rule/update.mdx @@ -50,6 +50,8 @@ Usage: `consul acl binding-rule update [options] [args]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Update a binding rule: diff --git a/website/content/commands/acl/policy/create.mdx b/website/content/commands/acl/policy/create.mdx index f462af9e66..9067675c49 100644 --- a/website/content/commands/acl/policy/create.mdx +++ b/website/content/commands/acl/policy/create.mdx @@ -61,6 +61,8 @@ Usage: `consul acl policy create [options] [args]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Create a new policy that is valid in all datacenters: diff --git a/website/content/commands/acl/policy/delete.mdx b/website/content/commands/acl/policy/delete.mdx index e734799718..a3c02423bf 100644 --- a/website/content/commands/acl/policy/delete.mdx +++ b/website/content/commands/acl/policy/delete.mdx @@ -30,6 +30,8 @@ Usage: `consul acl policy delete [options]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Delete a policy: diff --git a/website/content/commands/acl/policy/list.mdx b/website/content/commands/acl/policy/list.mdx index 4ee2a161b5..e463481168 100644 --- a/website/content/commands/acl/policy/list.mdx +++ b/website/content/commands/acl/policy/list.mdx @@ -30,6 +30,8 @@ Usage: `consul acl policy list` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Default listing. diff --git a/website/content/commands/acl/policy/read.mdx b/website/content/commands/acl/policy/read.mdx index d6392203bc..51a4b67dbf 100644 --- a/website/content/commands/acl/policy/read.mdx +++ b/website/content/commands/acl/policy/read.mdx @@ -35,6 +35,8 @@ Usage: `consul acl policy read [options] [args]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Get policy details: diff --git a/website/content/commands/acl/policy/update.mdx b/website/content/commands/acl/policy/update.mdx index 6f28d46c66..5aa93a05d5 100644 --- a/website/content/commands/acl/policy/update.mdx +++ b/website/content/commands/acl/policy/update.mdx @@ -52,6 +52,8 @@ Usage: `consul acl policy update [options] [args]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Update a policy: diff --git a/website/content/commands/acl/role/create.mdx b/website/content/commands/acl/role/create.mdx index a9aa21effb..f97586c7e6 100644 --- a/website/content/commands/acl/role/create.mdx +++ b/website/content/commands/acl/role/create.mdx @@ -48,6 +48,8 @@ Usage: `consul acl role create [options] [args]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Create a new role with one policy: diff --git a/website/content/commands/acl/role/delete.mdx b/website/content/commands/acl/role/delete.mdx index 396e783a1a..80762aa677 100644 --- a/website/content/commands/acl/role/delete.mdx +++ b/website/content/commands/acl/role/delete.mdx @@ -30,6 +30,8 @@ Usage: `consul acl role delete [options]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Delete a role by prefix: diff --git a/website/content/commands/acl/role/list.mdx b/website/content/commands/acl/role/list.mdx index d7eb7a3d7c..9961d5d851 100644 --- a/website/content/commands/acl/role/list.mdx +++ b/website/content/commands/acl/role/list.mdx @@ -30,6 +30,8 @@ Usage: `consul acl role list` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Default listing. diff --git a/website/content/commands/acl/role/read.mdx b/website/content/commands/acl/role/read.mdx index 9bc9a24c02..a9d5416db9 100644 --- a/website/content/commands/acl/role/read.mdx +++ b/website/content/commands/acl/role/read.mdx @@ -35,6 +35,8 @@ Usage: `consul acl role read [options] [args]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Get role details: diff --git a/website/content/commands/acl/role/update.mdx b/website/content/commands/acl/role/update.mdx index 66ef268ab0..99696e469f 100644 --- a/website/content/commands/acl/role/update.mdx +++ b/website/content/commands/acl/role/update.mdx @@ -59,6 +59,8 @@ Usage: `consul acl role update [options] [args]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Update a role: diff --git a/website/content/commands/acl/token/clone.mdx b/website/content/commands/acl/token/clone.mdx index f60ddce264..893bb56a71 100644 --- a/website/content/commands/acl/token/clone.mdx +++ b/website/content/commands/acl/token/clone.mdx @@ -34,6 +34,8 @@ Usage: `consul acl token clone [options]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Clone a token: diff --git a/website/content/commands/acl/token/create.mdx b/website/content/commands/acl/token/create.mdx index 6ebc72c4b4..760a3ee9e4 100644 --- a/website/content/commands/acl/token/create.mdx +++ b/website/content/commands/acl/token/create.mdx @@ -62,6 +62,8 @@ Usage: `consul acl token create [options] [args]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Create a new token: diff --git a/website/content/commands/acl/token/delete.mdx b/website/content/commands/acl/token/delete.mdx index 68bb438671..edd2e8ce0f 100644 --- a/website/content/commands/acl/token/delete.mdx +++ b/website/content/commands/acl/token/delete.mdx @@ -28,6 +28,8 @@ Usage: `consul acl token delete [options]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Delete a token: diff --git a/website/content/commands/acl/token/list.mdx b/website/content/commands/acl/token/list.mdx index e6d50b34ab..bca01c3698 100644 --- a/website/content/commands/acl/token/list.mdx +++ b/website/content/commands/acl/token/list.mdx @@ -30,6 +30,8 @@ Usage: `consul acl token list` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Default listing. diff --git a/website/content/commands/acl/token/read.mdx b/website/content/commands/acl/token/read.mdx index c6972c7730..584fbeed8a 100644 --- a/website/content/commands/acl/token/read.mdx +++ b/website/content/commands/acl/token/read.mdx @@ -36,6 +36,8 @@ Usage: `consul acl token read [options] [args]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Get token details: diff --git a/website/content/commands/acl/token/update.mdx b/website/content/commands/acl/token/update.mdx index 72a40c218b..00947cea29 100644 --- a/website/content/commands/acl/token/update.mdx +++ b/website/content/commands/acl/token/update.mdx @@ -71,6 +71,8 @@ guide. @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Update the anonymous token: diff --git a/website/content/commands/catalog/nodes.mdx b/website/content/commands/catalog/nodes.mdx index fe84239463..ced2d9e8e0 100644 --- a/website/content/commands/catalog/nodes.mdx +++ b/website/content/commands/catalog/nodes.mdx @@ -76,3 +76,7 @@ Usage: `consul catalog nodes [options]` via stdin by using `-` for the value or from a file by passing `@`. See the [`/catalog/nodes` API documentation](/api/catalog#filtering) for a description of what is filterable. + +#### Enterprise Options + +@include 'http_api_partition_options.mdx' diff --git a/website/content/commands/catalog/services.mdx b/website/content/commands/catalog/services.mdx index 307d571d89..fac1ae858f 100644 --- a/website/content/commands/catalog/services.mdx +++ b/website/content/commands/catalog/services.mdx @@ -53,6 +53,8 @@ Usage: `consul catalog services [options]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + #### Catalog List Nodes Options - `-node=` - Node `id or name` for which to list services. diff --git a/website/content/commands/config/delete.mdx b/website/content/commands/config/delete.mdx index 986ebeb3c0..eda5c55d7b 100644 --- a/website/content/commands/config/delete.mdx +++ b/website/content/commands/config/delete.mdx @@ -23,6 +23,8 @@ Usage: `consul config delete [options]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + #### Config Delete Options - `-kind` - Specifies the kind of the config entry to read. diff --git a/website/content/commands/config/list.mdx b/website/content/commands/config/list.mdx index b65d50ea04..64072dcf40 100644 --- a/website/content/commands/config/list.mdx +++ b/website/content/commands/config/list.mdx @@ -23,6 +23,8 @@ Usage: `consul config list [options]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + #### Config List Options - `-kind` - Specifies the kind of the config entry to list. diff --git a/website/content/commands/config/read.mdx b/website/content/commands/config/read.mdx index 76ef8b92cd..b9e1bd29f2 100644 --- a/website/content/commands/config/read.mdx +++ b/website/content/commands/config/read.mdx @@ -24,6 +24,8 @@ Usage: `consul config read [options]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + #### Config Read Options - `-kind` - Specifies the kind of the config entry to read. diff --git a/website/content/commands/config/write.mdx b/website/content/commands/config/write.mdx index fe7afaa817..36708694d9 100644 --- a/website/content/commands/config/write.mdx +++ b/website/content/commands/config/write.mdx @@ -23,6 +23,8 @@ Usage: `consul config write [options] FILE` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + #### Config Write Options - `-cas` - Specifies to use a Check-And-Set operation. If the index is diff --git a/website/content/commands/connect/envoy.mdx b/website/content/commands/connect/envoy.mdx index b6a5ee8e7b..468ed8210f 100644 --- a/website/content/commands/connect/envoy.mdx +++ b/website/content/commands/connect/envoy.mdx @@ -175,6 +175,8 @@ proxy configuration needed. @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Assume a local service instance is registered on the local agent with a diff --git a/website/content/commands/connect/expose.mdx b/website/content/commands/connect/expose.mdx index 779b308fe0..dc802355e9 100644 --- a/website/content/commands/connect/expose.mdx +++ b/website/content/commands/connect/expose.mdx @@ -2,7 +2,7 @@ layout: commands page_title: 'Commands: Connect Expose' description: > - The connect expose subcommand is used to expose a Connect-enabled service + The connect expose subcommand is used to expose a Connect-enabled service through an Ingress gateway by modifying the gateway's configuration and adding an intention to allow traffic from the gateway to the service. --- @@ -33,15 +33,17 @@ Usage: consul connect expose [options] #### Expose Options - `-ingress-gateway` - (Required) The name of the ingress gateway service to use. - A namespace can optionally be specified as a prefix via the - 'namespace/service' format + A partition and namespace can optionally be specified as a prefix via the + '[[partition/]namespace]/service' format. If a partition is not specified 'default' is assumed. + If a partition is specified a namespace must be specified. Partitions and namespaces are Enterprise features. - `-port` - (Required) The listener port to use for the service on the Ingress gateway. - `-service` - (Required) The name of destination service to expose. A namespace - can optionally be specified as a prefix via the 'namespace/service' - format. + can optionally be specified as a prefix via the '[[partition/]namespace]/service' + format. If a partition is not specified 'default' is assumed. + If a partition is specified a namespace must be specified. Partitions and namespaces are Enterprise features. - `-protocol` - The protocol for the service. Defaults to 'tcp'. diff --git a/website/content/commands/connect/redirect-traffic.mdx b/website/content/commands/connect/redirect-traffic.mdx index 6fd7c46c37..27313d5367 100644 --- a/website/content/commands/connect/redirect-traffic.mdx +++ b/website/content/commands/connect/redirect-traffic.mdx @@ -60,6 +60,8 @@ Usage: `consul connect redirect-traffic [options]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples ### Basic Rules diff --git a/website/content/commands/intention/check.mdx b/website/content/commands/intention/check.mdx index fb84900b53..3469661607 100644 --- a/website/content/commands/intention/check.mdx +++ b/website/content/commands/intention/check.mdx @@ -35,6 +35,8 @@ Usage: `consul intention check [options] SRC DST` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples ```shell-session diff --git a/website/content/commands/intention/create.mdx b/website/content/commands/intention/create.mdx index fdc8c7ec7f..c741bff513 100644 --- a/website/content/commands/intention/create.mdx +++ b/website/content/commands/intention/create.mdx @@ -30,6 +30,8 @@ The `intention create` command creates or updates an L4 intention. @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + #### Intention Create Options - `-allow` - Set the action to "allow" for intentions. This is the default. diff --git a/website/content/commands/intention/delete.mdx b/website/content/commands/intention/delete.mdx index d1fe6bb511..a0f35af65d 100644 --- a/website/content/commands/intention/delete.mdx +++ b/website/content/commands/intention/delete.mdx @@ -31,6 +31,8 @@ Usage: @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Delete an intention from "web" to "db" with any action: diff --git a/website/content/commands/intention/get.mdx b/website/content/commands/intention/get.mdx index f37c321b1f..c455028e62 100644 --- a/website/content/commands/intention/get.mdx +++ b/website/content/commands/intention/get.mdx @@ -31,6 +31,8 @@ Usage: @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples ```shell-session diff --git a/website/content/commands/intention/index.mdx b/website/content/commands/intention/index.mdx index e45f60dad7..8ba1dd9964 100644 --- a/website/content/commands/intention/index.mdx +++ b/website/content/commands/intention/index.mdx @@ -85,10 +85,13 @@ $ consul intention match db Intention commands commonly take positional arguments referred to as `SRC` and `DST` in the command documentation. These can take several forms: -| Format | Meaning | -| ----------------------- | -------------------------------------------------------------------- | -| `` | the named service in the current namespace | -| `*` | any service in the current namespace | -| `/` | the named service in a specific namespace | -| `/*` | any service in the specified namespace | -| `*/*` | any service in any namespace | +| Format | Meaning | +| ----------------------------------- | --------------------------------------------------------------------------------------------- | +| `` | the named service in the current namespace | +| `*` | any service in the current namespace | +| `/` | the named service in a specific namespace in the default partition | +| `/*` | any service in the specified namespace in the default partition | +| `*/*` | any service in any namespace in the default partition | +| `//` | the named service in a specific namespace | +| `//*` | any service in the specified namespace in a specific partition | +| `/*/*` | any service in any namespace in the a specific partition | diff --git a/website/content/commands/intention/match.mdx b/website/content/commands/intention/match.mdx index d210bc432d..99ad3d32b4 100644 --- a/website/content/commands/intention/match.mdx +++ b/website/content/commands/intention/match.mdx @@ -28,6 +28,8 @@ Usage: `consul intention match [options] SRC_OR_DST` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + #### Intention Match Options - `-destination` - Match by destination. diff --git a/website/content/commands/kv/delete.mdx b/website/content/commands/kv/delete.mdx index c09a1d5da7..7c5092108d 100644 --- a/website/content/commands/kv/delete.mdx +++ b/website/content/commands/kv/delete.mdx @@ -24,6 +24,8 @@ Usage: `consul kv delete [options] KEY_OR_PREFIX` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + #### KV Delete Options - `-cas` - Perform a Check-And-Set operation. Specifying this value also diff --git a/website/content/commands/kv/export.mdx b/website/content/commands/kv/export.mdx index 52db1e6fd1..ce6f1e6bff 100644 --- a/website/content/commands/kv/export.mdx +++ b/website/content/commands/kv/export.mdx @@ -26,6 +26,8 @@ Usage: `consul kv export [options] [PREFIX]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples To export the tree at "vault/" in the key value store: diff --git a/website/content/commands/kv/get.mdx b/website/content/commands/kv/get.mdx index 3cc726b7ad..c2f8bf913a 100644 --- a/website/content/commands/kv/get.mdx +++ b/website/content/commands/kv/get.mdx @@ -26,6 +26,8 @@ Usage: `consul kv get [options] [KEY_OR_PREFIX]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + #### KV Get Options - `-base64` - Base 64 encode the value. The default value is false. diff --git a/website/content/commands/kv/import.mdx b/website/content/commands/kv/import.mdx index 9667700357..6c5f1f1ee3 100644 --- a/website/content/commands/kv/import.mdx +++ b/website/content/commands/kv/import.mdx @@ -29,6 +29,8 @@ Usage: `consul kv import [options] [DATA]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + ## Examples To import from a file, prepend the filename with `@`: diff --git a/website/content/commands/kv/put.mdx b/website/content/commands/kv/put.mdx index 931b9bc805..76778d088e 100644 --- a/website/content/commands/kv/put.mdx +++ b/website/content/commands/kv/put.mdx @@ -23,6 +23,8 @@ Usage: `consul kv put [options] KEY [DATA]` @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + #### KV Put Options - `-acquire` - Obtain a lock on the key. If the key does not exist, this diff --git a/website/content/commands/members.mdx b/website/content/commands/members.mdx index d41e426a57..5819f70a48 100644 --- a/website/content/commands/members.mdx +++ b/website/content/commands/members.mdx @@ -27,6 +27,10 @@ Usage: `consul members [options]` @include 'http_api_options_client.mdx' +#### Enterprise Options + +@include 'http_api_partition_options.mdx' + #### Command Options - `-detailed` - If provided, output shows more detailed information diff --git a/website/content/commands/namespace/create.mdx b/website/content/commands/namespace/create.mdx index abc09299c1..f79db884ac 100644 --- a/website/content/commands/namespace/create.mdx +++ b/website/content/commands/namespace/create.mdx @@ -25,6 +25,8 @@ from the CLI arguments. @include 'http_api_options_server.mdx' +@include 'http_api_partition_options.mdx' + #### Command Options - `-default-policy-id=` - ID of a policy from the default namespace to inject for all tokens diff --git a/website/content/commands/namespace/delete.mdx b/website/content/commands/namespace/delete.mdx index 59b6a834b5..3bd4afab92 100644 --- a/website/content/commands/namespace/delete.mdx +++ b/website/content/commands/namespace/delete.mdx @@ -22,6 +22,8 @@ Usage: `consul namespace delete ` @include 'http_api_options_server.mdx' +@include 'http_api_partition_options.mdx' + ## Examples Delete a Namespace: diff --git a/website/content/commands/namespace/list.mdx b/website/content/commands/namespace/list.mdx index 1486547cd1..fdbbb25d83 100644 --- a/website/content/commands/namespace/list.mdx +++ b/website/content/commands/namespace/list.mdx @@ -24,6 +24,8 @@ Usage: `consul namespace list` @include 'http_api_options_server.mdx' +@include 'http_api_partition_options.mdx' + #### Command Options - `-format=` - How to output the results. The choices are: pretty or json diff --git a/website/content/commands/namespace/read.mdx b/website/content/commands/namespace/read.mdx index c4fc1ad73b..d114a8eaf0 100644 --- a/website/content/commands/namespace/read.mdx +++ b/website/content/commands/namespace/read.mdx @@ -23,6 +23,8 @@ Usage: `consul namespace read ` @include 'http_api_options_server.mdx' +@include 'http_api_partition_options.mdx' + #### Command Options - `-format=` - How to output the results. The choices are: pretty or json diff --git a/website/content/commands/namespace/update.mdx b/website/content/commands/namespace/update.mdx index 8470499318..b2c79f9bfc 100644 --- a/website/content/commands/namespace/update.mdx +++ b/website/content/commands/namespace/update.mdx @@ -26,6 +26,8 @@ with the existing namespace definition. @include 'http_api_options_server.mdx' +@include 'http_api_partition_options.mdx' + #### Command Options - `-default-policy-id=` - ID of a policy from the default namespace to inject for all tokens diff --git a/website/content/commands/namespace/write.mdx b/website/content/commands/namespace/write.mdx index 51b47504db..31f0a9a389 100644 --- a/website/content/commands/namespace/write.mdx +++ b/website/content/commands/namespace/write.mdx @@ -25,6 +25,8 @@ or HCL format. See [here](/docs/enterprise/namespaces#namespace-definition) for @include 'http_api_options_server.mdx' +@include 'http_api_partition_options.mdx' + #### Command Options - `-format=` - How to output the results. The choices are: pretty or json diff --git a/website/content/commands/services/deregister.mdx b/website/content/commands/services/deregister.mdx index 6a50522c2a..a6e3fd996a 100644 --- a/website/content/commands/services/deregister.mdx +++ b/website/content/commands/services/deregister.mdx @@ -36,6 +36,8 @@ This flexibility makes it easy to pair the command with the @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + #### Service Deregistration Flags The flags below should only be set if _no arguments_ are given. If no diff --git a/website/content/commands/services/register.mdx b/website/content/commands/services/register.mdx index a70788fb05..70e686f79b 100644 --- a/website/content/commands/services/register.mdx +++ b/website/content/commands/services/register.mdx @@ -55,6 +55,8 @@ or lost, services registered with this command will need to be reregistered. @include 'http_api_namespace_options.mdx' +@include 'http_api_partition_options.mdx' + #### Service Registration Flags The flags below should only be set if _no arguments_ are given. If no diff --git a/website/content/partials/http_api_partition_options.mdx b/website/content/partials/http_api_partition_options.mdx new file mode 100644 index 0000000000..a290c38201 --- /dev/null +++ b/website/content/partials/http_api_partition_options.mdx @@ -0,0 +1 @@ +- `-partition=` - Specifies the partition to query. If not provided, the partition will be inferred from the request's ACL token, or will default to the `default` partition. Partitions are a Consul Enterprise feature added in v1.11.0.