mirror of https://github.com/status-im/consul.git
doc: clarify the portNames used in trafficpermission V2 (#19807)
* doc: clarify the portNames used in trafficpermission V2 and fix broken links and examples
This commit is contained in:
parent
c1bbda8128
commit
b5edf5cd10
|
@ -24,10 +24,10 @@ The following list outlines field hierarchy, language-specific data types, and r
|
||||||
- [`identityName`](#spec-destination-identityname): string
|
- [`identityName`](#spec-destination-identityname): string
|
||||||
- [`action`](#spec-action): string
|
- [`action`](#spec-action): string
|
||||||
- [`permissions`](#spec-permissions): list of maps
|
- [`permissions`](#spec-permissions): list of maps
|
||||||
- [`sources`](#spec-permissions-sources): map
|
- [`sources`](#spec-permissions-sources): list of maps
|
||||||
- [`identityName`](#spec-permissions-sources-identityname): string
|
- [`identityName`](#spec-permissions-sources-identityname): string
|
||||||
- [`destinationRules`](#spec-permissions-destinationrules):
|
- [`destinationRules`](#spec-permissions-destinationrules): list of maps
|
||||||
- [`portNames`](#spec-permissions-destinationrules-portNames): array of strings
|
- [`portNames`](#spec-permissions-destinationrules-portnames): array of strings
|
||||||
|
|
||||||
## Complete configuration
|
## Complete configuration
|
||||||
|
|
||||||
|
@ -45,10 +45,10 @@ spec:
|
||||||
action: allow
|
action: allow
|
||||||
permissions:
|
permissions:
|
||||||
- sources:
|
- sources:
|
||||||
identityName: <sourceWorkloadIdentity>
|
- identityName: <sourceWorkloadIdentity>
|
||||||
destinationRules:
|
destinationRules:
|
||||||
portNames:
|
- portNames:
|
||||||
- <servicePortName>
|
- <servicePortName>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Specification
|
## Specification
|
||||||
|
@ -163,7 +163,7 @@ To specify wildcard references in this block using `*`, omit all other fields. F
|
||||||
#### Values
|
#### Values
|
||||||
|
|
||||||
- Default: None
|
- Default: None
|
||||||
- Data type: Map
|
- Data type: List of maps
|
||||||
|
|
||||||
### `spec.permissions.sources.identityName`
|
### `spec.permissions.sources.identityName`
|
||||||
|
|
||||||
|
@ -172,7 +172,7 @@ Specifies the Workload identity for the service that originates the request.
|
||||||
#### Values
|
#### Values
|
||||||
|
|
||||||
- Default: None
|
- Default: None
|
||||||
- Data type: Map
|
- Data type: String
|
||||||
|
|
||||||
### `spec.permissions.destinationRules`
|
### `spec.permissions.destinationRules`
|
||||||
|
|
||||||
|
@ -185,11 +185,11 @@ When [`spec.action`](#spec-action) _denies traffic_, Consul denies authorization
|
||||||
#### Values
|
#### Values
|
||||||
|
|
||||||
- Default: None
|
- Default: None
|
||||||
- Data type: Map
|
- Data type: List of maps
|
||||||
|
|
||||||
### `spec.permissions.destinationRules.portNames`
|
### `spec.permissions.destinationRules.portNames`
|
||||||
|
|
||||||
Specifies a port name that the Kubernetes Service exposes at the destination.
|
Specifies a port name that the Kubernetes Pod's container exposes at the destination.
|
||||||
|
|
||||||
#### Values
|
#### Values
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue