OCM Controller API v1

Packages:

delivery.ocm.software/v1alpha1

delivery.ocm.software/v1alpha1

Package v1alpha1 contains API Schema definitions for the delivery v1alpha1 API group

Resource Types:

ComponentVersion

ComponentVersion is the Schema for the ComponentVersions API.

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
ComponentVersionSpec

`component` string	Component specifies the name of the ComponentVersion.
`version` Version	Version specifies the version information for the ComponentVersion.
`repository` Repository	Repository provides details about the OCI repository from which the component descriptor can be retrieved.
`interval` Kubernetes meta/v1.Duration	Interval specifies the interval at which the Repository will be checked for updates.
`verify` []Signature	(Optional) Verify specifies a list signatures that should be validated before the ComponentVersion is marked Verified.
`references` ReferencesConfig	(Optional) References specifies configuration for the handling of nested component references.
`suspend` bool	(Optional) Suspend can be used to temporarily pause the reconciliation of the ComponentVersion resource.
`serviceAccountName` string	(Optional) ServiceAccountName can be used to configure access to both destination and source repositories. If service account is defined, it’s usually redundant to define access to either source or destination, but it is still allowed to do so. https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#add-imagepullsecrets-to-a-service-account

status
ComponentVersionStatus

ComponentVersionSpec

(Appears on: ComponentVersion)

ComponentVersionSpec specifies the configuration required to retrieve a component descriptor for a component version.

Field	Description
`component` string	Component specifies the name of the ComponentVersion.
`version` Version	Version specifies the version information for the ComponentVersion.
`repository` Repository	Repository provides details about the OCI repository from which the component descriptor can be retrieved.
`interval` Kubernetes meta/v1.Duration	Interval specifies the interval at which the Repository will be checked for updates.
`verify` []Signature	(Optional) Verify specifies a list signatures that should be validated before the ComponentVersion is marked Verified.
`references` ReferencesConfig	(Optional) References specifies configuration for the handling of nested component references.
`suspend` bool	(Optional) Suspend can be used to temporarily pause the reconciliation of the ComponentVersion resource.
`serviceAccountName` string	(Optional) ServiceAccountName can be used to configure access to both destination and source repositories. If service account is defined, it’s usually redundant to define access to either source or destination, but it is still allowed to do so. https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#add-imagepullsecrets-to-a-service-account

ComponentVersionStatus

(Appears on: ComponentVersion)

ComponentVersionStatus defines the observed state of ComponentVersion.

Field	Description
`observedGeneration` int64	(Optional) ObservedGeneration is the last reconciled generation.
`conditions` []Kubernetes meta/v1.Condition	(Optional) Conditions holds the conditions for the ComponentVersion.
`componentDescriptor` Reference	(Optional) ComponentDescriptor holds the ComponentDescriptor information for the ComponentVersion.
`reconciledVersion` string	(Optional) ReconciledVersion is a string containing the version of the latest reconciled ComponentVersion.
`verified` bool	(Optional) Verified is a boolean indicating whether all the specified signatures have been verified and are valid.

ConfigMapSource

(Appears on: ValuesSource)

Field	Description
`sourceRef` github.com/fluxcd/pkg/apis/meta.LocalObjectReference
`key` string
`subPath` string	(Optional)

Configuration

Configuration is the Schema for the configurations API.

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
MutationSpec

`interval` Kubernetes meta/v1.Duration
`sourceRef` ObjectReference
`configRef` ObjectReference	(Optional)
`values` k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	(Optional)
`valuesFrom` ValuesSource	(Optional)
`patchStrategicMerge` PatchStrategicMerge	(Optional)
`suspend` bool	(Optional) Suspend stops all operations on this object.

status
MutationStatus

DeliverySpec

DeliverySpec holds a set of targets onto which the pipeline output will be deployed.

Field	Description
`targets` []WasmStep

ElementMeta

(Appears on: ResourceReference)

Field	Description
`name` string
`version` string
`extraIdentity` github.com/open-component-model/ocm/pkg/contexts/ocm/compdesc/meta/v1.Identity
`labels` github.com/open-component-model/ocm/pkg/contexts/ocm/compdesc/meta/v1.Labels

