From b162c5152348e9a3cd4dfbfbd698709e6e0f6560 Mon Sep 17 00:00:00 2001 From: John Maguire Date: Mon, 24 Jul 2023 12:36:26 -0400 Subject: [PATCH] Fix some inconsistencies in jwt docs (#18234) --- .../connect/config-entries/jwt-provider.mdx | 6 +-- .../config-entries/service-intentions.mdx | 45 +++++++++---------- 2 files changed, 24 insertions(+), 27 deletions(-) diff --git a/website/content/docs/connect/config-entries/jwt-provider.mdx b/website/content/docs/connect/config-entries/jwt-provider.mdx index 8716dde8c2..43cfee2e5e 100644 --- a/website/content/docs/connect/config-entries/jwt-provider.mdx +++ b/website/content/docs/connect/config-entries/jwt-provider.mdx @@ -67,7 +67,7 @@ The following list outlines field hierarchy, language-specific data types, and r - [`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 - [`name`](#metadata-name): string | required - [`namespace`](#metadata-namespace): string @@ -289,8 +289,8 @@ CacheConfig = { ```yaml apiVersion: consul.hashicorp.com/v1alpha1 # required -kind: jwtProvider # required -metadata: # required +kind: JWTProvider # required +metadata: # required name: # required namespace: spec: # required diff --git a/website/content/docs/connect/config-entries/service-intentions.mdx b/website/content/docs/connect/config-entries/service-intentions.mdx index 180e3aaabd..b03fa555a3 100644 --- a/website/content/docs/connect/config-entries/service-intentions.mdx +++ b/website/content/docs/connect/config-entries/service-intentions.mdx @@ -62,20 +62,20 @@ The following outline shows how to format the service intentions configuration e - [`apiVersion`](#apiversion): string | must be set to `consul.hashicorp.com/v1alpha1` -- [`kind`](#kind): string | must be set to `ServiceIntentions` -- [`metadata`](#metadata): map | required - - [`name`](#metadata-name): string | required +- [`kind`](#kind): string | must be set to `ServiceIntentions` +- [`metadata`](#metadata): map | required + - [`name`](#metadata-name): string | required - [`namespace`](#metadata-namespace): string | `default` | -- [`spec`](#spec): map | no default +- [`spec`](#spec): map | no default - [`destination`](#spec-destination): map | no default - [`name`](#spec-destination-name): string | required - [`namespace`](#metadata-namespace): string | `default` | - - [`jwt`](#spec-jwt): map - - [`providers`](#spec-jwt-providers): list of maps - - [`name`](#spec-jwt-providers-name): string - - [`verifyClaims`](#spec-jwt-provider-verifyclaims): list of maps - - [`path`](#spec-jwt-provider-verifyclaims-path): list of strings - - [`value`](#spec-jwt-provider-verifyclaims-value): string + - [`jwt`](#spec-jwt): map + - [`providers`](#spec-jwt-providers): list of maps + - [`name`](#spec-jwt-providers-name): string + - [`verifyClaims`](#spec-jwt-provider-verifyclaims): list of maps + - [`path`](#spec-jwt-provider-verifyclaims-path): list of strings + - [`value`](#spec-jwt-provider-verifyclaims-value): string - [`sources`](#spec-sources): list | no default - [`name`](#spec-sources-name): 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 - [`action`](#spec-sources-permissions-action): string | no default | required - [`http`](#spec-sources-permissions-http): map | required - - [`pathExact`](#spec-sources-permissions-http): string | no default - - [`pathPrefix`](#spec-sources-permissions-http): string | no default - - [`pathRegex`](#spec-sources-permissions-http): string | no default - - [`methods`](#spec-sources-permissions-http): list | no default - - [`header`](#spec-sources-permissions-http-header): list of maps |no default + - [`pathExact`](#spec-sources-permissions-http): string | no default + - [`pathPrefix`](#spec-sources-permissions-http): string | no default + - [`pathRegex`](#spec-sources-permissions-http): string | no default + - [`methods`](#spec-sources-permissions-http): list | no default + - [`header`](#spec-sources-permissions-http-header): list of maps |no default - [`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 - [`prefix`](#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 - - [`invert`](#spec-sources-permissions-http-header): boolean | `false` - - [`type`](#spec-sources-type): string | `consul` - - [`description`](#spec-sources-description): string + - [`invert`](#spec-sources-permissions-http-header): boolean | `false` + - [`description`](#spec-sources-description): string @@ -195,15 +194,14 @@ Sources = [ ```yaml apiVersion: consul.hashicorp.com/v1alpha1 -kind: service-intentions +kind: ServiceIntentions metadata: name: namespace: spec: destination: - destination: - name: - namespace: + name: + namespace: jwt: providers: name: @@ -238,7 +236,6 @@ spec: - name: regex: invert: false - type: consul description: ```