From fe000b1ac123ea02decc1f2c6adfafee6bfb639e Mon Sep 17 00:00:00 2001 From: Tommy Hughes Date: Wed, 4 Dec 2024 08:49:57 -0600 Subject: [PATCH] docs Signed-off-by: Tommy Hughes --- .../feast-operator/docs/api/asciidoc/ref.adoc | 19 +++++++++++++++++++ infra/feast-operator/docs/api/markdown/ref.md | 16 ++++++++++++++++ 2 files changed, 35 insertions(+) diff --git a/infra/feast-operator/docs/api/asciidoc/ref.adoc b/infra/feast-operator/docs/api/asciidoc/ref.adoc index c282e324f94..a9c488f342a 100644 --- a/infra/feast-operator/docs/api/asciidoc/ref.adoc +++ b/infra/feast-operator/docs/api/asciidoc/ref.adoc @@ -32,6 +32,7 @@ AuthzConfig defines the authorization settings for the deployed Feast services. |=== | Field | Description | *`kubernetes`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-kubernetesauthz[$$KubernetesAuthz$$]__ | +| *`oidc`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-oidcauthz[$$OidcAuthz$$]__ | |=== @@ -295,6 +296,24 @@ OfflineTlsConfigs configures server TLS for the offline feast service. in an ope |=== +[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-oidcauthz"] +==== OidcAuthz + +OidcAuthz defines the authorization settings for deployments using an Open ID Connect identity provider. +https://auth0.com/docs/authenticate/protocols/openid-connect-protocol + +.Appears In: +**** +- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-authzconfig[$$AuthzConfig$$] +**** + +[cols="25a,75a", options="header"] +|=== +| Field | Description +| *`secretRef`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#localobjectreference-v1-core[$$LocalObjectReference$$]__ | +|=== + + [id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestore"] ==== OnlineStore diff --git a/infra/feast-operator/docs/api/markdown/ref.md b/infra/feast-operator/docs/api/markdown/ref.md index d1d658b65fa..f66c8bfcc3f 100644 --- a/infra/feast-operator/docs/api/markdown/ref.md +++ b/infra/feast-operator/docs/api/markdown/ref.md @@ -25,6 +25,7 @@ _Appears in:_ | Field | Description | | --- | --- | | `kubernetes` _[KubernetesAuthz](#kubernetesauthz)_ | | +| `oidc` _[OidcAuthz](#oidcauthz)_ | | #### DefaultConfigs @@ -249,6 +250,21 @@ _Appears in:_ | `verifyClient` _boolean_ | verify the client TLS certificate. | +#### OidcAuthz + + + +OidcAuthz defines the authorization settings for deployments using an Open ID Connect identity provider. +https://auth0.com/docs/authenticate/protocols/openid-connect-protocol + +_Appears in:_ +- [AuthzConfig](#authzconfig) + +| Field | Description | +| --- | --- | +| `secretRef` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#localobjectreference-v1-core)_ | | + + #### OnlineStore