FluxDeployer

FluxDeployer is the Schema for the FluxDeployers API.

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
FluxDeployerSpec

`sourceRef` ObjectReference
`interval` Kubernetes meta/v1.Duration	The interval at which to reconcile the Kustomization and Helm Releases.
`kustomizationTemplate` github.com/fluxcd/kustomize-controller/api/v1beta2.KustomizationSpec	(Optional)
`helmReleaseTemplate` github.com/fluxcd/helm-controller/api/v2beta1.HelmReleaseSpec	(Optional)

status
FluxDeployerStatus

FluxDeployerSpec

(Appears on: FluxDeployer)

FluxDeployerSpec defines the desired state of FluxDeployer.

Field	Description
`sourceRef` ObjectReference
`interval` Kubernetes meta/v1.Duration	The interval at which to reconcile the Kustomization and Helm Releases.
`kustomizationTemplate` github.com/fluxcd/kustomize-controller/api/v1beta2.KustomizationSpec	(Optional)
`helmReleaseTemplate` github.com/fluxcd/helm-controller/api/v2beta1.HelmReleaseSpec	(Optional)

FluxDeployerStatus

(Appears on: FluxDeployer)

FluxDeployerStatus defines the observed state of FluxDeployer.

Field	Description
`observedGeneration` int64	(Optional) ObservedGeneration is the last reconciled generation.
`conditions` []Kubernetes meta/v1.Condition	(Optional)
`kustomization` string	(Optional)
`ociRepository` string	(Optional)

FluxValuesSource

(Appears on: ValuesSource)

Field	Description
`sourceRef` github.com/fluxcd/pkg/apis/meta.NamespacedObjectKindReference
`path` string
`subPath` string	(Optional)

Localization

Localization is the Schema for the localizations API.

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
MutationSpec

`interval` Kubernetes meta/v1.Duration
`sourceRef` ObjectReference
`configRef` ObjectReference	(Optional)
`values` k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	(Optional)
`valuesFrom` ValuesSource	(Optional)
`patchStrategicMerge` PatchStrategicMerge	(Optional)
`suspend` bool	(Optional) Suspend stops all operations on this object.

status
MutationStatus

MutationObject

MutationObject defines any object which produces a snapshot

MutationSpec

(Appears on: Configuration, Localization)

MutationSpec defines a common spec for Localization and Configuration of OCM resources.

Field	Description
`interval` Kubernetes meta/v1.Duration
`sourceRef` ObjectReference
`configRef` ObjectReference	(Optional)
`values` k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	(Optional)
`valuesFrom` ValuesSource	(Optional)
`patchStrategicMerge` PatchStrategicMerge	(Optional)
`suspend` bool	(Optional) Suspend stops all operations on this object.

MutationStatus

(Appears on: Configuration, Localization)

MutationStatus defines a common status for Localizations and Configurations.

Field	Description
`observedGeneration` int64	(Optional) ObservedGeneration is the last reconciled generation.
`conditions` []Kubernetes meta/v1.Condition	(Optional)
`latestSnapshotDigest` string	(Optional)
`latestSourceVersion` string	(Optional)
`latestConfigVersion` string	(Optional)
`latestPatchSourceVersio` string	(Optional)
`snapshotName` string	(Optional)

ObjectReference

(Appears on: FluxDeployerSpec, MutationSpec, ResourcePipelineSpec, ResourceSpec)

ObjectReference defines a resource which may be accessed via a snapshot or component version

Field	Description
`NamespacedObjectKindReference` github.com/fluxcd/pkg/apis/meta.NamespacedObjectKindReference	(Members of `NamespacedObjectKindReference` are embedded into this type.)
`resourceRef` ResourceReference	(Optional)

PatchStrategicMerge

(Appears on: MutationSpec)

PatchStrategicMerge contains the source and target details required to perform a strategic merge.

Field	Description
`source` PatchStrategicMergeSource
`target` PatchStrategicMergeTarget

