v1beta1

Documentation

Overview

Package v1beta1 contains API Schema definitions for the Halkyon Link v1beta1 API group +k8s:deepcopy-gen=package,register +groupName=halkyon.io

Index

• Constants
• Variables
• type Link
  • func (in *Link) DeepCopy() *Link
  • func (in *Link) DeepCopyInto(out *Link)
  • func (in *Link) DeepCopyObject() runtime.Object
  • func (in *Link) GetGroupVersionKind() schema.GroupVersionKind
  • func (in *Link) Prototype() runtime.Object
• type LinkList
  • func (in *LinkList) DeepCopy() *LinkList
  • func (in *LinkList) DeepCopyInto(out *LinkList)
  • func (in *LinkList) DeepCopyObject() runtime.Object
• type LinkPhase
  • func (l LinkPhase) Equals(other LinkPhase) bool
  • func (l LinkPhase) String() string
• type LinkSpec
  • func (in *LinkSpec) DeepCopy() *LinkSpec
  • func (in *LinkSpec) DeepCopyInto(out *LinkSpec)
• type LinkStatus
  • func (in *LinkStatus) DeepCopy() *LinkStatus
  • func (in *LinkStatus) DeepCopyInto(out *LinkStatus)
• type LinkType
  • func (l LinkType) Equals(other LinkType) bool
  • func (l LinkType) String() string

Constants

const Kind string = "Link"

Variables

var (
	// SchemeGroupVersion is the group version used to register these objects.
	SchemeGroupVersion = schema.GroupVersion{Group: api.GroupName, Version: api.V1Beta1Version}

	// AddToScheme is a function which adds this version to a scheme
	AddToScheme = schemeBuilder.AddToScheme
)

Types

type Link

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

	Spec   LinkSpec   `json:"spec,omitempty"`
	Status LinkStatus `json:"status,omitempty"`
}

Link is the Schema for the links API +k8s:openapi-gen=true +genclient

func (*Link) DeepCopy

func (in *Link) DeepCopy() *Link

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

func (*Link) DeepCopyInto

func (in *Link) DeepCopyInto(out *Link)

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

func (*Link) DeepCopyObject

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

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

func (*Link) GetGroupVersionKind

func (in *Link) GetGroupVersionKind() schema.GroupVersionKind

func (*Link) Prototype

func (in *Link) Prototype() runtime.Object

type LinkList

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

LinkList contains a list of Link

func (*LinkList) DeepCopy

func (in *LinkList) DeepCopy() *LinkList

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

func (*LinkList) DeepCopyInto

func (in *LinkList) DeepCopyInto(out *LinkList)

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

func (*LinkList) DeepCopyObject

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

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

type LinkPhase

type LinkPhase string

const (
	// LinkPending means the link has been accepted by the system, but it is still being processed.
	LinkPending LinkPhase = "Pending"
	// LinkReady means the link is ready.
	LinkReady LinkPhase = "Ready"
	// LinkFailed means that the linking operation failed.
	LinkFailed LinkPhase = "Failed"
	// LinkUnknown means that for some reason the state of the link could not be obtained, typically due
	// to an error in communicating with the host of the link.
	LinkUnknown LinkPhase = "Unknown"
)

func (LinkPhase) Equals

func (l LinkPhase) Equals(other LinkPhase) bool

func (LinkPhase) String

func (l LinkPhase) String() string

type LinkSpec

type LinkSpec struct {
	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
	// Important: Run "operator-sdk generate k8s" to regenerate code after modifying this file
	// Add custom validation using kubebuilder tags: https://book.kubebuilder.io/beyond_basics/generating_crd.html
	ComponentName string   `json:"componentName"`
	Type          LinkType `json:"type,omitempty"`
	Ref           string   `json:"ref,omitempty"`
	// Array of env variables containing extra/additional info to be used to configure the runtime
	Envs []v1beta1.NameValuePair `json:"envs,omitempty"`
}

LinkSpec defines the desired state of Link +k8s:openapi-gen=true

func (*LinkSpec) DeepCopy

func (in *LinkSpec) DeepCopy() *LinkSpec

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

func (*LinkSpec) DeepCopyInto

func (in *LinkSpec) DeepCopyInto(out *LinkSpec)

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

type LinkStatus

type LinkStatus struct {
	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
	// Important: Run "operator-sdk generate k8s" to regenerate code after modifying this file
	// Add custom validation using kubebuilder tags: https://book.kubebuilder.io/beyond_basics/generating_crd.html
	Phase   LinkPhase `json:"phase,omitempty"`
	Message string    `json:"message"`
}

LinkStatus defines the observed state of Link +k8s:openapi-gen=true

func (*LinkStatus) DeepCopy

func (in *LinkStatus) DeepCopy() *LinkStatus

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

func (*LinkStatus) DeepCopyInto

func (in *LinkStatus) DeepCopyInto(out *LinkStatus)

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

type LinkType

type LinkType string

const (
	SecretLinkType LinkType = "Secret"
	EnvLinkType    LinkType = "Env"
)

func (LinkType) Equals

func (l LinkType) Equals(other LinkType) bool

func (LinkType) String

func (l LinkType) String() string