Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
Signed-off-by: Tommy Hughes <[email protected]>
  • Loading branch information
tchughesiv committed Dec 9, 2024
1 parent d2a28e3 commit fe000b1
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
19 changes: 19 additions & 0 deletions infra/feast-operator/docs/api/asciidoc/ref.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ AuthzConfig defines the authorization settings for the deployed Feast services.
|===
| Field | Description
| *`kubernetes`* __xref:{anchor_prefix}-github.aaakk.us.kg-feast-dev-feast-infra-feast-operator-api-v1alpha1-kubernetesauthz[$$KubernetesAuthz$$]__ |
| *`oidc`* __xref:{anchor_prefix}-github.aaakk.us.kg-feast-dev-feast-infra-feast-operator-api-v1alpha1-oidcauthz[$$OidcAuthz$$]__ |
|===


Expand Down Expand Up @@ -295,6 +296,24 @@ OfflineTlsConfigs configures server TLS for the offline feast service. in an ope
|===


[id="{anchor_prefix}-github.aaakk.us.kg-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.aaakk.us.kg-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.aaakk.us.kg-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestore"]
==== OnlineStore

Expand Down
16 changes: 16 additions & 0 deletions infra/feast-operator/docs/api/markdown/ref.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ _Appears in:_
| Field | Description |
| --- | --- |
| `kubernetes` _[KubernetesAuthz](#kubernetesauthz)_ | |
| `oidc` _[OidcAuthz](#oidcauthz)_ | |


#### DefaultConfigs
Expand Down Expand Up @@ -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


Expand Down

0 comments on commit fe000b1

Please sign in to comment.