diff --git a/pages/deployments/operator/api.md b/pages/deployments/operator/api.md index d70c39de..1a6dfbe5 100644 --- a/pages/deployments/operator/api.md +++ b/pages/deployments/operator/api.md @@ -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) @@ -49,6 +50,7 @@ Binding ... _Appears in:_ - [Bindings](#bindings) +- [CatalogBindings](#catalogbindings) - [DeploymentSettingsBindings](#deploymentsettingsbindings) - [NotificationSinkSpec](#notificationsinkspec) - [PrAutomationBindings](#prautomationbindings) @@ -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) @@ -102,6 +105,66 @@ _Appears in:_ | `delete` _boolean_ | Whether you want to delete owned resources in Plural and in the targeted k8s cluster | | Optional: {}
| +#### 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: {}
| +| `read` _[Binding](#binding) array_ | Read bindings. | | Optional: {}
| +| `write` _[Binding](#binding) array_ | Write bindings. | | Optional: {}
| + + +#### CatalogSpec + + + +CatalogSpec defines the desired state of Catalog + + + +_Appears in:_ +- [Catalog](#catalog) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `name` _string_ | | | Optional: {}
| +| `author` _string_ | | | Required: {}
| +| `icon` _string_ | An icon url to annotate this pr automation | | Optional: {}
| +| `darkIcon` _string_ | An darkmode icon url to annotate this pr automation | | Optional: {}
| +| `description` _string_ | Description is a description of this Catalog. | | Optional: {}
Type: string
| +| `category` _string_ | | | Optional: {}
| +| `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: {}
| +| `tags` _object (keys:string, values:string)_ | | | Optional: {}
| +| `bindings` _[CatalogBindings](#catalogbindings)_ | Bindings contain read and write policies of this Catalog. | | Optional: {}
| + + #### CloudProvider _Underlying type:_ _string_ @@ -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.
If not provided, it will use the default project. | | Optional: {}
| +| `bindings` _[Bindings](#bindings)_ | Bindings contain read and write policies of this pipeline | | Optional: {}
| #### PipelineStage @@ -1744,6 +1808,8 @@ _Appears in:_ | `role` _[PrRole](#prrole)_ | | | Enum: [CLUSTER SERVICE PIPELINE UPDATE UPGRADE]
Optional: {}
| | `addon` _string_ | Addon is a link to an addon name | | Optional: {}
| | `branch` _string_ | The base branch this pr will be based on (defaults to the repo's main branch) | | Optional: {}
| +| `icon` _string_ | An icon url to annotate this pr automation | | Optional: {}
| +| `darkIcon` _string_ | An darkmode icon url to annotate this pr automation | | Optional: {}
| | `documentation` _string_ | Documentation ... | | Optional: {}
| | `identifier` _string_ | Identifier is a string referencing the repository, i.e. for GitHub it would be "/" | | Optional: {}
| | `message` _string_ | Message the commit message this pr will incorporate | | Optional: {}
|