github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

[NET-10774] Fix Group Reference in GatewayPolcy Docs (#21625) 

fix group reference for gateway policy
pull/21636/head
John Maguire 3 months ago committed by GitHub
parent
9d06fc3380
commit
0e47b380b2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 5 additions and 5 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 6
      website/content/docs/connect/gateways/api-gateway/configuration/gatewaypolicy.mdx
  2. 4
      website/content/docs/connect/gateways/api-gateway/secure-traffic/verify-jwts-k8s.mdx

6
website/content/docs/connect/gateways/api-gateway/configuration/gatewaypolicy.mdx
Unescape View File

@ -53,7 +53,7 @@ spec:
targetRef: targetRef:
name: gateway name: gateway
kind: Gateway kind: Gateway
group: gateway.networking.kubernetes.io group: gateway.networking.k8s.io/v1beta1
sectionName: <name of a specific listener the policy applies> sectionName: <name of a specific listener the policy applies>
override: override:
jwt: jwt:
@ -153,7 +153,7 @@ The following table describes the members of the `targetRef` map:
| `namespace` | Specifies the namespace that the target reference is a member of. | String | `default` | | `namespace` | Specifies the namespace that the target reference is a member of. | String | `default` |
| `name` | Specifies the name of the API gateway that the policy attaches to. | String | None | | `name` | Specifies the name of the API gateway that the policy attaches to. | String | None |
| `kind` | Specifies the type of resource that the policy attaches to. Must be set to `Gateway`. | String | None | | `kind` | Specifies the type of resource that the policy attaches to. Must be set to `Gateway`. | String | None |
| `group` | Specifies the resource group. Must be set to `gateway.networking.kubernetes.io`. | String | None | | `group` | Specifies the resource group. Must be set to `gateway.networking.k8s.io/v1beta1`. | String | None |
| `sectionName` | Specifies a part of the gateway that the policy applies to. | String | None | | `sectionName` | Specifies a part of the gateway that the policy applies to. | String | None |
### `spec.override` ### `spec.override`
@ -237,7 +237,7 @@ spec:
targetRef: targetRef:
name: gateway name: gateway
kind: Gateway kind: Gateway
group: gateway.networking.kubernetes.io group: gateway.networking.k8s.io/v1beta1
sectionName: to-server sectionName: to-server
override: override:
jwt: jwt:

4
website/content/docs/connect/gateways/api-gateway/secure-traffic/verify-jwts-k8s.mdx
Unescape View File

@ -67,7 +67,7 @@ Create a `GatewayPolicy` CRD that defines default and override settings for JWT
- `metadata.name`: Specifies a name for the policy. - `metadata.name`: Specifies a name for the policy.
- `spec.targetRef.name`: Specifies the name of the API gateway to attach the policy to. - `spec.targetRef.name`: Specifies the name of the API gateway to attach the policy to.
- `spec.targetRef.kind`: Specifies the kind of resource to attach to the policy to. Must be set to `Gateway`. - `spec.targetRef.kind`: Specifies the kind of resource to attach to the policy to. Must be set to `Gateway`.
- `spec.targetRef.group`: Specifies the resource group. Unless you have created a custom group, this should be set to `gateway.networking.kubernetes.io`. - `spec.targetRef.group`: Specifies the resource group. Unless you have created a custom group, this should be set to `gateway.networking.k8s.io/v1beta1`.
- `spec.targetRef.sectionName`: Specifies a part of the gateway that the policy applies to. - `spec.targetRef.sectionName`: Specifies a part of the gateway that the policy applies to.
- `spec.targetRef.override.jwt.providers`: Specifies a list of providers and claims used to verify requests to the gateway. The override settings take precedence over the default and route-specific JWT verification settings. - `spec.targetRef.override.jwt.providers`: Specifies a list of providers and claims used to verify requests to the gateway. The override settings take precedence over the default and route-specific JWT verification settings.
- `spec.targetRef.default.jwt.providers`: Specifies a list of default providers and claims used to verify requests to the gateway. - `spec.targetRef.default.jwt.providers`: Specifies a list of default providers and claims used to verify requests to the gateway.
@ -176,7 +176,7 @@ For more information about the fields you can configure, refer to [`RouteAuthFil
In the `filters` field of your HTTPRoute configuration, define the filter behavior that results from JWT verification. In the `filters` field of your HTTPRoute configuration, define the filter behavior that results from JWT verification.
- `type: extensionRef`: Declare list of extension references. - `type: extensionRef`: Declare list of extension references.
- `extensionRef.group`: Specifies the resource group. Unless you have created a custom group, this should be set to `gateway.networking.kubernetes.io`. - `extensionRef.group`: Specifies the resource group. Unless you have created a custom group, this should be set to `gateway.networking.k8s.io/v1beta1`.
- `extensionRef.kind`: Specifies the type of extension reference to attach to the route. Must be `RouteAuthFilter` - `extensionRef.kind`: Specifies the type of extension reference to attach to the route. Must be `RouteAuthFilter`
- `extensionRef.name`: Specifies the name of the auth filter. - `extensionRef.name`: Specifies the name of the auth filter.

Write Preview
Loading…
Cancel
Save