v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the kuik.enix.io v1alpha1 API group +kubebuilder:object:generate=true +groupName=kuik.enix.io

Index

• Variables
• type CachedImage
  • func (r *CachedImage) Default(ctx context.Context, obj runtime.Object) error
  • func (r *CachedImage) GetPullSecrets(apiReader client.Reader) ([]corev1.Secret, error)
  • func (r *CachedImage) Repository() (reference.Named, error)
  • func (r *CachedImage) SetupWebhookWithManager(mgr ctrl.Manager) error
• type CachedImageList
• type CachedImageSpec
• type CachedImageStatus
• type PodReference
• type Repository
  • func (r *Repository) CompileUpdateFilters() ([]regexp.Regexp, error)
  • func (r *Repository) GetPullSecrets(apiReader client.Reader) ([]corev1.Secret, error)
• type RepositoryList
• type RepositorySpec
• type RepositoryStatus
• type UsedBy

Variables

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

var RepositoryLabelName = "kuik.enix.io/repository"

Types

type CachedImage

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

	Spec   CachedImageSpec   `json:"spec,omitempty"`
	Status CachedImageStatus `json:"status,omitempty"`
}

CachedImage is the Schema for the cachedimages API

func (*CachedImage) Default

func (r *CachedImage) Default(ctx context.Context, obj runtime.Object) error

func (*CachedImage) GetPullSecrets

func (r *CachedImage) GetPullSecrets(apiReader client.Reader) ([]corev1.Secret, error)

func (*CachedImage) Repository

func (r *CachedImage) Repository() (reference.Named, error)

func (*CachedImage) SetupWebhookWithManager

func (r *CachedImage) SetupWebhookWithManager(mgr ctrl.Manager) error

type CachedImageList

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

CachedImageList contains a list of CachedImage

type CachedImageSpec

type CachedImageSpec struct {
	SourceImage string `json:"sourceImage"`
	// +optional
	ExpiresAt *metav1.Time `json:"expiresAt,omitempty"`
	// +optional
	Retain bool `json:"retain,omitempty"`
}

CachedImageSpec defines the desired state of CachedImage

type CachedImageStatus

type CachedImageStatus struct {
	IsCached bool   `json:"isCached,omitempty"`
	Phase    string `json:"phase,omitempty"`
	UsedBy   UsedBy `json:"usedBy,omitempty"`

	Digest             string      `json:"digest,omitempty"`
	UpstreamDigest     string      `json:"upstreamDigest,omitempty"`
	UpToDate           bool        `json:"upToDate,omitempty"`
	LastSync           metav1.Time `json:"lastSync,omitempty"`
	LastSuccessfulPull metav1.Time `json:"lastSuccessfulPull,omitempty"`

	AvailableUpstream bool        `json:"availableUpstream,omitempty"`
	LastSeenUpstream  metav1.Time `json:"lastSeenUpstream,omitempty"`
}

CachedImageStatus defines the observed state of CachedImage

type PodReference

type PodReference struct {
	NamespacedName string `json:"namespacedName,omitempty"`
}

type Repository

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

	Spec   RepositorySpec   `json:"spec,omitempty"`
	Status RepositoryStatus `json:"status,omitempty"`
}

Repository is the Schema for the repositories API

func (*Repository) CompileUpdateFilters

func (r *Repository) CompileUpdateFilters() ([]regexp.Regexp, error)

func (*Repository) GetPullSecrets

func (r *Repository) GetPullSecrets(apiReader client.Reader) ([]corev1.Secret, error)

type RepositoryList

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

RepositoryList contains a list of Repository

type RepositorySpec

type RepositorySpec struct {
	Name                 string           `json:"name"`
	PullSecretNames      []string         `json:"pullSecretNames,omitempty"`
	PullSecretsNamespace string           `json:"pullSecretsNamespace,omitempty"`
	UpdateInterval       *metav1.Duration `json:"updateInterval,omitempty"`
	UpdateFilters        []string         `json:"updateFilters,omitempty"`
}

RepositorySpec defines the desired state of Repository

type RepositoryStatus

type RepositoryStatus struct {
	Images     int         `json:"images,omitempty"`
	Phase      string      `json:"phase,omitempty"`
	LastUpdate metav1.Time `json:"lastUpdate,omitempty"`
	//+listType=map
	//+listMapKey=type
	//+patchStrategy=merge
	//+patchMergeKey=type
	//+optional
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
}

RepositoryStatus defines the observed state of Repository

type UsedBy

type UsedBy struct {
	Pods []PodReference `json:"pods,omitempty" patchStrategy:"merge" patchMergeKey:"namespacedName"`
	// jsonpath function .length() is not implemented, so the count field is required to display pods count in additionalPrinterColumns
	// see https://github.com/kubernetes-sigs/controller-tools/issues/447
	Count int `json:"count,omitempty"`
}