PatchStrategicMergeSource

(Appears on: PatchStrategicMerge)

PatchStrategicMergeSource contains the details required to retrieve the source from a Flux source.

Field	Description
`sourceRef` github.com/fluxcd/pkg/apis/meta.NamespacedObjectKindReference
`path` string

PatchStrategicMergeTarget

(Appears on: PatchStrategicMerge)

PatchStrategicMergeTarget provides details about the merge target.

Field	Description
`path` string

PipelineSpec

(Appears on: ResourcePipelineSpec)

PipelineSpec holds the steps that constitute the pipeline.

Field	Description
`steps` []WasmStep

PublicKey

(Appears on: Signature)

PublicKey specifies access to a public key for verification.

Field	Description
`secretRef` Kubernetes core/v1.LocalObjectReference	(Optional) SecretRef is a reference to a Secret that contains a public key.
`value` string	(Optional) Value defines a PEM/base64 encoded public key value.

Reference

(Appears on: ComponentVersionStatus, Reference)

Reference contains all referred components and their versions.

Field	Description
`name` string	Name specifies the name of the referenced component.
`version` string	Version specifies the version of the referenced component.
`references` []Reference	References is a list of component references.
`extraIdentity` map[string]string	(Optional) ExtraIdentity specifies additional identity attributes of the referenced component.
`componentDescriptorRef` github.com/fluxcd/pkg/apis/meta.NamespacedObjectReference	(Optional) ComponentDescriptorRef specifies the reference for the Kubernetes object representing the ComponentDescriptor.

ReferencesConfig

(Appears on: ComponentVersionSpec)

ReferencesConfig specifies how component references should be handled when reconciling the root component.

Field	Description
`expand` bool	(Optional) Expand specifies if a Kubernetes API resource of kind ComponentDescriptor should be generated for each component reference that is present in the root ComponentVersion.

Repository

(Appears on: ComponentVersionSpec)

Repository specifies access details for the repository that contains OCM ComponentVersions.

Field	Description
`url` string	URL specifies the URL of the OCI registry in which the ComponentVersion is stored. MUST NOT CONTAIN THE SCHEME.
`secretRef` Kubernetes core/v1.LocalObjectReference	(Optional) SecretRef specifies the credentials used to access the OCI registry.

Resource

Resource is the Schema for the resources API.

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
ResourceSpec

`interval` Kubernetes meta/v1.Duration	Interval specifies the interval at which the Repository will be checked for updates.
`sourceRef` ObjectReference	SourceRef specifies the source object from which the resource should be retrieved.
`suspend` bool	(Optional) Suspend can be used to temporarily pause the reconciliation of the Resource.

status
ResourceStatus

ResourcePipeline

ResourcePipeline is the Schema for the resourcepipelines API.

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
ResourcePipelineSpec

`interval` Kubernetes meta/v1.Duration
`suspend` bool	(Optional)
`serviceAccountName` string	(Optional)
`sourceRef` ObjectReference
`parameters` k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	(Optional)
`pipelineSpec` PipelineSpec	(Optional)

status
ResourcePipelineStatus

ResourcePipelineSource

ResourcePipelineSource defines the component version and resource which will be processed by the pipeline.

Field	Description
`name` string
`namespace` string	(Optional)
`resource` string

ResourcePipelineSpec

(Appears on: ResourcePipeline)

ResourcePipelineSpec defines the desired state of ResourcePipeline.

Field	Description
`interval` Kubernetes meta/v1.Duration
`suspend` bool	(Optional)
`serviceAccountName` string	(Optional)
`sourceRef` ObjectReference
`parameters` k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	(Optional)
`pipelineSpec` PipelineSpec	(Optional)

ResourcePipelineStatus

(Appears on: ResourcePipeline)

ResourcePipelineStatus defines the observed state of ResourcePipeline.

Field	Description
`observedGeneration` int64	(Optional) ObservedGeneration is the last reconciled generation.
`conditions` []Kubernetes meta/v1.Condition	(Optional)
`latestSnapshotDigest` string	(Optional)
`snapshotName` string	(Optional)

