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 indiciating whether all of the specified signatures have been verified and are valid.

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)
`outputTemplate` SnapshotTemplateSpec	(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

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
`kustomizationTemplate` github.com/fluxcd/kustomize-controller/api/v1beta2.KustomizationSpec

status
FluxDeployerStatus

FluxDeployerSpec

(Appears on: FluxDeployer)

FluxDeployerSpec defines the desired state of FluxDeployer

Field	Description
`sourceRef` ObjectReference
`kustomizationTemplate` github.com/fluxcd/kustomize-controller/api/v1beta2.KustomizationSpec

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)
`outputTemplate` SnapshotTemplateSpec	(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)
`outputTemplate` SnapshotTemplateSpec	(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, 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

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 referened 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 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.
`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

ResourceReference

(Appears on: ObjectReference)

Field	Description
`ElementMeta` github.com/open-component-model/ocm/pkg/contexts/ocm/compdesc/versions/ocm.software/v3alpha1.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.

SecretRef

(Appears on: Signature)

SecretRef specifies a reference to a Secret

Field	Description
`secretRef` Kubernetes core/v1.LocalObjectReference

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` SecretRef	PublicKey provides a reference to a Kubernetes Secret that contains a public key 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)

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.

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