Skip to content

Commit

Permalink
Update docs for operator (#314)
Browse files Browse the repository at this point in the history
Co-authored-by: michaeljguarino <[email protected]>
  • Loading branch information
github-actions[bot] and michaeljguarino authored Oct 12, 2024
1 parent 628805b commit 114427d
Showing 1 changed file with 66 additions and 0 deletions.
66 changes: 66 additions & 0 deletions pages/deployments/operator/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 API group

### Resource Types
- [Catalog](#catalog)
- [Cluster](#cluster)
- [ClusterRestore](#clusterrestore)
- [ClusterRestoreTrigger](#clusterrestoretrigger)
Expand Down Expand Up @@ -49,6 +50,7 @@ Binding ...

_Appears in:_
- [Bindings](#bindings)
- [CatalogBindings](#catalogbindings)
- [DeploymentSettingsBindings](#deploymentsettingsbindings)
- [NotificationSinkSpec](#notificationsinkspec)
- [PrAutomationBindings](#prautomationbindings)
Expand All @@ -75,6 +77,7 @@ to this resource for users/groups in the system.
_Appears in:_
- [ClusterSpec](#clusterspec)
- [InfrastructureStackSpec](#infrastructurestackspec)
- [PipelineSpec](#pipelinespec)
- [ProjectSpec](#projectspec)
- [ServiceSpec](#servicespec)

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


#### Catalog



Catalog is the Schema for the catalogs API





| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | |
| `kind` _string_ | `Catalog` | | |
| `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` _[CatalogSpec](#catalogspec)_ | | | |


#### CatalogBindings



CatalogBindings ...



_Appears in:_
- [CatalogSpec](#catalogspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `create` _[Binding](#binding) array_ | Create bindings. | | Optional: {} <br /> |
| `read` _[Binding](#binding) array_ | Read bindings. | | Optional: {} <br /> |
| `write` _[Binding](#binding) array_ | Write bindings. | | Optional: {} <br /> |


#### CatalogSpec



CatalogSpec defines the desired state of Catalog



_Appears in:_
- [Catalog](#catalog)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `name` _string_ | | | Optional: {} <br /> |
| `author` _string_ | | | Required: {} <br /> |
| `icon` _string_ | An icon url to annotate this pr automation | | Optional: {} <br /> |
| `darkIcon` _string_ | An darkmode icon url to annotate this pr automation | | Optional: {} <br /> |
| `description` _string_ | Description is a description of this Catalog. | | Optional: {} <br />Type: string <br /> |
| `category` _string_ | | | Optional: {} <br /> |
| `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 /> |
| `tags` _object (keys:string, values:string)_ | | | Optional: {} <br /> |
| `bindings` _[CatalogBindings](#catalogbindings)_ | Bindings contain read and write policies of this Catalog. | | Optional: {} <br /> |


#### CloudProvider

_Underlying type:_ _string_
Expand Down Expand Up @@ -1541,6 +1604,7 @@ _Appears in:_
| `stages` _[PipelineStage](#pipelinestage) array_ | Stages of a pipeline. | | |
| `edges` _[PipelineEdge](#pipelineedge) array_ | Edges of a pipeline. | | |
| `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 /> |
| `bindings` _[Bindings](#bindings)_ | Bindings contain read and write policies of this pipeline | | Optional: {} <br /> |


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

0 comments on commit 114427d

Please sign in to comment.