v1alpha1

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API. +k8s:deepcopy-gen=package,register +k8s:openapi-gen=true +groupName=foo.example.io

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type Foo
  • func (in *Foo) DeepCopy() *Foo
  • func (in *Foo) DeepCopyInto(out *Foo)
  • func (in *Foo) DeepCopyObject() runtime.Object
  • func (r *Foo) Default()
  • func (r *Foo) SetupWebhookWithManager(mgr ctrl.Manager) error
  • func (r *Foo) ValidateCreate() (admission.Warnings, error)
  • func (r *Foo) ValidateDelete() (admission.Warnings, error)
  • func (r *Foo) ValidateUpdate(_ runtime.Object) (admission.Warnings, error)
• type FooList
  • func (in *FooList) DeepCopy() *FooList
  • func (in *FooList) DeepCopyInto(out *FooList)
  • func (in *FooList) DeepCopyObject() runtime.Object
• type FooSpec
  • func (in *FooSpec) DeepCopy() *FooSpec
  • func (in *FooSpec) DeepCopyInto(out *FooSpec)
• type FooStatus
  • func (in *FooStatus) DeepCopy() *FooStatus
  • func (in *FooStatus) DeepCopyInto(out *FooStatus)
• type FooType

Constants

const (
	// FooFinalizer ...
	FooFinalizer = "finalizers.example.io/foo-bar"
)

const GroupName = "foo.example.io"

GroupName specifies the group name used to register the objects.

Variables

var (
	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
	SchemeBuilder runtime.SchemeBuilder

	// Depreciated: use Install instead
	AddToScheme = localSchemeBuilder.AddToScheme
	Install     = localSchemeBuilder.AddToScheme
)

var GroupVersion = v1.GroupVersion{Group: GroupName, Version: "v1alpha1"}

GroupVersion specifies the group and the version used to register the objects.

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

SchemeGroupVersion is group version used to register these objects Deprecated: use GroupVersion instead.

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Foo

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

	Spec FooSpec `json:"spec"`
	// +optional
	Status FooStatus `json:"status,omitempty"`
}

Foo ...

func (*Foo) DeepCopy

func (in *Foo) DeepCopy() *Foo

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

func (*Foo) DeepCopyInto

func (in *Foo) DeepCopyInto(out *Foo)

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

func (*Foo) DeepCopyObject

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

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

func (*Foo) Default

func (r *Foo) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type

func (*Foo) SetupWebhookWithManager

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

SetupWebhookWithManager ...

func (*Foo) ValidateCreate

func (r *Foo) ValidateCreate() (admission.Warnings, error)

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*Foo) ValidateDelete

func (r *Foo) ValidateDelete() (admission.Warnings, error)

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*Foo) ValidateUpdate

func (r *Foo) ValidateUpdate(_ runtime.Object) (admission.Warnings, error)

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type FooList

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

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

FooList ...

func (*FooList) DeepCopy

func (in *FooList) DeepCopy() *FooList

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

func (*FooList) DeepCopyInto

func (in *FooList) DeepCopyInto(out *FooList)

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

func (*FooList) DeepCopyObject

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

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

type FooSpec

type FooSpec struct {
	// +kubebuilder:default=A
	Type FooType `json:"type"`
	// +kubebuilder:validation:MinLength=2
	Key string `json:"key"`
	// +optional
	Value string `json:"value,omitempty"`
}

FooSpec ...

func (*FooSpec) DeepCopy

func (in *FooSpec) DeepCopy() *FooSpec

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

func (*FooSpec) DeepCopyInto

func (in *FooSpec) DeepCopyInto(out *FooSpec)

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

type FooStatus

type FooStatus struct {
	// +kubebuilder:pruning:PreserveUnknownFields
	// +optional
	Raw *runtime.RawExtension `json:"raw,omitempty"`
}

FooStatus ...

func (*FooStatus) DeepCopy

func (in *FooStatus) DeepCopy() *FooStatus

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

func (*FooStatus) DeepCopyInto

func (in *FooStatus) DeepCopyInto(out *FooStatus)

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

type FooType

type FooType string

FooType ...

const (
	// FooTypeA ...
	FooTypeA FooType = "A"
	// FooTypeB ...
	FooTypeB FooType = "B"
)