v1alpha1

package
v0.8.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 28, 2023 License: Apache-2.0 Imports: 15 Imported by: 12

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the delivery v1alpha1 API group +kubebuilder:object:generate=true +groupName=delivery.ocm.software

Index

Constants

View Source 
const (
	// AuthenticatedContextCreationFailedReason is used when the controller failed to create an authenticated context.
	AuthenticatedContextCreationFailedReason = "AuthenticatedContextCreationFailed"

	// CheckVersionFailedReason is used when the controller failed to check for new versions
	CheckVersionFailedReason = "CheckVersionFailedReason"

	// VerificationFailedReason is used when the signature verification of a component failed.
	VerificationFailedReason = "ComponentVerificationFailed"

	// ComponentVersionInvalidReason is used when the component version is invalid, or we fail to retreive it.
	ComponentVersionInvalidReason = "ComponentVersionInvalid"

	// ConvertComponentDescriptorFailedReason is used when the Component Descriptor cannot be converted.
	ConvertComponentDescriptorFailedReason = "ConvertComponentDescriptorFailed"

	// NameGenerationFailedReason is used when the componentn name could not be generated.
	NameGenerationFailedReason = "NameGenerationFailed"

	// CreateOrUpdateComponentDescriptorFailedReason is used when the Component Descriptor cannot be created or updated on the resource.
	CreateOrUpdateComponentDescriptorFailedReason = "CreateOrUpdateComponentDescriptorFailed"

	// ParseReferencesFailedReason is used when the resource references cannot be parsed.
	ParseReferencesFailedReason = "ParseReferencesFailed"

	// ReconcileMuationObjectFailed is used when the mutation object cannot be reconciled.
	ReconcileMuationObjectFailedReason = "ReconcileMuationObjectFailed"

	// SourceReasonNotATarArchiveReason is used when the source resource is not a tar archive.
	SourceReasonNotATarArchiveReason = "SourceReasonNotATarArchive"

	// GetResourceFailedReason is used when the resource cannot be retrieved.
	GetResourceFailedReason = "GetResourceFailed"

	// GetComponentDescriptorFailedReason is used when the component descriptor cannot be retrieved.
	GetComponentDescriptorFailedReason = "GetComponentDescriptorFailed"

	// ComponentDescriptorNotFoundReason is used when the component descriptor cannot be found.
	ComponentDescriptorNotFoundReason = "ComponentDescriptorNotFound"

	// CreateOrUpdateSnapshotFailedReason is used when the snapshot cannot be created or updated.
	CreateOrUpdateSnapshotFailedReason = "CreateOrUpdateSnapshotFailed"

	// CreateOrUpdateOCIRepositoryFailedReason is used when the OCIRepository cannot be created or updated.
	CreateOrUpdateOCIRepositoryFailedReason = "CreateOrUpdateOCIRepositoryFailed"

	// CreateOrUpdateKustomizationFailedReason is used when the Kustomization cannot be created or updated.
	CreateOrUpdateKustomizationFailedReason = "CreateOrUpdateKustomizationFailed"

	// CreateRepositoryNameReason is used when the generating a new repository name fails.
	CreateRepositoryNameReason = "CreateRepositoryNameFailed"

	// PatchSnapshotFailedReason is used when the snapshot cannot be patched.
	PatchSnapshotFailedReason = "PatchSnapshotFailed"

	// SnapshotFailedReason is used when the snapshot cannot be created.
	SnapshotFailedReason = "SnapshotFailed"
)
View Source 
const (
	// SnapshotKind is the string representation of a Snapshot.
	SnapshotKind = "Snapshot"

	ComponentNameKey          = "component-name"
	ComponentVersionKey       = "component-version"
	ResourceNameKey           = "resource-name"
	ResourceVersionKey        = "resource-version"
	SourceNameKey             = "source-name"
	SourceNamespaceKey        = "source-namespace"
	SourceArtifactChecksumKey = "source-artifact-checksum"
)
View Source 
const (
	// ComponentVersionKind is the string representation of a ComponentVersion.
	ComponentVersionKind = "ComponentVersion"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "delivery.ocm.software", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type ComponentDescriptor 

type ComponentDescriptor struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ComponentDescriptorSpec   `json:"spec,omitempty"`
	Status ComponentDescriptorStatus `json:"status,omitempty"`
}

ComponentDescriptor is the Schema for the componentdescriptors API

