Website fixups for admin partitions (#11842)

* Website fixups for admin partitions

Signed-off-by: Mark Anderson <manderson@hashicorp.com>
This commit is contained in:
Mark Anderson 2021-12-14 17:55:21 -08:00 committed by GitHub
parent 38a45517cc
commit 9806b7c268
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
56 changed files with 128 additions and 12 deletions

View File

@ -70,6 +70,8 @@ Usage: `consul acl auth-method create [options] [args]`
verified identity attributes returned from the auth method during login to verified identity attributes returned from the auth method during login to
determine if the namespace rule applies. Added in Consul 1.8.0. determine if the namespace rule applies. Added in Consul 1.8.0.
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Create a new Kubernetes auth method: Create a new Kubernetes auth method:

View File

@ -27,6 +27,8 @@ Usage: `consul acl auth-method delete [options]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Delete an auth method: Delete an auth method:

View File

@ -30,6 +30,8 @@ Usage: `consul acl auth-method list`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Default listing. Default listing.

View File

@ -32,6 +32,8 @@ Usage: `consul acl auth-method read [options] [args]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Get auth method details: Get auth method details:

View File

@ -75,6 +75,8 @@ Usage: `consul acl auth-method update [options] [args]`
verified identity attributes returned from the auth method during login to verified identity attributes returned from the auth method during login to
determine if the namespace rule applies. Added in Consul 1.8.0. determine if the namespace rule applies. Added in Consul 1.8.0.
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Update an auth method: Update an auth method:

View File

@ -43,6 +43,8 @@ Usage: `consul acl binding-rule create [options] [args]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Create a new binding rule that binds to a service identity: Create a new binding rule that binds to a service identity:

View File

@ -28,6 +28,8 @@ Usage: `consul acl binding-rule delete [options]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Delete a binding rule: Delete a binding rule:

View File

@ -30,6 +30,8 @@ Usage: `consul acl binding-rule list`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Default listing. Default listing.

View File

@ -33,6 +33,8 @@ Usage: `consul acl binding-rule read [options] [args]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Get binding rule details: Get binding rule details:

View File

@ -50,6 +50,8 @@ Usage: `consul acl binding-rule update [options] [args]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Update a binding rule: Update a binding rule:

View File

@ -61,6 +61,8 @@ Usage: `consul acl policy create [options] [args]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Create a new policy that is valid in all datacenters: Create a new policy that is valid in all datacenters:

View File

@ -30,6 +30,8 @@ Usage: `consul acl policy delete [options]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Delete a policy: Delete a policy:

View File

@ -30,6 +30,8 @@ Usage: `consul acl policy list`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Default listing. Default listing.

View File

@ -35,6 +35,8 @@ Usage: `consul acl policy read [options] [args]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Get policy details: Get policy details:

View File

@ -52,6 +52,8 @@ Usage: `consul acl policy update [options] [args]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Update a policy: Update a policy:

View File

@ -48,6 +48,8 @@ Usage: `consul acl role create [options] [args]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Create a new role with one policy: Create a new role with one policy:

View File

@ -30,6 +30,8 @@ Usage: `consul acl role delete [options]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Delete a role by prefix: Delete a role by prefix:

View File

@ -30,6 +30,8 @@ Usage: `consul acl role list`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Default listing. Default listing.

View File

@ -35,6 +35,8 @@ Usage: `consul acl role read [options] [args]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Get role details: Get role details:

View File

@ -59,6 +59,8 @@ Usage: `consul acl role update [options] [args]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Update a role: Update a role:

View File

@ -34,6 +34,8 @@ Usage: `consul acl token clone [options]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Clone a token: Clone a token:

View File

@ -62,6 +62,8 @@ Usage: `consul acl token create [options] [args]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Create a new token: Create a new token:

View File

@ -28,6 +28,8 @@ Usage: `consul acl token delete [options]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Delete a token: Delete a token:

View File

@ -30,6 +30,8 @@ Usage: `consul acl token list`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Default listing. Default listing.

View File

@ -36,6 +36,8 @@ Usage: `consul acl token read [options] [args]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Get token details: Get token details:

View File

@ -71,6 +71,8 @@ guide.
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Update the anonymous token: Update the anonymous token:

View File

@ -76,3 +76,7 @@ Usage: `consul catalog nodes [options]`
via stdin by using `-` for the value or from a file by passing `@<file path>`. via stdin by using `-` for the value or from a file by passing `@<file path>`.
See the [`/catalog/nodes` API documentation](/api/catalog#filtering) for a See the [`/catalog/nodes` API documentation](/api/catalog#filtering) for a
description of what is filterable. description of what is filterable.
#### Enterprise Options
@include 'http_api_partition_options.mdx'

View File

@ -53,6 +53,8 @@ Usage: `consul catalog services [options]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
#### Catalog List Nodes Options #### Catalog List Nodes Options
- `-node=<id or name>` - Node `id or name` for which to list services. - `-node=<id or name>` - Node `id or name` for which to list services.

View File

@ -23,6 +23,8 @@ Usage: `consul config delete [options]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
#### Config Delete Options #### Config Delete Options
- `-kind` - Specifies the kind of the config entry to read. - `-kind` - Specifies the kind of the config entry to read.

View File

@ -23,6 +23,8 @@ Usage: `consul config list [options]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
#### Config List Options #### Config List Options
- `-kind` - Specifies the kind of the config entry to list. - `-kind` - Specifies the kind of the config entry to list.

View File

@ -24,6 +24,8 @@ Usage: `consul config read [options]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
#### Config Read Options #### Config Read Options
- `-kind` - Specifies the kind of the config entry to read. - `-kind` - Specifies the kind of the config entry to read.

View File

@ -23,6 +23,8 @@ Usage: `consul config write [options] FILE`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
#### Config Write Options #### Config Write Options
- `-cas` - Specifies to use a Check-And-Set operation. If the index is - `-cas` - Specifies to use a Check-And-Set operation. If the index is

View File

@ -175,6 +175,8 @@ proxy configuration needed.
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Assume a local service instance is registered on the local agent with a Assume a local service instance is registered on the local agent with a

View File

@ -33,15 +33,17 @@ Usage: consul connect expose [options]
#### Expose Options #### Expose Options
- `-ingress-gateway` - (Required) The name of the ingress gateway service to use. - `-ingress-gateway` - (Required) The name of the ingress gateway service to use.
A namespace can optionally be specified as a prefix via the A partition and namespace can optionally be specified as a prefix via the
'namespace/service' format '[[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 - `-port` - (Required) The listener port to use for the service on the Ingress
gateway. gateway.
- `-service` - (Required) The name of destination service to expose. A namespace - `-service` - (Required) The name of destination service to expose. A namespace
can optionally be specified as a prefix via the 'namespace/service' can optionally be specified as a prefix via the '[[partition/]namespace]/service'
format. 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'. - `-protocol` - The protocol for the service. Defaults to 'tcp'.

View File

@ -60,6 +60,8 @@ Usage: `consul connect redirect-traffic [options]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
### Basic Rules ### Basic Rules

View File

@ -35,6 +35,8 @@ Usage: `consul intention check [options] SRC DST`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
```shell-session ```shell-session

View File

@ -30,6 +30,8 @@ The `intention create` command creates or updates an L4 intention.
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
#### Intention Create Options #### Intention Create Options
- `-allow` - Set the action to "allow" for intentions. This is the default. - `-allow` - Set the action to "allow" for intentions. This is the default.

View File

@ -31,6 +31,8 @@ Usage:
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Delete an intention from "web" to "db" with any action: Delete an intention from "web" to "db" with any action:

View File

@ -31,6 +31,8 @@ Usage:
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
```shell-session ```shell-session

View File

@ -86,9 +86,12 @@ Intention commands commonly take positional arguments referred to as `SRC` and
`DST` in the command documentation. These can take several forms: `DST` in the command documentation. These can take several forms:
| Format | Meaning | | Format | Meaning |
| ----------------------- | -------------------------------------------------------------------- | | ----------------------------------- | --------------------------------------------------------------------------------------------- |
| `<service>` | the named service in the current namespace | | `<service>` | the named service in the current namespace |
| `*` | any service in the current namespace | | `*` | any service in the current namespace |
| `<namespace>/<service>` | <EnterpriseAlert inline /> the named service in a specific namespace | | `<namespace>/<service>` | <EnterpriseAlert inline /> the named service in a specific namespace in the default partition |
| `<namespace>/*` | <EnterpriseAlert inline /> any service in the specified namespace | | `<namespace>/*` | <EnterpriseAlert inline /> any service in the specified namespace in the default partition |
| `*/*` | <EnterpriseAlert inline /> any service in any namespace | | `*/*` | <EnterpriseAlert inline /> any service in any namespace in the default partition |
| `<partition>/<namespace>/<service>` | <EnterpriseAlert inline /> the named service in a specific namespace |
| `<partition>/<namespace>/*` | <EnterpriseAlert inline /> any service in the specified namespace in a specific partition |
| `<partition>/*/*` | <EnterpriseAlert inline /> any service in any namespace in the a specific partition |

View File

@ -28,6 +28,8 @@ Usage: `consul intention match [options] SRC_OR_DST`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
#### Intention Match Options #### Intention Match Options
- `-destination` - Match by destination. - `-destination` - Match by destination.

View File

@ -24,6 +24,8 @@ Usage: `consul kv delete [options] KEY_OR_PREFIX`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
#### KV Delete Options #### KV Delete Options
- `-cas` - Perform a Check-And-Set operation. Specifying this value also - `-cas` - Perform a Check-And-Set operation. Specifying this value also

View File

@ -26,6 +26,8 @@ Usage: `consul kv export [options] [PREFIX]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
To export the tree at "vault/" in the key value store: To export the tree at "vault/" in the key value store:

View File

@ -26,6 +26,8 @@ Usage: `consul kv get [options] [KEY_OR_PREFIX]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
#### KV Get Options #### KV Get Options
- `-base64` - Base 64 encode the value. The default value is false. - `-base64` - Base 64 encode the value. The default value is false.

View File

@ -29,6 +29,8 @@ Usage: `consul kv import [options] [DATA]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
To import from a file, prepend the filename with `@`: To import from a file, prepend the filename with `@`:

View File

@ -23,6 +23,8 @@ Usage: `consul kv put [options] KEY [DATA]`
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
#### KV Put Options #### KV Put Options
- `-acquire` - Obtain a lock on the key. If the key does not exist, this - `-acquire` - Obtain a lock on the key. If the key does not exist, this

View File

@ -27,6 +27,10 @@ Usage: `consul members [options]`
@include 'http_api_options_client.mdx' @include 'http_api_options_client.mdx'
#### Enterprise Options
@include 'http_api_partition_options.mdx'
#### Command Options #### Command Options
- `-detailed` - If provided, output shows more detailed information - `-detailed` - If provided, output shows more detailed information

View File

@ -25,6 +25,8 @@ from the CLI arguments.
@include 'http_api_options_server.mdx' @include 'http_api_options_server.mdx'
@include 'http_api_partition_options.mdx'
#### Command Options #### Command Options
- `-default-policy-id=<value>` - ID of a policy from the default namespace to inject for all tokens - `-default-policy-id=<value>` - ID of a policy from the default namespace to inject for all tokens

View File

@ -22,6 +22,8 @@ Usage: `consul namespace delete <name>`
@include 'http_api_options_server.mdx' @include 'http_api_options_server.mdx'
@include 'http_api_partition_options.mdx'
## Examples ## Examples
Delete a Namespace: Delete a Namespace:

View File

@ -24,6 +24,8 @@ Usage: `consul namespace list`
@include 'http_api_options_server.mdx' @include 'http_api_options_server.mdx'
@include 'http_api_partition_options.mdx'
#### Command Options #### Command Options
- `-format=<string>` - How to output the results. The choices are: pretty or json - `-format=<string>` - How to output the results. The choices are: pretty or json

View File

@ -23,6 +23,8 @@ Usage: `consul namespace read <name>`
@include 'http_api_options_server.mdx' @include 'http_api_options_server.mdx'
@include 'http_api_partition_options.mdx'
#### Command Options #### Command Options
- `-format=<string>` - How to output the results. The choices are: pretty or json - `-format=<string>` - How to output the results. The choices are: pretty or json

View File

@ -26,6 +26,8 @@ with the existing namespace definition.
@include 'http_api_options_server.mdx' @include 'http_api_options_server.mdx'
@include 'http_api_partition_options.mdx'
#### Command Options #### Command Options
- `-default-policy-id=<value>` - ID of a policy from the default namespace to inject for all tokens - `-default-policy-id=<value>` - ID of a policy from the default namespace to inject for all tokens

View File

@ -25,6 +25,8 @@ or HCL format. See [here](/docs/enterprise/namespaces#namespace-definition) for
@include 'http_api_options_server.mdx' @include 'http_api_options_server.mdx'
@include 'http_api_partition_options.mdx'
#### Command Options #### Command Options
- `-format=<string>` - How to output the results. The choices are: pretty or json - `-format=<string>` - How to output the results. The choices are: pretty or json

View File

@ -36,6 +36,8 @@ This flexibility makes it easy to pair the command with the
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
#### Service Deregistration Flags #### Service Deregistration Flags
The flags below should only be set if _no arguments_ are given. If no The flags below should only be set if _no arguments_ are given. If no

View File

@ -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_namespace_options.mdx'
@include 'http_api_partition_options.mdx'
#### Service Registration Flags #### Service Registration Flags
The flags below should only be set if _no arguments_ are given. If no The flags below should only be set if _no arguments_ are given. If no

View File

@ -0,0 +1 @@
- `-partition=<string>` - 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.