Skip to content

Commit 114427d

Browse files
Update docs for operator (#314)
Co-authored-by: michaeljguarino <[email protected]>
1 parent 628805b commit 114427d

File tree

1 file changed

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

1 file changed

+66
-0
lines changed

pages/deployments/operator/api.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 API group
1010

1111
### Resource Types
12+
- [Catalog](#catalog)
1213
- [Cluster](#cluster)
1314
- [ClusterRestore](#clusterrestore)
1415
- [ClusterRestoreTrigger](#clusterrestoretrigger)
@@ -49,6 +50,7 @@ Binding ...
4950

5051
_Appears in:_
5152
- [Bindings](#bindings)
53+
- [CatalogBindings](#catalogbindings)
5254
- [DeploymentSettingsBindings](#deploymentsettingsbindings)
5355
- [NotificationSinkSpec](#notificationsinkspec)
5456
- [PrAutomationBindings](#prautomationbindings)
@@ -75,6 +77,7 @@ to this resource for users/groups in the system.
7577
_Appears in:_
7678
- [ClusterSpec](#clusterspec)
7779
- [InfrastructureStackSpec](#infrastructurestackspec)
80+
- [PipelineSpec](#pipelinespec)
7881
- [ProjectSpec](#projectspec)
7982
- [ServiceSpec](#servicespec)
8083

@@ -102,6 +105,66 @@ _Appears in:_
102105
| `delete` _boolean_ | Whether you want to delete owned resources in Plural and in the targeted k8s cluster | | Optional: {} <br /> |
103106

104107

108+
#### Catalog
109+
110+
111+
112+
Catalog is the Schema for the catalogs API
113+
114+
115+
116+
117+
118+
| Field | Description | Default | Validation |
119+
| --- | --- | --- | --- |
120+
| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | |
121+
| `kind` _string_ | `Catalog` | | |
122+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
123+
| `spec` _[CatalogSpec](#catalogspec)_ | | | |
124+
125+
126+
#### CatalogBindings
127+
128+
129+
130+
CatalogBindings ...
131+
132+
133+
134+
_Appears in:_
135+
- [CatalogSpec](#catalogspec)
136+
137+
| Field | Description | Default | Validation |
138+
| --- | --- | --- | --- |
139+
| `create` _[Binding](#binding) array_ | Create bindings. | | Optional: {} <br /> |
140+
| `read` _[Binding](#binding) array_ | Read bindings. | | Optional: {} <br /> |
141+
| `write` _[Binding](#binding) array_ | Write bindings. | | Optional: {} <br /> |
142+
143+
144+
#### CatalogSpec
145+
146+
147+
148+
CatalogSpec defines the desired state of Catalog
149+
150+
151+
152+
_Appears in:_
153+
- [Catalog](#catalog)
154+
155+
| Field | Description | Default | Validation |
156+
| --- | --- | --- | --- |
157+
| `name` _string_ | | | Optional: {} <br /> |
158+
| `author` _string_ | | | Required: {} <br /> |
159+
| `icon` _string_ | An icon url to annotate this pr automation | | Optional: {} <br /> |
160+
| `darkIcon` _string_ | An darkmode icon url to annotate this pr automation | | Optional: {} <br /> |
161+
| `description` _string_ | Description is a description of this Catalog. | | Optional: {} <br />Type: string <br /> |
162+
| `category` _string_ | | | Optional: {} <br /> |
163+
| `projectRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ProjectRef owning project of the catalog, permissions will propagate down | | Optional: {} <br /> |
164+
| `tags` _object (keys:string, values:string)_ | | | Optional: {} <br /> |
165+
| `bindings` _[CatalogBindings](#catalogbindings)_ | Bindings contain read and write policies of this Catalog. | | Optional: {} <br /> |
166+
167+
105168
#### CloudProvider
106169

107170
_Underlying type:_ _string_
@@ -1541,6 +1604,7 @@ _Appears in:_
15411604
| `stages` _[PipelineStage](#pipelinestage) array_ | Stages of a pipeline. | | |
15421605
| `edges` _[PipelineEdge](#pipelineedge) array_ | Edges of a pipeline. | | |
15431606
| `projectRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ProjectRef references project this stack belongs to.<br />If not provided, it will use the default project. | | Optional: {} <br /> |
1607+
| `bindings` _[Bindings](#bindings)_ | Bindings contain read and write policies of this pipeline | | Optional: {} <br /> |
15441608

15451609

15461610
#### PipelineStage
@@ -1744,6 +1808,8 @@ _Appears in:_
17441808
| `role` _[PrRole](#prrole)_ | | | Enum: [CLUSTER SERVICE PIPELINE UPDATE UPGRADE] <br />Optional: {} <br /> |
17451809
| `addon` _string_ | Addon is a link to an addon name | | Optional: {} <br /> |
17461810
| `branch` _string_ | The base branch this pr will be based on (defaults to the repo's main branch) | | Optional: {} <br /> |
1811+
| `icon` _string_ | An icon url to annotate this pr automation | | Optional: {} <br /> |
1812+
| `darkIcon` _string_ | An darkmode icon url to annotate this pr automation | | Optional: {} <br /> |
17471813
| `documentation` _string_ | Documentation ... | | Optional: {} <br /> |
17481814
| `identifier` _string_ | Identifier is a string referencing the repository, i.e. for GitHub it would be "<organization>/<repositoryName>" | | Optional: {} <br /> |
17491815
| `message` _string_ | Message the commit message this pr will incorporate | | Optional: {} <br /> |

0 commit comments

Comments
 (0)