docs: fix name for partition resource labels (#11634)

This commit is contained in:
Chris S. Kim 2021-11-23 15:51:55 -05:00 committed by GitHub
parent b84ee47ff0
commit 9d02bc08c9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -319,7 +319,7 @@ The following table provides an overview of the resources you can use to create
| Resource | Description | Labels | | Resource | Description | Labels |
|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------| |-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
| `acl` | Controls access to ACL operations in the [ACL API](/api/acl/acl). <br/>See [ACL Resource Rules](#acl-resource-rules) for details. | No | | `acl` | Controls access to ACL operations in the [ACL API](/api/acl/acl). <br/>See [ACL Resource Rules](#acl-resource-rules) for details. | No |
| `admin_partition`<br/>`admin_partition_prefix` | <EnterpriseAlert inline /> Controls access to one or more admin partitions. <br/>See [Admin Partition Rules](#admin-partition-rules) for details. | Yes | | `partition`<br/>`partition_prefix` | <EnterpriseAlert inline /> Controls access to one or more admin partitions. <br/>See [Admin Partition Rules](#admin-partition-rules) for details. | Yes |
| `agent`<br/>`agent_prefix` | Controls access to the utility operations in the [Agent API](/api/agent), such as `join` and `leave`. <br/>See [Agent Rules](#agent-rules) for details. | Yes | | `agent`<br/>`agent_prefix` | Controls access to the utility operations in the [Agent API](/api/agent), such as `join` and `leave`. <br/>See [Agent Rules](#agent-rules) for details. | Yes |
| `event`<br/>`event_prefix` | Controls access to event operations in the [Event API](/api/event), such as firing and listing events. <br/>See [Event Rules](#event-rules) for details. | Yes | | `event`<br/>`event_prefix` | Controls access to event operations in the [Event API](/api/event), such as firing and listing events. <br/>See [Event Rules](#event-rules) for details. | Yes |
| `key`<br/>`key_prefix` &nbsp; | Controls access to key/value store operations in the [KV API](/api/kv). <br/>Can also use the `list` access level when setting the policy disposition. <br/>Has additional value options in Consul Enterprise for integrating with [Sentinel](https://docs.hashicorp.com/sentinel/consul). <br/>See [Key/Value Rules](#key-value-rules) for details. | Yes | | `key`<br/>`key_prefix` &nbsp; | Controls access to key/value store operations in the [KV API](/api/kv). <br/>Can also use the `list` access level when setting the policy disposition. <br/>Has additional value options in Consul Enterprise for integrating with [Sentinel](https://docs.hashicorp.com/sentinel/consul). <br/>See [Key/Value Rules](#key-value-rules) for details. | Yes |
@ -363,7 +363,7 @@ acl = "write"
### Admin Partition Rules <EnterpriseAlert inline /> ### Admin Partition Rules <EnterpriseAlert inline />
The `admin_partition` and `admin_partition_prefix` resource controls access to one or more admin partitions. The `partition` and `partition_prefix` resource controls access to one or more admin partitions.
You can include any number of namespace rules inside the admin partition. You can include any number of namespace rules inside the admin partition.
In the following example, the agent has write access to the `ex-namespace` namespace, as well as namespaces prefixed with `ex-` in the `example` partition. In the following example, the agent has write access to the `ex-namespace` namespace, as well as namespaces prefixed with `ex-` in the `example` partition.
@ -373,7 +373,7 @@ The `mesh` resource is also scoped to the admin partition rule, which grants `wr
<CodeBlockConfig lineNumbers> <CodeBlockConfig lineNumbers>
```hcl ```hcl
admin_partition "example" { partition "example" {
mesh = "write" mesh = "write"
node "my-node" { node "my-node" {
policy = "write" policy = "write"
@ -386,7 +386,7 @@ admin_partition "example" {
... ...
} }
} }
admin_partition_prefix "ex-" { partition_prefix "ex-" {
... (Same as above) ... (Same as above)
} }
``` ```
@ -396,7 +396,7 @@ admin_partition_prefix "ex-" {
```json ```json
{ {
"admin_partition": [{ "partition": [{
"example": [{ "example": [{
"mesh": "write", "mesh": "write",
"node": [{ "node": [{
@ -418,7 +418,7 @@ admin_partition_prefix "ex-" {
}] }]
}, },
{ {
"admin_partition_prefix": [{ "partition_prefix": [{
"": [{ "": [{
"policy": "read" "policy": "read"
}], }],