mirror of https://github.com/status-im/consul.git
Website fixups for admin partitions (#11842)
* Website fixups for admin partitions Signed-off-by: Mark Anderson <manderson@hashicorp.com>
This commit is contained in:
parent
38a45517cc
commit
9806b7c268
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -30,6 +30,8 @@ Usage: `consul acl policy list`
|
|||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
|
||||
## Examples
|
||||
|
||||
Default listing.
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -30,6 +30,8 @@ Usage: `consul acl role list`
|
|||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
|
||||
## Examples
|
||||
|
||||
Default listing.
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -30,6 +30,8 @@ Usage: `consul acl token list`
|
|||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
|
||||
## Examples
|
||||
|
||||
Default listing.
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -71,6 +71,8 @@ guide.
|
|||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
|
||||
## Examples
|
||||
|
||||
Update the anonymous token:
|
||||
|
|
|
@ -76,3 +76,7 @@ Usage: `consul catalog nodes [options]`
|
|||
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
|
||||
description of what is filterable.
|
||||
|
||||
#### Enterprise Options
|
||||
|
||||
@include 'http_api_partition_options.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=<id or name>` - Node `id or name` for which to list services.
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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'.
|
||||
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -31,6 +31,8 @@ Usage:
|
|||
|
||||
@include 'http_api_namespace_options.mdx'
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
|
||||
## Examples
|
||||
|
||||
```shell-session
|
||||
|
|
|
@ -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 |
|
||||
| ----------------------- | -------------------------------------------------------------------- |
|
||||
| `<service>` | the named service in the current namespace |
|
||||
| `*` | any service in the current namespace |
|
||||
| `<namespace>/<service>` | <EnterpriseAlert inline /> the named service in a specific namespace |
|
||||
| `<namespace>/*` | <EnterpriseAlert inline /> any service in the specified namespace |
|
||||
| `*/*` | <EnterpriseAlert inline /> any service in any namespace |
|
||||
| Format | Meaning |
|
||||
| ----------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `<service>` | the named service in the current namespace |
|
||||
| `*` | any service in the current 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 in the default partition |
|
||||
| `*/*` | <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 |
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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 `@`:
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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=<value>` - ID of a policy from the default namespace to inject for all tokens
|
||||
|
|
|
@ -22,6 +22,8 @@ Usage: `consul namespace delete <name>`
|
|||
|
||||
@include 'http_api_options_server.mdx'
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
|
||||
## Examples
|
||||
|
||||
Delete a Namespace:
|
||||
|
|
|
@ -24,6 +24,8 @@ Usage: `consul namespace list`
|
|||
|
||||
@include 'http_api_options_server.mdx'
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
|
||||
#### Command Options
|
||||
|
||||
- `-format=<string>` - How to output the results. The choices are: pretty or json
|
||||
|
|
|
@ -23,6 +23,8 @@ Usage: `consul namespace read <name>`
|
|||
|
||||
@include 'http_api_options_server.mdx'
|
||||
|
||||
@include 'http_api_partition_options.mdx'
|
||||
|
||||
#### Command Options
|
||||
|
||||
- `-format=<string>` - How to output the results. The choices are: pretty or json
|
||||
|
|
|
@ -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=<value>` - ID of a policy from the default namespace to inject for all tokens
|
||||
|
|
|
@ -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=<string>` - How to output the results. The choices are: pretty or json
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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.
|
Loading…
Reference in New Issue