v1alpha1

Documentation

Overview

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

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

Index

• Variables
• type Kind
• type Managed
  • func (in *Managed) DeepCopy() *Managed
  • func (in *Managed) DeepCopyInto(out *Managed)
  • func (in *Managed) DeepCopyObject() runtime.Object
• type ManagedList
  • func (in *ManagedList) DeepCopy() *ManagedList
  • func (in *ManagedList) DeepCopyInto(out *ManagedList)
  • func (in *ManagedList) DeepCopyObject() runtime.Object
• type Sample
  • func (in *Sample) DeepCopy() *Sample
  • func (in *Sample) DeepCopyInto(out *Sample)
  • func (in *Sample) DeepCopyObject() runtime.Object
• type SampleList
  • func (in *SampleList) DeepCopy() *SampleList
  • func (in *SampleList) DeepCopyInto(out *SampleList)
  • func (in *SampleList) DeepCopyObject() runtime.Object
• type SampleSpec
  • func (in *SampleSpec) DeepCopy() *SampleSpec
  • func (in *SampleSpec) DeepCopyInto(out *SampleSpec)
• type SampleStatus
  • func (in *SampleStatus) DeepCopy() *SampleStatus
  • func (in *SampleStatus) DeepCopyInto(out *SampleStatus)
  • func (s *SampleStatus) WithInstallConditionStatus(status metav1.ConditionStatus, objGeneration int64) *SampleStatus
  • func (s *SampleStatus) WithState(state State) *SampleStatus
• type State
• type Status
  • func (in *Status) DeepCopy() *Status
  • func (in *Status) DeepCopyInto(out *Status)

Variables

var (
	// GroupVersion is group version used to register these objects.
	GroupVersion = schema.GroupVersion{Group: "operator.kyma-project.io", Version: "v1alpha1"}

	ConditionTypeInstallation = "Installation"
	ConditionReasonReady      = "Ready"
)

Types

type Kind

type Kind string

const (
	SampleKind Kind = "Sample"
	Version    Kind = "v1alpha1"
)

type Managed

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

func (*Managed) DeepCopy

func (in *Managed) DeepCopy() *Managed

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

func (*Managed) DeepCopyInto

func (in *Managed) DeepCopyInto(out *Managed)

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

func (*Managed) DeepCopyObject

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

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

type ManagedList

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

ManagedList contains a list of Managed.

func (*ManagedList) DeepCopy

func (in *ManagedList) DeepCopy() *ManagedList

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

func (*ManagedList) DeepCopyInto

func (in *ManagedList) DeepCopyInto(out *ManagedList)

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

func (*ManagedList) DeepCopyObject

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

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

type Sample

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

	Spec   SampleSpec   `json:"spec,omitempty"`
	Status SampleStatus `json:"status,omitempty"`
}

Sample is the Schema for the samples API.

func (*Sample) DeepCopy

func (in *Sample) DeepCopy() *Sample

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

func (*Sample) DeepCopyInto

func (in *Sample) DeepCopyInto(out *Sample)

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

func (*Sample) DeepCopyObject

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

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

type SampleList

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

SampleList contains a list of Sample.

func (*SampleList) DeepCopy

func (in *SampleList) DeepCopy() *SampleList

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

func (*SampleList) DeepCopyInto

func (in *SampleList) DeepCopyInto(out *SampleList)

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

func (*SampleList) DeepCopyObject

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

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

type SampleSpec

type SampleSpec struct {
	// ResourceFilePath indicates the local dir path containing a .yaml or .yml,
	// with all required resources to be processed
	ResourceFilePath string `json:"resourceFilePath,omitempty"`
}

func (*SampleSpec) DeepCopy

func (in *SampleSpec) DeepCopy() *SampleSpec

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

func (*SampleSpec) DeepCopyInto

func (in *SampleSpec) DeepCopyInto(out *SampleSpec)

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

type SampleStatus

type SampleStatus struct {
	Status `json:",inline"`

	// Conditions contain a set of conditionals to determine the State of Status.
	// If all Conditions are met, State is expected to be in StateReady.
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

func (*SampleStatus) DeepCopy

func (in *SampleStatus) DeepCopy() *SampleStatus

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

func (*SampleStatus) DeepCopyInto

func (in *SampleStatus) DeepCopyInto(out *SampleStatus)

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

func (*SampleStatus) WithInstallConditionStatus

func (s *SampleStatus) WithInstallConditionStatus(status metav1.ConditionStatus, objGeneration int64) *SampleStatus

func (*SampleStatus) WithState

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

type State

type State string

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

	// StateProcessing signifies Module CR 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"

	// StateError signifies an error for Module CR. 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 Module CR is being deleted. This is the state that is used
	// when a deletionTimestamp was detected and Finalizers are picked up.
	StateDeleting State = "Deleting"

	// StateWarning signifies specified resource has been deployed, but cannot be used due to misconfiguration,
	// usually it means that user interaction is required.
	StateWarning State = "Warning"
)

Valid Module CR States.

type Status

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

Status defines the observed state of Module CR.

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.