From 488bfe3e594a5806d65914aad06a04f910fad0ad Mon Sep 17 00:00:00 2001 From: Tommy Hughes Date: Wed, 11 Dec 2024 14:56:52 -0600 Subject: [PATCH] docs Signed-off-by: Tommy Hughes --- infra/feast-operator/Makefile | 1 - .../feast-operator/docs/api/asciidoc/ref.adoc | 616 ------------------ .../asciidoctor/gv_details.tpl | 19 - .../crd-ref-templates/asciidoctor/gv_list.tpl | 19 - .../crd-ref-templates/asciidoctor/type.tpl | 35 - .../asciidoctor/type_members.tpl | 8 - 6 files changed, 698 deletions(-) delete mode 100644 infra/feast-operator/docs/api/asciidoc/ref.adoc delete mode 100644 infra/feast-operator/docs/crd-ref-templates/asciidoctor/gv_details.tpl delete mode 100644 infra/feast-operator/docs/crd-ref-templates/asciidoctor/gv_list.tpl delete mode 100644 infra/feast-operator/docs/crd-ref-templates/asciidoctor/type.tpl delete mode 100644 infra/feast-operator/docs/crd-ref-templates/asciidoctor/type_members.tpl diff --git a/infra/feast-operator/Makefile b/infra/feast-operator/Makefile index 6e86e23c56..b88574c3af 100644 --- a/infra/feast-operator/Makefile +++ b/infra/feast-operator/Makefile @@ -281,7 +281,6 @@ $(CRD_REF_DOCS): $(LOCALBIN) .PHONY: generate-ref generate-ref: generate fmt crd-ref-docs - $(CRD_REF_DOCS) --log-level=WARN --config=$(LOCALDIR)/docs/crd-ref-templates/config.yaml --source-path=$(LOCALDIR)/api/v1alpha1 --renderer=asciidoctor --templates-dir=$(LOCALDIR)/docs/crd-ref-templates/asciidoctor --output-path=$(LOCALDIR)/docs/api/asciidoc/ref.adoc $(CRD_REF_DOCS) --log-level=WARN --config=$(LOCALDIR)/docs/crd-ref-templates/config.yaml --source-path=$(LOCALDIR)/api/v1alpha1 --renderer=markdown --templates-dir=$(LOCALDIR)/docs/crd-ref-templates/markdown --output-path=$(LOCALDIR)/docs/api/markdown/ref.md .PHONY: bundle diff --git a/infra/feast-operator/docs/api/asciidoc/ref.adoc b/infra/feast-operator/docs/api/asciidoc/ref.adoc deleted file mode 100644 index 4d1b1f40bf..0000000000 --- a/infra/feast-operator/docs/api/asciidoc/ref.adoc +++ /dev/null @@ -1,616 +0,0 @@ -// Generated documentation. Please do not edit. -:anchor_prefix: k8s-api - -[id="{p}-api-reference"] -== API Reference - -.Packages -- xref:{anchor_prefix}-feast-dev-v1alpha1[$$feast.dev/v1alpha1$$] - - -[id="{anchor_prefix}-feast-dev-v1alpha1"] -=== feast.dev/v1alpha1 - -Package v1alpha1 contains API Schema definitions for the v1alpha1 API group - -.Resource Types -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestore[$$FeatureStore$$] - - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-authzconfig"] -==== AuthzConfig - -AuthzConfig defines the authorization settings for the deployed Feast services. - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestorespec[$$FeatureStoreSpec$$] -**** - -[cols="25a,75a", options="header"] -|=== -| 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$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-defaultconfigs"] -==== DefaultConfigs - -DefaultConfigs k8s container settings that are applied by default - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-localregistryconfig[$$LocalRegistryConfig$$] -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestore[$$OfflineStore$$] -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestore[$$OnlineStore$$] -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-serviceconfigs[$$ServiceConfigs$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`image`* __string__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestore"] -==== FeatureStore - -FeatureStore is the Schema for the featurestores API - - - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`apiVersion`* __string__ | `feast.dev/v1alpha1` -| *`kind`* __string__ | `FeatureStore` -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. - -| *`spec`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestorespec[$$FeatureStoreSpec$$]__ | -| *`status`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestorestatus[$$FeatureStoreStatus$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestoreref"] -==== FeatureStoreRef - -FeatureStoreRef defines which existing FeatureStore's registry should be used - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-remoteregistryconfig[$$RemoteRegistryConfig$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`name`* __string__ | Name of the FeatureStore + -| *`namespace`* __string__ | Namespace of the FeatureStore + -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestoreservices"] -==== FeatureStoreServices - -FeatureStoreServices defines the desired feast service deployments. ephemeral registry is deployed by default. - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestorespec[$$FeatureStoreSpec$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`offlineStore`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestore[$$OfflineStore$$]__ | -| *`onlineStore`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestore[$$OnlineStore$$]__ | -| *`registry`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-registry[$$Registry$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestorespec"] -==== FeatureStoreSpec - -FeatureStoreSpec defines the desired state of FeatureStore - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestore[$$FeatureStore$$] -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestorestatus[$$FeatureStoreStatus$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`feastProject`* __string__ | FeastProject is the Feast project id. This can be any alphanumeric string with underscores, but it cannot start with an underscore. Required. + -| *`services`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestoreservices[$$FeatureStoreServices$$]__ | -| *`authz`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-authzconfig[$$AuthzConfig$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestorestatus"] -==== FeatureStoreStatus - -FeatureStoreStatus defines the observed state of FeatureStore - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestore[$$FeatureStore$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`applied`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestorespec[$$FeatureStoreSpec$$]__ | Shows the currently applied feast configuration, including any pertinent defaults + -| *`clientConfigMap`* __string__ | ConfigMap in this namespace containing a client `feature_store.yaml` for this feast deployment + -| *`conditions`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#condition-v1-meta[$$Condition$$] array__ | -| *`feastVersion`* __string__ | Version of feast that's currently deployed + -| *`phase`* __string__ | -| *`serviceHostnames`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-servicehostnames[$$ServiceHostnames$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-kubernetesauthz"] -==== KubernetesAuthz - -KubernetesAuthz provides a way to define the authorization settings using Kubernetes RBAC resources. -https://kubernetes.io/docs/reference/access-authn-authz/rbac/ - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-authzconfig[$$AuthzConfig$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`roles`* __string array__ | The Kubernetes RBAC roles to be deployed in the same namespace of the FeatureStore. + -Roles are managed by the operator and created with an empty list of rules. + -See the Feast permission model at https://docs.feast.dev/getting-started/concepts/permission + -The feature store admin is not obligated to manage roles using the Feast operator, roles can be managed independently. + -This configuration option is only providing a way to automate this procedure. + -Important note: the operator cannot ensure that these roles will match the ones used in the configured Feast permissions. + -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-localregistryconfig"] -==== LocalRegistryConfig - -LocalRegistryConfig configures the deployed registry service - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-registry[$$Registry$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`image`* __string__ | -| *`env`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#envvar-v1-core[$$EnvVar$$]__ | -| *`imagePullPolicy`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#pullpolicy-v1-core[$$PullPolicy$$]__ | -| *`resources`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core[$$ResourceRequirements$$]__ | -| *`persistence`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-registrypersistence[$$RegistryPersistence$$]__ | -| *`tls`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-tlsconfigs[$$TlsConfigs$$]__ | -| *`logLevel`* __string__ | LogLevel sets the logging level for the registry service + -Allowed values: "debug", "info", "warning", "error", "critical". + -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestore"] -==== OfflineStore - -OfflineStore configures the deployed offline store service - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestoreservices[$$FeatureStoreServices$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`image`* __string__ | -| *`env`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#envvar-v1-core[$$EnvVar$$]__ | -| *`imagePullPolicy`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#pullpolicy-v1-core[$$PullPolicy$$]__ | -| *`resources`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core[$$ResourceRequirements$$]__ | -| *`persistence`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestorepersistence[$$OfflineStorePersistence$$]__ | -| *`tls`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinetlsconfigs[$$OfflineTlsConfigs$$]__ | -| *`logLevel`* __string__ | LogLevel sets the logging level for the offline store service + -Allowed values: "debug", "info", "warning", "error", "critical". + -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestoredbstorepersistence"] -==== OfflineStoreDBStorePersistence - -OfflineStoreDBStorePersistence configures the DB store persistence for the offline store service - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestorepersistence[$$OfflineStorePersistence$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`type`* __string__ | -| *`secretRef`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#localobjectreference-v1-core[$$LocalObjectReference$$]__ | Data store parameters should be placed as-is from the "feature_store.yaml" under the secret key. "registry_type" & "type" fields should be removed. + -| *`secretKeyName`* __string__ | By default, the selected store "type" is used as the SecretKeyName + -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestorefilepersistence"] -==== OfflineStoreFilePersistence - -OfflineStoreFilePersistence configures the file-based persistence for the offline store service - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestorepersistence[$$OfflineStorePersistence$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`type`* __string__ | -| *`pvc`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-pvcconfig[$$PvcConfig$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestorepersistence"] -==== OfflineStorePersistence - -OfflineStorePersistence configures the persistence settings for the offline store service - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestore[$$OfflineStore$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`file`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestorefilepersistence[$$OfflineStoreFilePersistence$$]__ | -| *`store`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestoredbstorepersistence[$$OfflineStoreDBStorePersistence$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinetlsconfigs"] -==== OfflineTlsConfigs - -OfflineTlsConfigs configures server TLS for the offline feast service. in an openshift cluster, this is configured by default using service serving certificates. - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestore[$$OfflineStore$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`secretRef`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#localobjectreference-v1-core[$$LocalObjectReference$$]__ | references the local k8s secret where the TLS key and cert reside + -| *`secretKeyNames`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-secretkeynames[$$SecretKeyNames$$]__ | -| *`disable`* __boolean__ | will disable TLS for the feast service. useful in an openshift cluster, for example, where TLS is configured by default + -| *`verifyClient`* __boolean__ | verify the client TLS certificate. + -|=== - - -[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 - -OnlineStore configures the deployed online store service - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestoreservices[$$FeatureStoreServices$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`image`* __string__ | -| *`env`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#envvar-v1-core[$$EnvVar$$]__ | -| *`imagePullPolicy`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#pullpolicy-v1-core[$$PullPolicy$$]__ | -| *`resources`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core[$$ResourceRequirements$$]__ | -| *`persistence`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestorepersistence[$$OnlineStorePersistence$$]__ | -| *`tls`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-tlsconfigs[$$TlsConfigs$$]__ | -| *`logLevel`* __string__ | LogLevel sets the logging level for the online store service + -Allowed values: "debug", "info", "warning", "error", "critical". + -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestoredbstorepersistence"] -==== OnlineStoreDBStorePersistence - -OnlineStoreDBStorePersistence configures the DB store persistence for the offline store service - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestorepersistence[$$OnlineStorePersistence$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`type`* __string__ | -| *`secretRef`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#localobjectreference-v1-core[$$LocalObjectReference$$]__ | Data store parameters should be placed as-is from the "feature_store.yaml" under the secret key. "registry_type" & "type" fields should be removed. + -| *`secretKeyName`* __string__ | By default, the selected store "type" is used as the SecretKeyName + -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestorefilepersistence"] -==== OnlineStoreFilePersistence - -OnlineStoreFilePersistence configures the file-based persistence for the offline store service - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestorepersistence[$$OnlineStorePersistence$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`path`* __string__ | -| *`pvc`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-pvcconfig[$$PvcConfig$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestorepersistence"] -==== OnlineStorePersistence - -OnlineStorePersistence configures the persistence settings for the online store service - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestore[$$OnlineStore$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`file`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestorefilepersistence[$$OnlineStoreFilePersistence$$]__ | -| *`store`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestoredbstorepersistence[$$OnlineStoreDBStorePersistence$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-optionalconfigs"] -==== OptionalConfigs - -OptionalConfigs k8s container settings that are optional - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-localregistryconfig[$$LocalRegistryConfig$$] -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestore[$$OfflineStore$$] -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestore[$$OnlineStore$$] -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-serviceconfigs[$$ServiceConfigs$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`env`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#envvar-v1-core[$$EnvVar$$]__ | -| *`imagePullPolicy`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#pullpolicy-v1-core[$$PullPolicy$$]__ | -| *`resources`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core[$$ResourceRequirements$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-pvcconfig"] -==== PvcConfig (xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-struct-ref -k8s-io-api-core-v1-localobjectreference -json-ref-omitempty- create -pvccreate -json-create-omitempty- mountpath string -json-mountpath-omitempty-[$$struct{Ref *k8s.io/api/core/v1.LocalObjectReference "json:\"ref,omitempty\""; Create *PvcCreate "json:\"create,omitempty\""; MountPath string "json:\"mountPath,omitempty\""}$$]) - -PvcConfig defines the settings for a persistent file store based on PVCs. -We can refer to an existing PVC using the `Ref` field, or create a new one using the `Create` field. - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestorefilepersistence[$$OfflineStoreFilePersistence$$] -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestorefilepersistence[$$OnlineStoreFilePersistence$$] -**** - - - - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-registry"] -==== Registry - -Registry configures the registry service. One selection is required. Local is the default setting. - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestoreservices[$$FeatureStoreServices$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`local`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-localregistryconfig[$$LocalRegistryConfig$$]__ | -| *`remote`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-remoteregistryconfig[$$RemoteRegistryConfig$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-registrydbstorepersistence"] -==== RegistryDBStorePersistence (xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-struct-type string -json-type- secretref k8s-io-api-core-v1-localobjectreference -json-secretref- secretkeyname string -json-secretkeyname-omitempty-[$$struct{Type string "json:\"type\""; SecretRef k8s.io/api/core/v1.LocalObjectReference "json:\"secretRef\""; SecretKeyName string "json:\"secretKeyName,omitempty\""}$$]) - -RegistryDBStorePersistence configures the DB store persistence for the registry service - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-registrypersistence[$$RegistryPersistence$$] -**** - - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-registryfilepersistence"] -==== RegistryFilePersistence (xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-struct-path string -json-path-omitempty- pvcconfig -pvcconfig -json-pvc-omitempty- s3additionalkwargs -map-string-string -json-s3-additional-kwargs-omitempty-[$$struct{Path string "json:\"path,omitempty\""; PvcConfig *PvcConfig "json:\"pvc,omitempty\""; S3AdditionalKwargs *map[string]string "json:\"s3_additional_kwargs,omitempty\""}$$]) - -RegistryFilePersistence configures the file-based persistence for the registry service - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-registrypersistence[$$RegistryPersistence$$] -**** - - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-registrypersistence"] -==== RegistryPersistence - -RegistryPersistence configures the persistence settings for the registry service - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-localregistryconfig[$$LocalRegistryConfig$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`file`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-registryfilepersistence[$$RegistryFilePersistence$$]__ | -| *`store`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-registrydbstorepersistence[$$RegistryDBStorePersistence$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-remoteregistryconfig"] -==== RemoteRegistryConfig - -RemoteRegistryConfig points to a remote feast registry server. When set, the operator will not deploy a registry for this FeatureStore CR. -Instead, this FeatureStore CR's online/offline services will use a remote registry. One selection is required. - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-registry[$$Registry$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`hostname`* __string__ | Host address of the remote registry service - :, e.g. `registry..svc.cluster.local:80` + -| *`feastRef`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestoreref[$$FeatureStoreRef$$]__ | Reference to an existing `FeatureStore` CR in the same k8s cluster. + -| *`tls`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-tlsremoteregistryconfigs[$$TlsRemoteRegistryConfigs$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-secretkeynames"] -==== SecretKeyNames - -SecretKeyNames defines the secret key names for the TLS key and cert. - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinetlsconfigs[$$OfflineTlsConfigs$$] -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-tlsconfigs[$$TlsConfigs$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`tlsCrt`* __string__ | defaults to "tls.crt" + -| *`tlsKey`* __string__ | defaults to "tls.key" + -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-serviceconfigs"] -==== ServiceConfigs - -ServiceConfigs k8s container settings - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-localregistryconfig[$$LocalRegistryConfig$$] -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinestore[$$OfflineStore$$] -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestore[$$OnlineStore$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`image`* __string__ | -| *`env`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#envvar-v1-core[$$EnvVar$$]__ | -| *`imagePullPolicy`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#pullpolicy-v1-core[$$PullPolicy$$]__ | -| *`resources`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core[$$ResourceRequirements$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-servicehostnames"] -==== ServiceHostnames - -ServiceHostnames defines the service hostnames in the format of :, e.g. example.svc.cluster.local:80 - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-featurestorestatus[$$FeatureStoreStatus$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`offlineStore`* __string__ | -| *`onlineStore`* __string__ | -| *`registry`* __string__ | -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-tlsconfigs"] -==== TlsConfigs - -TlsConfigs configures server TLS for a feast service. in an openshift cluster, this is configured by default using service serving certificates. - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-localregistryconfig[$$LocalRegistryConfig$$] -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-offlinetlsconfigs[$$OfflineTlsConfigs$$] -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-onlinestore[$$OnlineStore$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`secretRef`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#localobjectreference-v1-core[$$LocalObjectReference$$]__ | references the local k8s secret where the TLS key and cert reside + -| *`secretKeyNames`* __xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-secretkeynames[$$SecretKeyNames$$]__ | -| *`disable`* __boolean__ | will disable TLS for the feast service. useful in an openshift cluster, for example, where TLS is configured by default + -|=== - - -[id="{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-tlsremoteregistryconfigs"] -==== TlsRemoteRegistryConfigs - -TlsRemoteRegistryConfigs configures client TLS for a remote feast registry. in an openshift cluster, this is configured by default when the remote feast registry is using service serving certificates. - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-feast-dev-feast-infra-feast-operator-api-v1alpha1-remoteregistryconfig[$$RemoteRegistryConfig$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`configMapRef`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#localobjectreference-v1-core[$$LocalObjectReference$$]__ | references the local k8s configmap where the TLS cert resides + -| *`certName`* __string__ | defines the configmap key name for the client TLS cert. + -|=== - - diff --git a/infra/feast-operator/docs/crd-ref-templates/asciidoctor/gv_details.tpl b/infra/feast-operator/docs/crd-ref-templates/asciidoctor/gv_details.tpl deleted file mode 100644 index e039850f9b..0000000000 --- a/infra/feast-operator/docs/crd-ref-templates/asciidoctor/gv_details.tpl +++ /dev/null @@ -1,19 +0,0 @@ -{{- define "gvDetails" -}} -{{- $gv := . -}} -[id="{{ asciidocGroupVersionID $gv | asciidocRenderAnchorID }}"] -=== {{ $gv.GroupVersionString }} - -{{ $gv.Doc }} - -{{- if $gv.Kinds }} -.Resource Types -{{- range $gv.SortedKinds }} -- {{ $gv.TypeForKind . | asciidocRenderTypeLink }} -{{- end }} -{{ end }} - -{{ range $gv.SortedTypes }} -{{ template "type" . }} -{{ end }} - -{{- end -}} diff --git a/infra/feast-operator/docs/crd-ref-templates/asciidoctor/gv_list.tpl b/infra/feast-operator/docs/crd-ref-templates/asciidoctor/gv_list.tpl deleted file mode 100644 index 41c5f59b15..0000000000 --- a/infra/feast-operator/docs/crd-ref-templates/asciidoctor/gv_list.tpl +++ /dev/null @@ -1,19 +0,0 @@ -{{- define "gvList" -}} -{{- $groupVersions := . -}} - -// Generated documentation. Please do not edit. -:anchor_prefix: k8s-api - -[id="{p}-api-reference"] -== API Reference - -.Packages -{{- range $groupVersions }} -- {{ asciidocRenderGVLink . }} -{{- end }} - -{{ range $groupVersions }} -{{ template "gvDetails" . }} -{{ end }} - -{{- end -}} diff --git a/infra/feast-operator/docs/crd-ref-templates/asciidoctor/type.tpl b/infra/feast-operator/docs/crd-ref-templates/asciidoctor/type.tpl deleted file mode 100644 index 24592b540a..0000000000 --- a/infra/feast-operator/docs/crd-ref-templates/asciidoctor/type.tpl +++ /dev/null @@ -1,35 +0,0 @@ -{{- define "type" -}} -{{- $type := . -}} -{{- if asciidocShouldRenderType $type -}} - -[id="{{ asciidocTypeID $type | asciidocRenderAnchorID }}"] -==== {{ $type.Name }} {{ if $type.IsAlias }}({{ asciidocRenderTypeLink $type.UnderlyingType }}) {{ end }} - -{{ $type.Doc }} - -{{ if $type.References -}} -.Appears In: -**** -{{- range $type.SortedReferences }} -- {{ asciidocRenderTypeLink . }} -{{- end }} -**** -{{- end }} - -{{ if $type.Members -}} -[cols="25a,75a", options="header"] -|=== -| Field | Description -{{ if $type.GVK -}} -| *`apiVersion`* __string__ | `{{ $type.GVK.Group }}/{{ $type.GVK.Version }}` -| *`kind`* __string__ | `{{ $type.GVK.Kind }}` -{{ end -}} - -{{ range $type.Members -}} -| *`{{ .Name }}`* __{{ asciidocRenderType .Type }}__ | {{ template "type_members" . }} -{{ end -}} -|=== -{{ end -}} - -{{- end -}} -{{- end -}} diff --git a/infra/feast-operator/docs/crd-ref-templates/asciidoctor/type_members.tpl b/infra/feast-operator/docs/crd-ref-templates/asciidoctor/type_members.tpl deleted file mode 100644 index 7356dabe71..0000000000 --- a/infra/feast-operator/docs/crd-ref-templates/asciidoctor/type_members.tpl +++ /dev/null @@ -1,8 +0,0 @@ -{{- define "type_members" -}} -{{- $field := . -}} -{{- if eq $field.Name "metadata" -}} -Refer to Kubernetes API documentation for fields of `metadata`. -{{ else -}} -{{ asciidocRenderFieldDoc $field.Doc }} -{{- end -}} -{{- end -}}