func (*ComponentDescriptor) DeepCopy 

func (in *ComponentDescriptor) DeepCopy() *ComponentDescriptor

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentDescriptor.

func (*ComponentDescriptor) DeepCopyInto 

func (in *ComponentDescriptor) DeepCopyInto(out *ComponentDescriptor)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ComponentDescriptor) DeepCopyObject 

func (in *ComponentDescriptor) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (ComponentDescriptor) GetResource 

func (in ComponentDescriptor) GetResource(name string) *v3alpha1.Resource

GetResource return a given resource in a component descriptor if it exists.

type ComponentDescriptorList 

type ComponentDescriptorList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ComponentDescriptor `json:"items"`
}

ComponentDescriptorList contains a list of ComponentDescriptor

func (*ComponentDescriptorList) DeepCopy 

func (in *ComponentDescriptorList) DeepCopy() *ComponentDescriptorList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentDescriptorList.

func (*ComponentDescriptorList) DeepCopyInto 

func (in *ComponentDescriptorList) DeepCopyInto(out *ComponentDescriptorList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ComponentDescriptorList) DeepCopyObject 

func (in *ComponentDescriptorList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ComponentDescriptorSpec 

type ComponentDescriptorSpec struct {
	v3alpha1.ComponentVersionSpec `json:",inline"`
	Version                       string `json:"version"`
}

ComponentDescriptorSpec adds a version to the top level component descriptor definition.

func (*ComponentDescriptorSpec) DeepCopy 

func (in *ComponentDescriptorSpec) DeepCopy() *ComponentDescriptorSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentDescriptorSpec.

func (*ComponentDescriptorSpec) DeepCopyInto 

func (in *ComponentDescriptorSpec) DeepCopyInto(out *ComponentDescriptorSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ComponentDescriptorStatus 

type ComponentDescriptorStatus struct {
}

ComponentDescriptorStatus defines the observed state of ComponentDescriptor

func (*ComponentDescriptorStatus) DeepCopy 

func (in *ComponentDescriptorStatus) DeepCopy() *ComponentDescriptorStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentDescriptorStatus.

func (*ComponentDescriptorStatus) DeepCopyInto 

func (in *ComponentDescriptorStatus) DeepCopyInto(out *ComponentDescriptorStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ComponentVersion 

type ComponentVersion struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ComponentVersionSpec   `json:"spec,omitempty"`
	Status ComponentVersionStatus `json:"status,omitempty"`
}

ComponentVersion is the Schema for the ComponentVersions API

func (*ComponentVersion) DeepCopy 

func (in *ComponentVersion) DeepCopy() *ComponentVersion

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentVersion.

func (*ComponentVersion) DeepCopyInto 

func (in *ComponentVersion) DeepCopyInto(out *ComponentVersion)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ComponentVersion) DeepCopyObject 

func (in *ComponentVersion) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ComponentVersion) GetConditions 

func (in *ComponentVersion) GetConditions() []metav1.Condition

GetConditions returns the conditions of the ComponentVersion.

func (ComponentVersion) GetRequeueAfter 

func (in ComponentVersion) GetRequeueAfter() time.Duration

GetRequeueAfter returns the duration after which the ComponentVersion must be reconciled again.

func (*ComponentVersion) GetVersion 

func (in *ComponentVersion) GetVersion() string

GetVersion returns the reconciled version for the component

func (ComponentVersion) LookupReferenceForIdentity added in v0.1.0 

func (in ComponentVersion) LookupReferenceForIdentity(key ocmdesc.IdentitySelector) Reference

LookupReferenceForIdentity returns the reference that matches up with the given identity selector.

func (*ComponentVersion) SetConditions 

func (in *ComponentVersion) SetConditions(conditions []metav1.Condition)

SetConditions sets the conditions of the ComponentVersion.

type ComponentVersionList 

type ComponentVersionList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ComponentVersion `json:"items"`
}

ComponentVersionList contains a list of ComponentVersion

func (*ComponentVersionList) DeepCopy 

func (in *ComponentVersionList) DeepCopy() *ComponentVersionList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentVersionList.

func (*ComponentVersionList) DeepCopyInto 

func (in *ComponentVersionList) DeepCopyInto(out *ComponentVersionList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ComponentVersionList) DeepCopyObject 

