Skip to content

Commit be89268

Browse files
Update docs for operator (#345)
Co-authored-by: michaeljguarino <[email protected]>
1 parent 9043422 commit be89268

File tree

1 file changed

+56
-0
lines changed
  • pages/deployments/operator

1 file changed

+56
-0
lines changed

pages/deployments/operator/api.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
1515
- [ClusterRestoreTrigger](#clusterrestoretrigger)
1616
- [CustomStackRun](#customstackrun)
1717
- [DeploymentSettings](#deploymentsettings)
18+
- [GeneratedSecret](#generatedsecret)
1819
- [GitRepository](#gitrepository)
1920
- [GlobalService](#globalservice)
2021
- [HelmRepository](#helmrepository)
@@ -768,6 +769,60 @@ _Appears in:_
768769
| `job` _[JobSpec](#jobspec)_ | | | Optional: {} <br /> |
769770

770771

772+
#### GeneratedSecret
773+
774+
775+
776+
GeneratedSecret is the Schema for the generatedsecrets API
777+
778+
779+
780+
781+
782+
| Field | Description | Default | Validation |
783+
| --- | --- | --- | --- |
784+
| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | |
785+
| `kind` _string_ | `GeneratedSecret` | | |
786+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
787+
| `spec` _[GeneratedSecretSpec](#generatedsecretspec)_ | | | |
788+
789+
790+
#### GeneratedSecretDestination
791+
792+
793+
794+
795+
796+
797+
798+
_Appears in:_
799+
- [GeneratedSecretSpec](#generatedsecretspec)
800+
801+
| Field | Description | Default | Validation |
802+
| --- | --- | --- | --- |
803+
| `name` _string_ | | | |
804+
| `namespace` _string_ | | | |
805+
806+
807+
#### GeneratedSecretSpec
808+
809+
810+
811+
GeneratedSecretSpec defines the desired state of GeneratedSecret
812+
813+
814+
815+
_Appears in:_
816+
- [GeneratedSecret](#generatedsecret)
817+
818+
| Field | Description | Default | Validation |
819+
| --- | --- | --- | --- |
820+
| `template` _object (keys:string, values:string)_ | Template secret data in string form. | | |
821+
| `destinations` _[GeneratedSecretDestination](#generatedsecretdestination) array_ | Destinations describe name/namespace for the secrets. | | |
822+
823+
824+
825+
771826
#### GitHealth
772827

773828
_Underlying type:_ _string_
@@ -2662,6 +2717,7 @@ _Appears in:_
26622717

26632718
_Appears in:_
26642719
- [ClusterStatus](#clusterstatus)
2720+
- [GeneratedSecretStatus](#generatedsecretstatus)
26652721
- [GitRepositoryStatus](#gitrepositorystatus)
26662722
- [ServiceStatus](#servicestatus)
26672723

0 commit comments

Comments
 (0)