v1alpha1

Documentation

Overview

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

Index

• Constants
• Variables
• type Artifact
  • func (in *Artifact) DeepCopy() *Artifact
  • func (in *Artifact) DeepCopyInto(out *Artifact)
  • func (in *Artifact) DeepCopyObject() runtime.Object
  • func (a *Artifact) GetArtifact() *sourcev1.Artifact
• type ArtifactList
  • func (in *ArtifactList) DeepCopy() *ArtifactList
  • func (in *ArtifactList) DeepCopyInto(out *ArtifactList)
  • func (in *ArtifactList) DeepCopyObject() runtime.Object
• type ArtifactSpec
  • func (in *ArtifactSpec) DeepCopy() *ArtifactSpec
  • func (in *ArtifactSpec) DeepCopyInto(out *ArtifactSpec)
• type ArtifactStatus
  • func (in *ArtifactStatus) DeepCopy() *ArtifactStatus
  • func (in *ArtifactStatus) DeepCopyInto(out *ArtifactStatus)

Constants

const (
	// ArtifactKind is the string representation of an Artifact.
	ArtifactKind = "Artifact"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "openfluxcd.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
)

Types

type Artifact

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

	Spec   ArtifactSpec   `json:"spec,omitempty"`
	Status ArtifactStatus `json:"status,omitempty"`
}

Artifact is the Schema for the artifacts API

func (*Artifact) DeepCopy

func (in *Artifact) DeepCopy() *Artifact

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

func (*Artifact) DeepCopyInto

func (in *Artifact) DeepCopyInto(out *Artifact)

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

func (*Artifact) DeepCopyObject

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

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

func (*Artifact) GetArtifact

func (a *Artifact) GetArtifact() *sourcev1.Artifact

type ArtifactList

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

ArtifactList contains a list of Artifact

func (*ArtifactList) DeepCopy

func (in *ArtifactList) DeepCopy() *ArtifactList

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

func (*ArtifactList) DeepCopyInto

func (in *ArtifactList) DeepCopyInto(out *ArtifactList)

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

func (*ArtifactList) DeepCopyObject

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

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

type ArtifactSpec

type ArtifactSpec struct {
	// URL is the HTTP address of the Artifact as exposed by the controller
	// managing the Source. It can be used to retrieve the Artifact for
	// consumption, e.g. by another controller applying the Artifact contents.
	// +required
	URL string `json:"url"`

	// Revision is a human-readable identifier traceable in the origin source
	// system. It can be a Git commit SHA, Git tag, a Helm chart version, etc.
	// +required
	Revision string `json:"revision"`

	// Digest is the digest of the file in the form of '<algorithm>:<checksum>'.
	// +optional
	// +kubebuilder:validation:Pattern="^[a-z0-9]+(?:[.+_-][a-z0-9]+)*:[a-zA-Z0-9=_-]+$"
	Digest string `json:"digest,omitempty"`

	// LastUpdateTime is the timestamp corresponding to the last update of the
	// Artifact.
	// +required
	LastUpdateTime metav1.Time `json:"lastUpdateTime"`

	// Size is the number of bytes in the file.
	// +optional
	Size *int64 `json:"size,omitempty"`

	// Metadata holds upstream information such as OCI annotations.
	// +optional
	Metadata map[string]string `json:"metadata,omitempty"`
}

ArtifactSpec defines the desired state of Artifact

func (*ArtifactSpec) DeepCopy

func (in *ArtifactSpec) DeepCopy() *ArtifactSpec

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

func (*ArtifactSpec) DeepCopyInto

func (in *ArtifactSpec) DeepCopyInto(out *ArtifactSpec)

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

type ArtifactStatus

type ArtifactStatus struct {
}

ArtifactStatus defines the observed state of Artifact

func (*ArtifactStatus) DeepCopy

func (in *ArtifactStatus) DeepCopy() *ArtifactStatus

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

func (*ArtifactStatus) DeepCopyInto

func (in *ArtifactStatus) DeepCopyInto(out *ArtifactStatus)

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