func (in *ComponentVersionList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ComponentVersionSpec 

type ComponentVersionSpec struct {
	// +required
	Interval metav1.Duration `json:"interval"`

	// Every Component Version has a name.
	// Name and version are the identifier for a Component Version and therefor for the artifact set described by it.
	// A component name SHOULD reference a location where the component’s resources (typically source code, and/or documentation) are hosted.
	// It MUST be a DNS compliant name with lowercase characters and MUST contain a name after the domain.
	// Examples:
	// - github.com/pathToYourRepo
	// +required
	Component string `json:"component"`

	// Component versions refer to specific snapshots of a component. A common scenario being the release of a component.
	// +required
	Version Version `json:"version"`

	// +required
	Repository Repository `json:"repository"`

	// +optional
	Verify []Signature `json:"verify,omitempty"`

	// +optional
	References ReferencesConfig `json:"references,omitempty"`

	// Suspend stops all operations on this component version object.
	// +optional
	Suspend bool `json:"suspend,omitempty"`

	// 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
	// +optional
	ServiceAccountName string `json:"serviceAccountName,omitempty"`
}

ComponentVersionSpec defines the desired state of ComponentVersion

func (*ComponentVersionSpec) DeepCopy 

func (in *ComponentVersionSpec) DeepCopy() *ComponentVersionSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentVersionSpec.

func (*ComponentVersionSpec) DeepCopyInto 

func (in *ComponentVersionSpec) DeepCopyInto(out *ComponentVersionSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ComponentVersionStatus 

type ComponentVersionStatus struct {
	// ObservedGeneration is the last reconciled generation.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// +optional
	ComponentDescriptor Reference `json:"componentDescriptor,omitempty"`

	// +optional
	ReconciledVersion string `json:"reconciledVersion,omitempty"`

	// +optional
	Verified bool `json:"verified,omitempty"`
}

ComponentVersionStatus defines the observed state of ComponentVersion

func (*ComponentVersionStatus) DeepCopy 

func (in *ComponentVersionStatus) DeepCopy() *ComponentVersionStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentVersionStatus.

func (*ComponentVersionStatus) DeepCopyInto 

func (in *ComponentVersionStatus) DeepCopyInto(out *ComponentVersionStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Configuration 

type Configuration struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec MutationSpec `json:"spec,omitempty"`

	// +kubebuilder:default={"observedGeneration":-1}
	Status MutationStatus `json:"status,omitempty"`
}

Configuration is the Schema for the configurations API

func (*Configuration) DeepCopy 

func (in *Configuration) DeepCopy() *Configuration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Configuration.

func (*Configuration) DeepCopyInto 

func (in *Configuration) DeepCopyInto(out *Configuration)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Configuration) DeepCopyObject 

func (in *Configuration) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Configuration) GetConditions 

func (in *Configuration) GetConditions() []metav1.Condition

GetConditions returns the conditions of the Configuration.

func (Configuration) GetRequeueAfter 

func (in Configuration) GetRequeueAfter() time.Duration

GetRequeueAfter returns the duration after which the Configuration must be reconciled again.

func (Configuration) GetSnapshotDigest 

func (in Configuration) GetSnapshotDigest() string

GetSnapshotDigest returns the latest snapshot digest for the localization

func (Configuration) GetSnapshotName 

func (in Configuration) GetSnapshotName() string

GetSnapshotName returns the key for the snapshot produced by the Localization

func (*Configuration) GetSpec 

func (in *Configuration) GetSpec() *MutationSpec

GetSpec returns the mutation spec for a Localization

func (*Configuration) GetStatus 

func (in *Configuration) GetStatus() *MutationStatus

GetStatus returns the mutation status for a Localization

func (*Configuration) SetConditions 

func (in *Configuration) SetConditions(conditions []metav1.Condition)

SetConditions sets the conditions of the Configuration.

type ConfigurationList 

type ConfigurationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Configuration `json:"items"`
}

ConfigurationList contains a list of Configuration

func (*ConfigurationList) DeepCopy 

func (in *ConfigurationList) DeepCopy() *ConfigurationList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigurationList.

func (*ConfigurationList) DeepCopyInto 

func (in *ConfigurationList) DeepCopyInto(out *ConfigurationList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConfigurationList) DeepCopyObject 

func (in *ConfigurationList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type FluxDeployer 

type FluxDeployer struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   FluxDeployerSpec   `json:"spec,omitempty"`
	Status FluxDeployerStatus `json:"status,omitempty"`
}

