v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the operator v1alpha1 API group +kubebuilder:object:generate=true +groupName=operator.kyma-project.io

Index

• Variables
• type BtpOperator
  • func (o *BtpOperator) ComponentName() string
  • func (in *BtpOperator) DeepCopy() *BtpOperator
  • func (in *BtpOperator) DeepCopyInto(out *BtpOperator)
  • func (in *BtpOperator) DeepCopyObject() runtime.Object
  • func (o *BtpOperator) GetStatus() Status
  • func (o *BtpOperator) IsMsgForGivenReasonEqual(reason, message string) bool
  • func (o *BtpOperator) IsReasonStringEqual(reason string) bool
  • func (o *BtpOperator) SetStatus(status Status)
• type BtpOperatorList
  • func (in *BtpOperatorList) DeepCopy() *BtpOperatorList
  • func (in *BtpOperatorList) DeepCopyInto(out *BtpOperatorList)
  • func (in *BtpOperatorList) DeepCopyObject() runtime.Object
• type BtpOperatorSpec
  • func (in *BtpOperatorSpec) DeepCopy() *BtpOperatorSpec
  • func (in *BtpOperatorSpec) DeepCopyInto(out *BtpOperatorSpec)
• type LastOperation
  • func (in *LastOperation) DeepCopy() *LastOperation
  • func (in *LastOperation) DeepCopyInto(out *LastOperation)
• type Resource
  • func (in *Resource) DeepCopy() *Resource
  • func (in *Resource) DeepCopyInto(out *Resource)
• type State
• type Status
  • func (in *Status) DeepCopy() *Status
  • func (in *Status) DeepCopyInto(out *Status)
  • func (s *Status) WithState(state State) Status

Variables

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

Types

type BtpOperator

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

	//+nullable
	Spec   BtpOperatorSpec `json:"spec,omitempty"`
	Status Status          `json:"status,omitempty"`
}

BtpOperator is the Schema for the btpoperators API

func (*BtpOperator) ComponentName

func (o *BtpOperator) ComponentName() string

func (*BtpOperator) DeepCopy

func (in *BtpOperator) DeepCopy() *BtpOperator

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

func (*BtpOperator) DeepCopyInto

func (in *BtpOperator) DeepCopyInto(out *BtpOperator)

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

func (*BtpOperator) DeepCopyObject

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

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

func (*BtpOperator) GetStatus

func (o *BtpOperator) GetStatus() Status

func (*BtpOperator) IsMsgForGivenReasonEqual

func (o *BtpOperator) IsMsgForGivenReasonEqual(reason, message string) bool

func (*BtpOperator) IsReasonStringEqual

func (o *BtpOperator) IsReasonStringEqual(reason string) bool

func (*BtpOperator) SetStatus

func (o *BtpOperator) SetStatus(status Status)

type BtpOperatorList

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

BtpOperatorList contains a list of BtpOperator

func (*BtpOperatorList) DeepCopy

func (in *BtpOperatorList) DeepCopy() *BtpOperatorList

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

func (*BtpOperatorList) DeepCopyInto

func (in *BtpOperatorList) DeepCopyInto(out *BtpOperatorList)

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

func (*BtpOperatorList) DeepCopyObject

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

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

type BtpOperatorSpec

type BtpOperatorSpec struct{}

BtpOperatorSpec defines the desired state of BtpOperator

func (*BtpOperatorSpec) DeepCopy

func (in *BtpOperatorSpec) DeepCopy() *BtpOperatorSpec

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

func (*BtpOperatorSpec) DeepCopyInto

func (in *BtpOperatorSpec) DeepCopyInto(out *BtpOperatorSpec)

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

type LastOperation

type LastOperation struct {
	Operation      string      `json:"operation"`
	LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"`
}

LastOperation defines the last operation from the control-loop. +k8s:deepcopy-gen=true

func (*LastOperation) DeepCopy

func (in *LastOperation) DeepCopy() *LastOperation

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

func (*LastOperation) DeepCopyInto

func (in *LastOperation) DeepCopyInto(out *LastOperation)

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

type Resource

type Resource struct {
	Name                    string `json:"name"`
	Namespace               string `json:"namespace"`
	metav1.GroupVersionKind `json:",inline"`
}

func (*Resource) DeepCopy

func (in *Resource) DeepCopy() *Resource

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

func (*Resource) DeepCopyInto

func (in *Resource) DeepCopyInto(out *Resource)

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

type State

type State string

const (
	// StateReady signifies CustomObject is ready and has been installed successfully.
	StateReady State = "Ready"

	// StateProcessing signifies CustomObject is reconciling and is in the process of installation.
	// Processing can also signal that the Installation previously encountered an error and is now recovering.
	StateProcessing State = "Processing"

	// StateWarning signifies a warning for CustomObject. This signifies that the Installation
	// process encountered a problem.
	StateWarning State = "Warning"

	// StateError signifies an error for CustomObject. This signifies that the Installation
	// process encountered an error.
	// Contrary to Processing, it can be expected that this state should change on the next retry.
	StateError State = "Error"

	// StateDeleting signifies CustomObject is being deleted. This is the state that is used
	// when a deletionTimestamp was detected and Finalizers are picked up.
	StateDeleting State = "Deleting"
)

Valid CustomObject States.

type Status

type Status struct {
	// State signifies current state of CustomObject.
	// Value can be one of ("Ready", "Processing", "Error", "Deleting", "Warning").
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Enum=Processing;Deleting;Ready;Error;Warning
	State State `json:"state"`

	// Conditions associated with CustomStatus.
	Conditions []*metav1.Condition `json:"conditions,omitempty"`
}

+k8s:deepcopy-gen=true Status defines the observed state of CustomObject.

func (*Status) DeepCopy

func (in *Status) DeepCopy() *Status

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

func (*Status) DeepCopyInto

func (in *Status) DeepCopyInto(out *Status)

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

func (*Status) WithState

func (s *Status) WithState(state State) Status