Update docs for operator (#292)

Co-authored-by: michaeljguarino <[email protected]>

pages/deployments/operator/api.md

@@ -16,6 +16,7 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
 - [DeploymentSettings](#deploymentsettings)
 - [GitRepository](#gitrepository)
 - [GlobalService](#globalservice)
+- [HelmRepository](#helmrepository)
 - [InfrastructureStack](#infrastructurestack)
 - [ManagedNamespace](#managednamespace)
 - [NamespaceCredentials](#namespacecredentials)
@@ -35,6 +36,8 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
 
 
 
+
+
 #### Binding
 
 
@@ -754,6 +757,148 @@ _Appears in:_
 
 
 
+#### HelmRepository
+
+
+
+
+
+
+
+
+
+| Field | Description | Default | Validation |
+| --- | --- | --- | --- |
+| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | |
+| `kind` _string_ | `HelmRepository` | | |
+| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |  |  |
+| `spec` _[HelmRepositorySpec](#helmrepositoryspec)_ | Spec reflects a Console API Helm repository spec. |  | Required: {} <br /> |
+
+
+#### HelmRepositoryAuth
+
+
+
+
+
+
+
+_Appears in:_
+- [HelmRepositorySpec](#helmrepositoryspec)
+
+| Field | Description | Default | Validation |
+| --- | --- | --- | --- |
+| `basic` _[HelmRepositoryAuthBasic](#helmrepositoryauthbasic)_ |  |  | Optional: {} <br /> |
+| `bearer` _[HelmRepositoryAuthBearer](#helmrepositoryauthbearer)_ |  |  | Optional: {} <br /> |
+| `aws` _[HelmRepositoryAuthAWS](#helmrepositoryauthaws)_ |  |  | Optional: {} <br /> |
+| `azure` _[HelmRepositoryAuthAzure](#helmrepositoryauthazure)_ |  |  | Optional: {} <br /> |
+| `gcp` _[HelmRepositoryAuthGCP](#helmrepositoryauthgcp)_ |  |  | Optional: {} <br /> |
+
+
+#### HelmRepositoryAuthAWS
+
+
+
+
+
+
+
+_Appears in:_
+- [HelmRepositoryAuth](#helmrepositoryauth)
+
+| Field | Description | Default | Validation |
+| --- | --- | --- | --- |
+| `accessKey` _string_ |  |  | Optional: {} <br /> |
+| `secretAccessKeySecretRef` _[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretreference-v1-core)_ | SecretAccessKeySecretRef is a secret reference that should contain secret access key. |  | Optional: {} <br /> |
+| `assumeRoleArn` _string_ |  |  | Optional: {} <br /> |
+
+
+#### HelmRepositoryAuthAzure
+
+
+
+
+
+
+
+_Appears in:_
+- [HelmRepositoryAuth](#helmrepositoryauth)
+
+| Field | Description | Default | Validation |
+| --- | --- | --- | --- |
+| `clientId` _string_ |  |  | Optional: {} <br /> |
+| `clientSecretSecretRef` _[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretreference-v1-core)_ | ClientSecretSecretRef is a secret reference that should contain client secret. |  | Optional: {} <br /> |
+| `tenantId` _string_ |  |  | Optional: {} <br /> |
+| `subscriptionId` _string_ |  |  | Optional: {} <br /> |
+
+
+#### HelmRepositoryAuthBasic
+
+
+
+
+
+
+
+_Appears in:_
+- [HelmRepositoryAuth](#helmrepositoryauth)
+
+| Field | Description | Default | Validation |
+| --- | --- | --- | --- |
+| `username` _string_ |  |  | Required: {} <br /> |
+| `passwordSecretRef` _[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretreference-v1-core)_ |  |  | Required: {} <br /> |
+
+
+#### HelmRepositoryAuthBearer
+
+
+
+
+
+
+
+_Appears in:_
+- [HelmRepositoryAuth](#helmrepositoryauth)
+
+| Field | Description | Default | Validation |
+| --- | --- | --- | --- |
+| `tokenSecretRef` _[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretreference-v1-core)_ |  |  | Required: {} <br /> |
+
+
+#### HelmRepositoryAuthGCP
+
+
+
+
+
+
+
+_Appears in:_
+- [HelmRepositoryAuth](#helmrepositoryauth)
+
+| Field | Description | Default | Validation |
+| --- | --- | --- | --- |
+| `applicationCredentialsSecretRef` _[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretreference-v1-core)_ | ApplicationCredentialsSecretRef is a secret reference that should contain application credentials. |  | Optional: {} <br /> |
+
+
+#### HelmRepositorySpec
+
+
+
+
+
+
+
+_Appears in:_
+- [HelmRepository](#helmrepository)
+
+| Field | Description | Default | Validation |
+| --- | --- | --- | --- |
+| `url` _string_ | URL of the Helm repository. |  | Required: {} <br /> |
+| `provider` _[HelmAuthProvider](#helmauthprovider)_ | Provider is the name of the Helm auth provider. |  | Enum: [BASIC BEARER GCP AZURE AWS] <br />Type: string <br /> |
+| `auth` _[HelmRepositoryAuth](#helmrepositoryauth)_ | Auth contains authentication credentials for the Helm repository. |  | Optional: {} <br /> |
+
+
 #### InfrastructureStack
 
 
@@ -794,7 +939,7 @@ _Appears in:_
 | `manageState` _boolean_ | ManageState - whether you want Plural to manage the state of this stack |  | Optional: {} <br /> |
 | `workdir` _string_ | Workdir - the working directory within the git spec you want to run commands in (useful for projects with external modules) |  | Optional: {} <br /> |
 | `jobSpec` _[JobSpec](#jobspec)_ | JobSpec optional k8s job configuration for the job that will apply this stack |  | Optional: {} <br /> |
-| `configuration` _[StackConfiguration](#stackconfiguration)_ | Configuration version/image config for the tool you're using |  | Required: {} <br /> |
+| `configuration` _[StackConfiguration](#stackconfiguration)_ | Configuration version/image config for the tool you're using |  | Optional: {} <br /> |
 | `cron` _[StackCron](#stackcron)_ | Configuration for cron generation of stack runs |  | Optional: {} <br /> |
 | `approval` _boolean_ | Approval whether to require approval |  | Optional: {} <br /> |
 | `bindings` _[Bindings](#bindings)_ | Bindings contain read and write policies of this cluster |  | Optional: {} <br /> |
@@ -1054,9 +1199,9 @@ _Appears in:_
 
 | Field | Description | Default | Validation |
 | --- | --- | --- | --- |
-| `name` _string_ | Name of the ObservabilityProvider in the Console API. |  | Required: {} <br /> |
+| `name` _string_ | Name of the ObservabilityProvider in the Console API. |  | Optional: {} <br /> |
 | `type` _[ObservabilityProviderType](#observabilityprovidertype)_ | Type of the ObservabilityProvider. |  | Enum: [DATADOG NEWRELIC] <br />Required: {} <br /> |
-| `credentials` _[ObservabilityProviderCredentials](#observabilityprovidercredentials)_ | Credentials to access the configured provider Type. |  | Required: {} <br /> |
+| `credentials` _[ObservabilityProviderCredentials](#observabilityprovidercredentials)_ | Credentials to access the configured provider Type. |  | Optional: {} <br /> |
 
 
 #### ObservableMetric
@@ -1737,6 +1882,7 @@ _Appears in:_
 
 | Field | Description | Default | Validation |
 | --- | --- | --- | --- |
+| `url` _string_ |  |  | Optional: {} <br /> |
 | `valuesFrom` _[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretreference-v1-core)_ | Fetches the helm values from a secret in this cluster, will consider any key with yaml data a values file and merge them iteratively |  | Optional: {} <br /> |
 | `valuesConfigMapRef` _[ConfigMapKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#configmapkeyselector-v1-core)_ |  |  | Optional: {} <br /> |
 | `release` _string_ | name of the helm release to use when applying |  | Optional: {} <br /> |
@@ -1890,9 +2036,9 @@ _Appears in:_
 | Field | Description | Default | Validation |
 | --- | --- | --- | --- |
 | `image` _string_ | Image optional custom image you might want to use |  | Optional: {} <br /> |
-| `version` _string_ | Version the semver of the tool you wish to use |  | Required: {} <br /> |
-| `hooks` _[StackHook](#stackhook) array_ | Hooks to run at various stages of the stack run |  | Optional: {} <br /> |
+| `version` _string_ | Version the semver of the tool you wish to use |  | Optional: {} <br /> |
 | `tag` _string_ | Tag is the docker image tag you wish to use<br />if you're customizing the version |  | Optional: {} <br /> |
+| `hooks` _[StackHook](#stackhook) array_ | Hooks to run at various stages of the stack run |  | Optional: {} <br /> |
 
 
 #### StackCron
@@ -1946,7 +2092,7 @@ _Appears in:_
 | `name` _string_ | Name of this StackDefinition. If not provided StackDefinition's own name<br />from StackDefinition.ObjectMeta will be used. |  | Optional: {} <br /> |
 | `description` _string_ | Description can be used to describe this StackDefinition. |  | Optional: {} <br /> |
 | `steps` _[CustomRunStep](#customrunstep) array_ | Steps is a list of custom run steps that will be executed as<br />part of the stack run. |  | Optional: {} <br /> |
-| `configuration` _[StackConfiguration](#stackconfiguration)_ | Configuration allows modifying the StackDefinition environment<br />and execution. |  | Required: {} <br /> |
+| `configuration` _[StackConfiguration](#stackconfiguration)_ | Configuration allows modifying the StackDefinition environment<br />and execution. |  | Optional: {} <br /> |
 
 
 #### StackEnvironment