FluxDeployer is the Schema for the fluxdeployers API

func (*FluxDeployer) DeepCopy 

func (in *FluxDeployer) DeepCopy() *FluxDeployer

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FluxDeployer.

func (*FluxDeployer) DeepCopyInto 

func (in *FluxDeployer) DeepCopyInto(out *FluxDeployer)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*FluxDeployer) DeepCopyObject 

func (in *FluxDeployer) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*FluxDeployer) GetConditions 

func (in *FluxDeployer) GetConditions() []metav1.Condition

GetConditions returns the conditions of the ComponentVersion.

func (*FluxDeployer) SetConditions 

func (in *FluxDeployer) SetConditions(conditions []metav1.Condition)

SetConditions sets the conditions of the ComponentVersion.

type FluxDeployerList 

type FluxDeployerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []FluxDeployer `json:"items"`
}

FluxDeployerList contains a list of FluxDeployer

func (*FluxDeployerList) DeepCopy 

func (in *FluxDeployerList) DeepCopy() *FluxDeployerList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FluxDeployerList.

func (*FluxDeployerList) DeepCopyInto 

func (in *FluxDeployerList) DeepCopyInto(out *FluxDeployerList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*FluxDeployerList) DeepCopyObject 

func (in *FluxDeployerList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type FluxDeployerSpec 

type FluxDeployerSpec struct {
	// +required
	SourceRef ObjectReference `json:"sourceRef"`

	// +kubebuilder:pruning:PreserveUnknownFields
	// +kubebuilder:validation:Schemaless
	KustomizationTemplate kustomizev1.KustomizationSpec `json:"kustomizationTemplate"`
}

FluxDeployerSpec defines the desired state of FluxDeployer

func (*FluxDeployerSpec) DeepCopy 

func (in *FluxDeployerSpec) DeepCopy() *FluxDeployerSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FluxDeployerSpec.

func (*FluxDeployerSpec) DeepCopyInto 

func (in *FluxDeployerSpec) DeepCopyInto(out *FluxDeployerSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FluxDeployerStatus 

type FluxDeployerStatus struct {
	// ObservedGeneration is the last reconciled generation.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// +optional
	Kustomization string `json:"kustomization"`

	// +optional
	OCIRepository string `json:"ociRepository"`
}

FluxDeployerStatus defines the observed state of FluxDeployer

func (*FluxDeployerStatus) DeepCopy 

func (in *FluxDeployerStatus) DeepCopy() *FluxDeployerStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FluxDeployerStatus.

func (*FluxDeployerStatus) DeepCopyInto 

func (in *FluxDeployerStatus) DeepCopyInto(out *FluxDeployerStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FluxValuesSource 

type FluxValuesSource struct {
	// +required
	SourceRef meta.NamespacedObjectKindReference `json:"sourceRef,omitempty"`

	// +required
	Path string `json:"path,omitempty"`

	// +optional
	SubPath string `json:"subPath,omitempty"`
}

func (*FluxValuesSource) DeepCopy 

func (in *FluxValuesSource) DeepCopy() *FluxValuesSource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FluxValuesSource.

func (*FluxValuesSource) DeepCopyInto 

func (in *FluxValuesSource) DeepCopyInto(out *FluxValuesSource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Localization 

type Localization struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec MutationSpec `json:"spec,omitempty"`
	// +kubebuilder:default={"observedGeneration":-1}
	Status MutationStatus `json:"status,omitempty"`
}

Localization is the Schema for the localizations API

func (*Localization) DeepCopy 

func (in *Localization) DeepCopy() *Localization

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Localization.

func (*Localization) DeepCopyInto 

func (in *Localization) DeepCopyInto(out *Localization)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Localization) DeepCopyObject 

func (in *Localization) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Localization) GetConditions 

func (in *Localization) GetConditions() []metav1.Condition

GetConditions returns the conditions of the Localization.

func (Localization) GetRequeueAfter 

func (in Localization) GetRequeueAfter() time.Duration

GetRequeueAfter returns the duration after which the Localization must be reconciled again.

func (Localization) GetSnapshotDigest 

func (in Localization) GetSnapshotDigest() string

GetSnapshotDigest returns the latest snapshot digest for the localization

func (Localization) GetSnapshotName 

func (in Localization) GetSnapshotName() string

GetSnapshotName returns the key for the snapshot produced by the Localization

func (*Localization) GetSpec 

func (in *Localization) GetSpec() *MutationSpec

GetSpec returns the mutation spec for a Localization

func (*Localization) GetStatus 

func (in *Localization) GetStatus() *MutationStatus

GetStatus returns the mutation status for a Localization

func (*Localization) SetConditions 

func (in *Localization) SetConditions(conditions []metav1.Condition)

SetConditions sets the conditions of the Localization.

type LocalizationList 

type LocalizationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Localization `json:"items"`
}

