v1alpha1

Documentation

Overview

+k8s:deepcopy-gen=package +groupName=caching.internal.knative.dev

Index

• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type Image
  • func (in *Image) DeepCopy() *Image
  • func (in *Image) DeepCopyInto(out *Image)
  • func (in *Image) DeepCopyObject() runtime.Object
  • func (i *Image) GetGroupVersionKind() schema.GroupVersionKind
  • func (r *Image) SetDefaults(ctx context.Context)
  • func (rt *Image) Validate(ctx context.Context) *apis.FieldError
• type ImageCondition
  • func (in *ImageCondition) DeepCopy() *ImageCondition
  • func (in *ImageCondition) DeepCopyInto(out *ImageCondition)
• type ImageConditionType
• type ImageList
  • func (in *ImageList) DeepCopy() *ImageList
  • func (in *ImageList) DeepCopyInto(out *ImageList)
  • func (in *ImageList) DeepCopyObject() runtime.Object
• type ImageSpec
  • func (in *ImageSpec) DeepCopy() *ImageSpec
  • func (in *ImageSpec) DeepCopyInto(out *ImageSpec)
  • func (rs *ImageSpec) Validate(ctx context.Context) *apis.FieldError
• type ImageStatus
  • func (in *ImageStatus) DeepCopy() *ImageStatus
  • func (in *ImageStatus) DeepCopyInto(out *ImageStatus)
  • func (rs *ImageStatus) GetCondition(t ImageConditionType) *ImageCondition
  • func (rs *ImageStatus) InitializeConditions()
  • func (rs *ImageStatus) IsReady() bool
  • func (rs *ImageStatus) SetCondition(new *ImageCondition)

Variables

var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: caching.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Image

type Image struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec holds the desired state of the Image (from the client).
	// +optional
	Spec ImageSpec `json:"spec,omitempty"`

	// Status communicates the observed state of the Image (from the controller).
	// +optional
	Status ImageStatus `json:"status,omitempty"`
}

Image is a Knative abstraction that encapsulates the interface by which Knative components express a desire to have a particular image cached.

func (*Image) DeepCopy

func (in *Image) DeepCopy() *Image

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

func (*Image) DeepCopyInto

func (in *Image) DeepCopyInto(out *Image)

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

func (*Image) DeepCopyObject

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

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

func (*Image) GetGroupVersionKind

func (i *Image) GetGroupVersionKind() schema.GroupVersionKind

func (*Image) SetDefaults

func (r *Image) SetDefaults(ctx context.Context)

func (*Image) Validate

func (rt *Image) Validate(ctx context.Context) *apis.FieldError

type ImageCondition

type ImageCondition struct {
	Type ImageConditionType `json:"type" description:"type of Image condition"`

	Status corev1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"`

	// +optional
	// We use VolatileTime in place of metav1.Time to exclude this from creating equality.Semantic
	// differences (all other things held constant).
	LastTransitionTime apis.VolatileTime `json:"lastTransitionTime,omitempty" description:"last time the condition transit from one status to another"`

	// +optional
	Reason string `json:"reason,omitempty" description:"one-word CamelCase reason for the condition's last transition"`

	// +optional
	Message string `json:"message,omitempty" description:"human-readable message indicating details about last transition"`
}

ImageCondition defines a readiness condition for a Image. See: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#typical-status-properties

func (*ImageCondition) DeepCopy

func (in *ImageCondition) DeepCopy() *ImageCondition

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

func (*ImageCondition) DeepCopyInto

func (in *ImageCondition) DeepCopyInto(out *ImageCondition)

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

type ImageConditionType

type ImageConditionType string

ImageConditionType is used to communicate the status of the reconciliation process.

const (
	// ImageConditionReady is set when the revision is starting to materialize
	// runtime resources, and becomes true when those resources are ready.
	ImageConditionReady ImageConditionType = "Ready"
)

type ImageList

type ImageList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []Image `json:"items"`
}

ImageList is a list of Image resources

func (*ImageList) DeepCopy

func (in *ImageList) DeepCopy() *ImageList

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

func (*ImageList) DeepCopyInto

func (in *ImageList) DeepCopyInto(out *ImageList)

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

func (*ImageList) DeepCopyObject

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

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

type ImageSpec

type ImageSpec struct {

	// Image is the name of the container image url to cache across the cluster.
	Image string `json:"image"`

	// ServiceAccountName is the name of the Kubernetes ServiceAccount as which the Pods
	// will run this container.  This is potentially used to authenticate the image pull
	// if the service account has attached pull secrets.  For more information:
	// https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#add-imagepullsecrets-to-a-service-account
	// +optional
	ServiceAccountName string `json:"serviceAccountName,omitempty"`

	// ImagePullSecrets contains the names of the Kubernetes Secrets containing login
	// information used by the Pods which will run this container.
	// +optional
	ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`
}

ImageSpec holds the desired state of the Image (from the client).

func (*ImageSpec) DeepCopy

func (in *ImageSpec) DeepCopy() *ImageSpec

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

func (*ImageSpec) DeepCopyInto

func (in *ImageSpec) DeepCopyInto(out *ImageSpec)

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

func (*ImageSpec) Validate

func (rs *ImageSpec) Validate(ctx context.Context) *apis.FieldError

type ImageStatus

type ImageStatus struct {
	// Conditions communicates information about ongoing/complete
	// reconciliation processes that bring the "spec" inline with the observed
	// state of the world.
	// +optional
	Conditions []ImageCondition `json:"conditions,omitempty"`
}

ImageStatus communicates the observed state of the Image (from the controller).

func (*ImageStatus) DeepCopy

func (in *ImageStatus) DeepCopy() *ImageStatus

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

func (*ImageStatus) DeepCopyInto

func (in *ImageStatus) DeepCopyInto(out *ImageStatus)

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

func (*ImageStatus) GetCondition

func (rs *ImageStatus) GetCondition(t ImageConditionType) *ImageCondition

func (*ImageStatus) InitializeConditions

func (rs *ImageStatus) InitializeConditions()

func (*ImageStatus) IsReady

func (rs *ImageStatus) IsReady() bool

IsReady looks at the conditions and if the Status has a condition ImageConditionReady returns true if ConditionStatus is True

func (*ImageStatus) SetCondition

func (rs *ImageStatus) SetCondition(new *ImageCondition)