ResourceReference

(Appears on: ObjectReference)

Field	Description
`ElementMeta` ElementMeta	(Members of `ElementMeta` are embedded into this type.)
`referencePath` []github.com/open-component-model/ocm/pkg/contexts/ocm/compdesc/meta/v1.Identity	(Optional)

ResourceSpec

(Appears on: Resource)

ResourceSpec defines the desired state of Resource.

Field	Description
`interval` Kubernetes meta/v1.Duration	Interval specifies the interval at which the Repository will be checked for updates.
`sourceRef` ObjectReference	SourceRef specifies the source object from which the resource should be retrieved.
`suspend` bool	(Optional) Suspend can be used to temporarily pause the reconciliation of the Resource.

ResourceStatus

(Appears on: Resource)

ResourceStatus defines the observed state of Resource.

Field	Description
`observedGeneration` int64	(Optional) ObservedGeneration is the last reconciled generation.
`conditions` []Kubernetes meta/v1.Condition	(Optional) Conditions holds the conditions for the ComponentVersion.
`lastAppliedResourceVersion` string	(Optional) LastAppliedResourceVersion holds the version of the resource that was last applied (if applicable).
`lastAppliedComponentVersion` string	(Optional) LastAppliedComponentVersion holds the version of the last applied ComponentVersion for the ComponentVersion which contains this Resource.
`snapshotName` string	(Optional) SnapshotName specifies the name of the Snapshot that has been created to store the resource within the cluster and make it available for consumption by Flux controllers.
`latestSnapshotDigest` string	(Optional) LatestSnapshotDigest is a string representation of the digest for the most recent Resource snapshot.

Signature

(Appears on: ComponentVersionSpec)

Signature defines the details of a signature to use for verification.

Field	Description
`name` string	Name specifies the name of the signature. An OCM component may have multiple signatures.
`publicKey` PublicKey	PublicKey provides a reference to a Kubernetes Secret of contain a blob of a public key that which will be used to validate the named signature.

ValuesSource

(Appears on: MutationSpec)

ValuesSource provides access to values from an external Source such as a ConfigMap or GitRepository. An optional subpath defines the path within the source from which the values should be resolved.

Field	Description
`fluxSource` FluxValuesSource	(Optional)
`configMapSource` ConfigMapSource	(Optional)

Version

(Appears on: ComponentVersionSpec)

Version specifies version information that can be used to resolve a Component Version.

Field	Description
`semver` string	(Optional) Semver specifies a semantic version constraint for the Component Version.

WasmStep

(Appears on: DeliverySpec, PipelineSpec)

WasmStep defines the name version and location of a wasm module that is stored// in an ocm component. The format of the module name must be :@. Optionally a registry address can be specified.

Field	Description
`name` string
`module` string
`registry` string	(Optional)
`values` k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	(Optional)
`timeout` Kubernetes meta/v1.Duration	(Optional)

This page was automatically generated with gen-crd-api-reference-docs

ComponentSubscription

ComponentSubscription is the Schema for the componentsubscriptions API

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
ComponentSubscriptionSpec

`component` string	Component specifies the name of the Component that should be replicated.
`semver` string	(Optional) Semver specifies an optional semver constraint that is used to evaluate the component versions that should be replicated.
`source` OCMRepository	Source holds the OCM Repository details for the replication source.
`destination` OCMRepository	(Optional) Destination holds the destination or target OCM Repository details. The ComponentVersion will be transferred into this repository.
`interval` Kubernetes meta/v1.Duration	Interval is the reconciliation interval, i.e. at what interval shall a reconciliation happen. This is used to requeue objects for reconciliation in case of success as well as already reconciling objects.
`serviceAccountName` string	(Optional) ServiceAccountName can be used to configure access to both destination and source repositories. If service account is defined, it’s usually redundant to define access to either source or destination, but it is still allowed to do so. https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#add-imagepullsecrets-to-a-service-account
`verify` []Signature	(Optional) Verify specifies a list signatures that must be verified before a ComponentVersion is replicated.