LocalizationList contains a list of Localization

func (*LocalizationList) DeepCopy 

func (in *LocalizationList) DeepCopy() *LocalizationList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LocalizationList.

func (*LocalizationList) DeepCopyInto 

func (in *LocalizationList) DeepCopyInto(out *LocalizationList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*LocalizationList) DeepCopyObject 

func (in *LocalizationList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type MutationObject 

type MutationObject interface {
	SnapshotWriter
	GetSpec() *MutationSpec
	GetStatus() *MutationStatus
}

MutationObject defines any object which produces a snapshot +k8s:deepcopy-gen=false

type MutationSpec 

type MutationSpec struct {
	// +required
	Interval metav1.Duration `json:"interval,omitempty"`

	// +required
	SourceRef ObjectReference `json:"sourceRef,omitempty"`

	// +optional
	ConfigRef *ObjectReference `json:"configRef,omitempty"`

	// +optional
	OutputTemplate *SnapshotTemplateSpec `json:"outputTemplate,omitempty"`

	// +optional
	Values *apiextensionsv1.JSON `json:"values,omitempty"`

	// +optional
	ValuesFrom *ValuesSource `json:"valuesFrom,omitempty"`

	// +optional
	PatchStrategicMerge *PatchStrategicMerge `json:"patchStrategicMerge,omitempty"`

	// Suspend stops all operations on this object.
	// +optional
	Suspend bool `json:"suspend,omitempty"`
}

MutationSpec defines a common spec between Localization and Configuration.

func (*MutationSpec) DeepCopy 

func (in *MutationSpec) DeepCopy() *MutationSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MutationSpec.

func (*MutationSpec) DeepCopyInto 

func (in *MutationSpec) DeepCopyInto(out *MutationSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (MutationSpec) GetRequeueAfter 

func (in MutationSpec) GetRequeueAfter() time.Duration

GetRequeueAfter returns the duration after which the Localization must be reconciled again.

type MutationStatus 

type MutationStatus struct {
	// ObservedGeneration is the last reconciled generation.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// +optional
	LatestSnapshotDigest string `json:"latestSnapshotDigest,omitempty"`

	// +optional
	LatestSourceVersion string `json:"latestSourceVersion,omitempty"`

	// +optional
	LatestConfigVersion string `json:"latestConfigVersion,omitempty"`

	// +optional
	LatestPatchSourceVersion string `json:"latestPatchSourceVersio,omitempty"`

	// +optional
	SnapshotName string `json:"snapshotName,omitempty"`
}

MutationStatus defines a common status for Localizations and Configurations.

func (*MutationStatus) DeepCopy 

func (in *MutationStatus) DeepCopy() *MutationStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MutationStatus.

func (*MutationStatus) DeepCopyInto 

func (in *MutationStatus) DeepCopyInto(out *MutationStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ObjectReference 

type ObjectReference struct {
	meta.NamespacedObjectKindReference `json:",inline"`

	// +optional
	ResourceRef *ResourceReference `json:"resourceRef,omitempty"`
}

ObjectReference defines a resource which may be accessed via a snapshot or component version +kubebuilder:validation:MinProperties=1

func (*ObjectReference) DeepCopy 

func (in *ObjectReference) DeepCopy() *ObjectReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObjectReference.

func (*ObjectReference) DeepCopyInto 

func (in *ObjectReference) DeepCopyInto(out *ObjectReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ObjectReference) GetGVR 

func (o *ObjectReference) GetGVR() schema.GroupVersionResource

func (*ObjectReference) GetNamespacedName 

func (o *ObjectReference) GetNamespacedName() string

func (*ObjectReference) GetObjectKey 

func (o *ObjectReference) GetObjectKey() client.ObjectKey

func (*ObjectReference) GetVersion 

func (o *ObjectReference) GetVersion() string

type PatchStrategicMerge 

type PatchStrategicMerge struct {
	// +required
	Source PatchStrategicMergeSource `json:"source"`

	// +required
	Target PatchStrategicMergeTarget `json:"target"`
}

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

func (*PatchStrategicMerge) DeepCopy 

func (in *PatchStrategicMerge) DeepCopy() *PatchStrategicMerge

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PatchStrategicMerge.

func (*PatchStrategicMerge) DeepCopyInto 

func (in *PatchStrategicMerge) DeepCopyInto(out *PatchStrategicMerge)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PatchStrategicMergeSource 

type PatchStrategicMergeSource struct {
	// +required
	SourceRef meta.NamespacedObjectKindReference `json:"sourceRef"`

	// +required
	Path string `json:"path"`
}

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

func (*PatchStrategicMergeSource) DeepCopy 

func (in *PatchStrategicMergeSource) DeepCopy() *PatchStrategicMergeSource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PatchStrategicMergeSource.

func (*PatchStrategicMergeSource) DeepCopyInto 

func (in *PatchStrategicMergeSource) DeepCopyInto(out *PatchStrategicMergeSource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PatchStrategicMergeTarget 

type PatchStrategicMergeTarget struct {
	Path string `json:"path"`
}

PatchStrategicMergeTarget provides details about the merge target

func (*PatchStrategicMergeTarget) DeepCopy 

func (in *PatchStrategicMergeTarget) DeepCopy() *PatchStrategicMergeTarget

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PatchStrategicMergeTarget.

func (*PatchStrategicMergeTarget) DeepCopyInto 

func (in *PatchStrategicMergeTarget) DeepCopyInto(out *PatchStrategicMergeTarget)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Reference 

type Reference struct {
	// +required
	Name string `json:"name"`

	// +required
	Version string `json:"version"`

	// +kubebuilder:pruning:PreserveUnknownFields
	// +kubebuilder:validation:Schemaless
	References []Reference `json:"references,omitempty"`

	// +optional
	ExtraIdentity map[string]string `json:"extraIdentity,omitempty"`

	// +optional
	ComponentDescriptorRef meta.NamespacedObjectReference `json:"componentDescriptorRef,omitempty"`
}

Reference contains all referred components and their versions.

func (*Reference) DeepCopy 

func (in *Reference) DeepCopy() *Reference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Reference.

func (*Reference) DeepCopyInto 

func (in *Reference) DeepCopyInto(out *Reference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ReferencesConfig 

type ReferencesConfig struct {
	// +optional
	Expand bool `json:"expand,omitempty"`
}

func (*ReferencesConfig) DeepCopy 

func (in *ReferencesConfig) DeepCopy() *ReferencesConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReferencesConfig.

func (*ReferencesConfig) DeepCopyInto 

func (in *ReferencesConfig) DeepCopyInto(out *ReferencesConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Repository 

type Repository struct {
	//TODO@souleb: do we need a scheme for the url?
	// add description for each field
	// Do we need a type field? (e.g. oci, git, s3, etc.)
	URL string `json:"url"`

	// +optional
	SecretRef *v1.LocalObjectReference `json:"secretRef,omitempty"`
}

Repository defines the OCM Repository.

func (*Repository) DeepCopy 

func (in *Repository) DeepCopy() *Repository

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Repository.

func (*Repository) DeepCopyInto 

func (in *Repository) DeepCopyInto(out *Repository)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Resource 

type Resource struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec ResourceSpec `json:"spec,omitempty"`

	// +kubebuilder:default={"observedGeneration":-1}
	Status ResourceStatus `json:"status,omitempty"`
}

Resource is the Schema for the resources API

func (*Resource) DeepCopy 

func (in *Resource) DeepCopy() *Resource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resource.

func (*Resource) DeepCopyInto 

func (in *Resource) DeepCopyInto(out *Resource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Resource) DeepCopyObject 

func (in *Resource) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Resource) GetConditions 

func (in *Resource) GetConditions() []metav1.Condition

GetConditions returns the conditions of the Resource.

func (Resource) GetReferencePath 

func (in Resource) GetReferencePath() []ocmmetav1.Identity

GetReferencePath returns the component reference path for the resource

func (Resource) GetRequeueAfter 

func (in Resource) GetRequeueAfter() time.Duration

GetRequeueAfter returns the duration after which the Resource must be reconciled again.

func (Resource) GetSnapshotDigest 

func (in Resource) GetSnapshotDigest() string

GetSnapshotName returns the key for the snapshot produced by the Configuration

func (Resource) GetSnapshotName 

func (in Resource) GetSnapshotName() string

GetSnapshotName returns the key for the snapshot produced by the Configuration

func (*Resource) SetConditions 

func (in *Resource) SetConditions(conditions []metav1.Condition)

SetConditions sets the conditions of the Resource.

type ResourceList 

type ResourceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Resource `json:"items"`
}

ResourceList contains a list of Resource

func (*ResourceList) DeepCopy 

func (in *ResourceList) DeepCopy() *ResourceList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceList.

func (*ResourceList) DeepCopyInto 

func (in *ResourceList) DeepCopyInto(out *ResourceList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResourceList) DeepCopyObject 

func (in *ResourceList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ResourceReference 

type ResourceReference struct {
	// +required
	v3alpha1.ElementMeta `json:",inline"`

	// +optional
	ReferencePath []ocmmetav1.Identity `json:"referencePath,omitempty"`
}

func (*ResourceReference) DeepCopy 

func (in *ResourceReference) DeepCopy() *ResourceReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceReference.

func (*ResourceReference) DeepCopyInto 

func (in *ResourceReference) DeepCopyInto(out *ResourceReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceSpec 

type ResourceSpec struct {
	// +required
	Interval metav1.Duration `json:"interval"`

	// SourceRef defines the input source from which the resource
	// will be retrieved
	// +required
	SourceRef ObjectReference `json:"sourceRef"`

	// +required
	OutputTemplate *SnapshotTemplateSpec `json:"outputTemplate,omitempty"`

	// Suspend stops all operations on this object.
	// +optional
	Suspend bool `json:"suspend,omitempty"`
}

ResourceSpec defines the desired state of Resource

func (*ResourceSpec) DeepCopy 

func (in *ResourceSpec) DeepCopy() *ResourceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceSpec.

func (*ResourceSpec) DeepCopyInto 

func (in *ResourceSpec) DeepCopyInto(out *ResourceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceStatus 

type ResourceStatus struct {
	// ObservedGeneration is the last reconciled generation.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// +optional
	LastAppliedResourceVersion string `json:"lastAppliedResourceVersion,omitempty"`

	// LastAppliedComponentVersion tracks the last applied component version. If there is a change
	// we fire off a reconcile loop to get that new version.
	// +optional
	LastAppliedComponentVersion string `json:"lastAppliedComponentVersion,omitempty"`

	// +optional
	SnapshotName string `json:"snapshotName,omitempty"`

	// +optional
	LatestSnapshotDigest string `json:"latestSnapshotDigest,omitempty"`
}

ResourceStatus defines the observed state of Resource

func (*ResourceStatus) DeepCopy 

func (in *ResourceStatus) DeepCopy() *ResourceStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceStatus.

func (*ResourceStatus) DeepCopyInto 

func (in *ResourceStatus) DeepCopyInto(out *ResourceStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SecretRefValue added in v0.1.0 

type SecretRefValue struct {
	SecretRef v1.LocalObjectReference `json:"secretRef"`
}

SecretRefValue clearly denotes that the requested option is a Secret.

func (*SecretRefValue) DeepCopy added in v0.1.0 

func (in *SecretRefValue) DeepCopy() *SecretRefValue

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretRefValue.

func (*SecretRefValue) DeepCopyInto added in v0.1.0 

func (in *SecretRefValue) DeepCopyInto(out *SecretRefValue)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Signature 

type Signature struct {
	// Name of the signature.
	Name string `json:"name"`

	// Key which is used for verification.
	PublicKey SecretRefValue `json:"publicKey"`
}

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

func (*Signature) DeepCopy 

func (in *Signature) DeepCopy() *Signature

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Signature.

func (*Signature) DeepCopyInto 

func (in *Signature) DeepCopyInto(out *Signature)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Snapshot 

type Snapshot struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   SnapshotSpec   `json:"spec,omitempty"`
	Status SnapshotStatus `json:"status,omitempty"`
}

Snapshot is the Schema for the snapshots API

func (*Snapshot) DeepCopy 

func (in *Snapshot) DeepCopy() *Snapshot

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Snapshot.

func (*Snapshot) DeepCopyInto 

func (in *Snapshot) DeepCopyInto(out *Snapshot)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Snapshot) DeepCopyObject 

func (in *Snapshot) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (Snapshot) GetComponentResourceVersion 

func (in Snapshot) GetComponentResourceVersion() string

GetComponentResourceVersion returns the resource version for the snapshot

func (Snapshot) GetComponentVersion 

func (in Snapshot) GetComponentVersion() string

GetComponentVersion returns the component version for the snapshot

func (Snapshot) GetConditions 

func (in Snapshot) GetConditions() []metav1.Condition

GetConditions returns the status conditions of the object.

func (Snapshot) GetDigest 

func (in Snapshot) GetDigest() string

GetDigest returns the last reconciled digest for the snapshot

func (*Snapshot) SetConditions 

func (in *Snapshot) SetConditions(conditions []metav1.Condition)

SetConditions sets the status conditions on the object.

type SnapshotList 

type SnapshotList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Snapshot `json:"items"`
}

SnapshotList contains a list of Snapshot

func (*SnapshotList) DeepCopy 

func (in *SnapshotList) DeepCopy() *SnapshotList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SnapshotList.

func (*SnapshotList) DeepCopyInto 

func (in *SnapshotList) DeepCopyInto(out *SnapshotList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*SnapshotList) DeepCopyObject 

func (in *SnapshotList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type SnapshotSpec 

type SnapshotSpec struct {
	Identity ocmmetav1.Identity `json:"identity"`

	Digest string `json:"digest"`

	Tag string `json:"tag"`

	// Suspend stops all operations on this object.
	// +optional
	Suspend bool `json:"suspend,omitempty"`
}

SnapshotSpec defines the desired state of Snapshot

func (*SnapshotSpec) DeepCopy 

func (in *SnapshotSpec) DeepCopy() *SnapshotSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SnapshotSpec.

func (*SnapshotSpec) DeepCopyInto 

func (in *SnapshotSpec) DeepCopyInto(out *SnapshotSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SnapshotStatus 

type SnapshotStatus struct {
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// Digest is calculated by the caching layer.
	// +optional
	LastReconciledDigest string `json:"digest,omitempty"`

	// Tag defines the explicit tag that was used to create the related snapshot and cache entry.
	// +optional
	LastReconciledTag string `json:"tag,omitempty"`

	// RepositoryURL has the concrete URL pointing to the local registry including the service name.
	// +optional
	RepositoryURL string `json:"repositoryURL,omitempty"`

	// ObservedGeneration is the last reconciled generation.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}

SnapshotStatus defines the observed state of Snapshot

func (*SnapshotStatus) DeepCopy 

func (in *SnapshotStatus) DeepCopy() *SnapshotStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SnapshotStatus.

func (*SnapshotStatus) DeepCopyInto 

func (in *SnapshotStatus) DeepCopyInto(out *SnapshotStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SnapshotTemplateSpec 

type SnapshotTemplateSpec struct {
	// +required
	Name string `json:"name"`

	// +optional
	Labels map[string]string `json:"labels,omitempty"`

	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`
}

SnapshotTemplateSpec defines the template used to create snapshots

func (*SnapshotTemplateSpec) DeepCopy 

func (in *SnapshotTemplateSpec) DeepCopy() *SnapshotTemplateSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SnapshotTemplateSpec.

func (*SnapshotTemplateSpec) DeepCopyInto 

func (in *SnapshotTemplateSpec) DeepCopyInto(out *SnapshotTemplateSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SnapshotWriter 

type SnapshotWriter interface {
	client.Object
	GetSnapshotDigest() string
	GetSnapshotName() string
}

SnapshotWriter defines any object which produces a snapshot +k8s:deepcopy-gen=false

type ValuesSource 

type ValuesSource struct {
	// +optional
	FluxSource *FluxValuesSource `json:"fluxSource,omitempty"`
}

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.

func (*ValuesSource) DeepCopy 

func (in *ValuesSource) DeepCopy() *ValuesSource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ValuesSource.

func (*ValuesSource) DeepCopyInto 

func (in *ValuesSource) DeepCopyInto(out *ValuesSource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Version 

type Version struct {
	// +optional
	Semver string `json:"semver,omitempty"`
}

Version defines version upgrade / downgrade options.

func (*Version) DeepCopy 

func (in *Version) DeepCopy() *Version

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Version.

func (*Version) DeepCopyInto 

func (in *Version) DeepCopyInto(out *Version)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.