status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix some inconsistencies in jwt docs (#18234)

This commit is contained in:
John Maguire 2023-07-24 12:36:26 -04:00 committed by GitHub
parent efb45fe851
commit b162c51523
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
website/content/docs/connect/config-entries/jwt-provider.mdx
View File

@ -67,7 +67,7 @@ The following list outlines field hierarchy, language-specific data types, and r
<Tab heading="YAML" group="yaml"> <Tab heading="YAML" group="yaml">
- [`apiVersion`](#apiversion): string | required | must be set to `consul.hashicorp.com/v1alpha1` - [`apiVersion`](#apiversion): string | required | must be set to `consul.hashicorp.com/v1alpha1`
- [`kind`](#kind): string | required | must be set to `jwtProvider` - [`kind`](#kind): string | required | must be set to `JWTProvider`
- [`metadata`](#metadata): map | required - [`metadata`](#metadata): map | required
- [`name`](#metadata-name): string | required - [`name`](#metadata-name): string | required
- [`namespace`](#metadata-namespace): string - [`namespace`](#metadata-namespace): string
@ -289,8 +289,8 @@ CacheConfig = {
```yaml ```yaml
apiVersion: consul.hashicorp.com/v1alpha1 # required apiVersion: consul.hashicorp.com/v1alpha1 # required
kind: jwtProvider # required kind: JWTProvider # required
metadata: # required metadata: # required
name: <name-of-provider-configuration-entry> # required name: <name-of-provider-configuration-entry> # required
namespace: <namespace> namespace: <namespace>
spec: # required spec: # required

45
website/content/docs/connect/config-entries/service-intentions.mdx
View File

@ -62,20 +62,20 @@ The following outline shows how to format the service intentions configuration e
<Tab heading= "YAML" group="yaml"> <Tab heading= "YAML" group="yaml">
- [`apiVersion`](#apiversion): string | must be set to `consul.hashicorp.com/v1alpha1` - [`apiVersion`](#apiversion): string | must be set to `consul.hashicorp.com/v1alpha1`
- [`kind`](#kind): string | must be set to `ServiceIntentions` - [`kind`](#kind): string | must be set to `ServiceIntentions`
- [`metadata`](#metadata): map | required - [`metadata`](#metadata): map | required
- [`name`](#metadata-name): string | required - [`name`](#metadata-name): string | required
- [`namespace`](#metadata-namespace): string | `default` | <EnterpriseAlert inline/> - [`namespace`](#metadata-namespace): string | `default` | <EnterpriseAlert inline/>
- [`spec`](#spec): map | no default - [`spec`](#spec): map | no default
- [`destination`](#spec-destination): map | no default - [`destination`](#spec-destination): map | no default
- [`name`](#spec-destination-name): string | required - [`name`](#spec-destination-name): string | required
- [`namespace`](#metadata-namespace): string | `default` | <EnterpriseAlert inline/> - [`namespace`](#metadata-namespace): string | `default` | <EnterpriseAlert inline/>
- [`jwt`](#spec-jwt): map - [`jwt`](#spec-jwt): map
- [`providers`](#spec-jwt-providers): list of maps - [`providers`](#spec-jwt-providers): list of maps
- [`name`](#spec-jwt-providers-name): string - [`name`](#spec-jwt-providers-name): string
- [`verifyClaims`](#spec-jwt-provider-verifyclaims): list of maps - [`verifyClaims`](#spec-jwt-provider-verifyclaims): list of maps
- [`path`](#spec-jwt-provider-verifyclaims-path): list of strings - [`path`](#spec-jwt-provider-verifyclaims-path): list of strings
- [`value`](#spec-jwt-provider-verifyclaims-value): string - [`value`](#spec-jwt-provider-verifyclaims-value): string
- [`sources`](#spec-sources): list | no default - [`sources`](#spec-sources): list | no default
- [`name`](#spec-sources-name): string | no default - [`name`](#spec-sources-name): string | no default
- [`peer`](#spec-sources-peer): string | no default - [`peer`](#spec-sources-peer): string | no default
@ -86,20 +86,19 @@ The following outline shows how to format the service intentions configuration e
- [`permissions`](#spec-sources-permissions): list | no default - [`permissions`](#spec-sources-permissions): list | no default
- [`action`](#spec-sources-permissions-action): string | no default | required - [`action`](#spec-sources-permissions-action): string | no default | required
- [`http`](#spec-sources-permissions-http): map | required - [`http`](#spec-sources-permissions-http): map | required
- [`pathExact`](#spec-sources-permissions-http): string | no default - [`pathExact`](#spec-sources-permissions-http): string | no default
- [`pathPrefix`](#spec-sources-permissions-http): string | no default - [`pathPrefix`](#spec-sources-permissions-http): string | no default
- [`pathRegex`](#spec-sources-permissions-http): string | no default - [`pathRegex`](#spec-sources-permissions-http): string | no default
- [`methods`](#spec-sources-permissions-http): list | no default - [`methods`](#spec-sources-permissions-http): list | no default
- [`header`](#spec-sources-permissions-http-header): list of maps |no default - [`header`](#spec-sources-permissions-http-header): list of maps |no default
- [`name`](#spec-sources-permissions-http-header): string | required - [`name`](#spec-sources-permissions-http-header): string | required
- [`present`](#spec-sources-permissions-http-header): boolean | `false` - [`present`](#spec-sources-permissions-http-header): boolean | `false`
- [`exact`](#spec-sources-permissions-http-header): string | no default - [`exact`](#spec-sources-permissions-http-header): string | no default
- [`prefix`](#spec-sources-permissions-http-header): string | no default - [`prefix`](#spec-sources-permissions-http-header): string | no default
- [`suffix`](#spec-sources-permissions-http-header): string | no default - [`suffix`](#spec-sources-permissions-http-header): string | no default
- [`regex`](#spec-sources-permissions-http-header): string | no default - [`regex`](#spec-sources-permissions-http-header): string | no default
- [`invert`](#spec-sources-permissions-http-header): boolean | `false` - [`invert`](#spec-sources-permissions-http-header): boolean | `false`
- [`type`](#spec-sources-type): string | `consul` - [`description`](#spec-sources-description): string
- [`description`](#spec-sources-description): string
</Tab> </Tab>
</Tabs> </Tabs>
@ -195,15 +194,14 @@ Sources = [
```yaml ```yaml
apiVersion: consul.hashicorp.com/v1alpha1 apiVersion: consul.hashicorp.com/v1alpha1
kind: service-intentions kind: ServiceIntentions
metadata: metadata:
name: <name of destination service> name: <name of destination service>
namespace: <destination namespace> namespace: <destination namespace>
spec: spec:
destination: destination:
destination: name: <name of destination service>
name: <name of destination service> namespace: <destination namespace>
namespace: <destination namespace>
jwt: jwt:
providers: providers:
name: <JWT-provider-name> name: <JWT-provider-name>
@ -238,7 +236,6 @@ spec:
- name: <http header name> - name: <http header name>
regex: <regex pattern to match> regex: <regex pattern to match>
invert: false invert: false
type: consul
description: <description for API responses> description: <description for API responses>
``` ```
</Tab> </Tab>