status
ComponentSubscriptionStatus

ComponentSubscriptionSpec

(Appears on: ComponentSubscription)

ComponentSubscriptionSpec defines the desired state of ComponentSubscription. It specifies the parameters that the replication controller will use to replicate a desired Component from a source OCM repository to a destination OCM repository.

Field	Description
`component` string	Component specifies the name of the Component that should be replicated.
`semver` string	(Optional) Semver specifies an optional semver constraint that is used to evaluate the component versions that should be replicated.
`source` OCMRepository	Source holds the OCM Repository details for the replication source.
`destination` OCMRepository	(Optional) Destination holds the destination or target OCM Repository details. The ComponentVersion will be transferred into this repository.
`interval` Kubernetes meta/v1.Duration	Interval is the reconciliation interval, i.e. at what interval shall a reconciliation happen. This is used to requeue objects for reconciliation in case of success as well as already reconciling objects.
`serviceAccountName` string	(Optional) ServiceAccountName can be used to configure access to both destination and source repositories. If service account is defined, it’s usually redundant to define access to either source or destination, but it is still allowed to do so. https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#add-imagepullsecrets-to-a-service-account
`verify` []Signature	(Optional) Verify specifies a list signatures that should be validated before the ComponentVersion is marked Verified.

ComponentSubscriptionStatus

(Appears on: ComponentSubscription)

ComponentSubscriptionStatus defines the observed state of ComponentSubscription

Field	Description
`lastAttemptedVersion` string	(Optional) LastAttemptedVersion defines the latest version encountered while checking component versions. This might be different from last applied version which should be the latest applied/replicated version. The difference might be caused because of semver constraint or failures during replication.
`observedGeneration` int64	(Optional) ObservedGeneration is the last reconciled generation.
`lastAppliedVersion` string	(Optional) LastAppliedVersion defines the final version that has been applied to the destination component version.
`replicatedRepositoryURL` string	(Optional) ReplicatedRepositoryURL defines the final location of the reconciled Component.
`conditions` []Kubernetes meta/v1.Condition	(Optional)

OCMRepository

(Appears on: ComponentSubscriptionSpec)

OCMRepository specifies access details for an OCI based OCM Repository.

Field	Description
`url` string	URL specifies the URL of the OCI registry.
`secretRef` Kubernetes core/v1.LocalObjectReference	(Optional) SecretRef specifies the credentials used to access the OCI registry.

SecretRef

(Appears on: Signature)

SecretRef clearly denotes that the requested option is a Secret.

Field	Description
`secretRef` github.com/fluxcd/pkg/apis/meta.LocalObjectReference

Signature

(Appears on: ComponentSubscriptionSpec)

Signature defines the details of a signature to use for verification.

Field	Description
`name` string	Name specifies the name of the signature. An OCM component may have multiple signatures.
`publicKey` SecretRef	PublicKey provides a reference to a Kubernetes Secret that contains a public key which will be used to validate the named signature.

This page was automatically generated with gen-crd-api-reference-docs

Architecture

Component Version

OCM Controller API v1

delivery.ocm.software/v1alpha1#

ComponentVersion

ComponentVersionSpec

ComponentVersionStatus

ConfigMapSource

Configuration

DeliverySpec

ElementMeta

FluxDeployer

FluxDeployerSpec

FluxDeployerStatus

FluxValuesSource

Localization

MutationObject

MutationSpec

MutationStatus

ObjectReference

PatchStrategicMerge

PatchStrategicMergeSource

PatchStrategicMergeTarget

PipelineSpec

PublicKey

Reference

ReferencesConfig

Repository

Resource

ResourcePipeline

ResourcePipelineSource

ResourcePipelineSpec

ResourcePipelineStatus

ResourceReference

ResourceSpec

ResourceStatus

Signature

ValuesSource

Version

WasmStep

ComponentSubscription

ComponentSubscriptionSpec

ComponentSubscriptionStatus

OCMRepository

SecretRef

Signature

delivery.ocm.software/v1alpha1