apis

Documentation

Overview

Package shared contains types and functions used by API definitions in the operators package +groupName=operators.example.com

Index

• type BasicMultiPhaseObjectStatus
  • func (in *BasicMultiPhaseObjectStatus) DeepCopy() *BasicMultiPhaseObjectStatus
  • func (in *BasicMultiPhaseObjectStatus) DeepCopyInto(out *BasicMultiPhaseObjectStatus)
  • func (h *BasicMultiPhaseObjectStatus) GetPhaseName() shared.PhaseName
  • func (h *BasicMultiPhaseObjectStatus) SetPhaseName(name shared.PhaseName)
• type BasicObjectStatus
  • func (in *BasicObjectStatus) DeepCopy() *BasicObjectStatus
  • func (in *BasicObjectStatus) DeepCopyInto(out *BasicObjectStatus)
  • func (h *BasicObjectStatus) GetConditions() []metav1.Condition
  • func (h *BasicObjectStatus) GetIsOnError() bool
  • func (h *BasicObjectStatus) GetLastErrorMessage() string
  • func (h *BasicObjectStatus) GetObservedGeneration() int64
  • func (h *BasicObjectStatus) SetConditions(conditions []metav1.Condition)
  • func (h *BasicObjectStatus) SetIsOnError(isError bool)
  • func (h *BasicObjectStatus) SetLastErrorMessage(message string)
  • func (h *BasicObjectStatus) SetObservedGeneration(version int64)
• type BasicRemoteObjectStatus
  • func (in *BasicRemoteObjectStatus) DeepCopy() *BasicRemoteObjectStatus
  • func (in *BasicRemoteObjectStatus) DeepCopyInto(out *BasicRemoteObjectStatus)
  • func (h *BasicRemoteObjectStatus) GetIsSync() bool
  • func (h *BasicRemoteObjectStatus) GetLastAppliedConfiguration() string
  • func (h *BasicRemoteObjectStatus) SetIsSync(isSync bool)
  • func (h *BasicRemoteObjectStatus) SetLastAppliedConfiguration(object string)
• type MapAny
  • func (in *MapAny) DeepCopy() *MapAny
  • func (ma *MapAny) DeepCopyInto(maCopy *MapAny)
  • func (ma MapAny) MarshalJSON() ([]byte, error)
  • func (ma *MapAny) UnmarshalJSON(data []byte) error

Types

type BasicMultiPhaseObjectStatus

type BasicMultiPhaseObjectStatus struct {
	BasicObjectStatus `json:",inline"`

	// Phase is the current phase
	// +operator-sdk:csv:customresourcedefinitions:type=status
	PhaseName shared.PhaseName `json:"phase,omitempty"`
}

MultiPhaseObjectStatus is the default status for CRD used to create multiple K8s resources

func (*BasicMultiPhaseObjectStatus) DeepCopy

func (in *BasicMultiPhaseObjectStatus) DeepCopy() *BasicMultiPhaseObjectStatus

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

func (*BasicMultiPhaseObjectStatus) DeepCopyInto

func (in *BasicMultiPhaseObjectStatus) DeepCopyInto(out *BasicMultiPhaseObjectStatus)

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

func (*BasicMultiPhaseObjectStatus) GetPhaseName

func (h *BasicMultiPhaseObjectStatus) GetPhaseName() shared.PhaseName

func (*BasicMultiPhaseObjectStatus) SetPhaseName

func (h *BasicMultiPhaseObjectStatus) SetPhaseName(name shared.PhaseName)

type BasicObjectStatus

type BasicObjectStatus struct {

	// IsOnError is true if controller is stuck on Error
	// +operator-sdk:csv:customresourcedefinitions:type=status
	IsOnError *bool `json:"isOnError,omitempty"`

	// List of conditions
	// +operator-sdk:csv:customresourcedefinitions:type=status
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`

	// LastErrorMessage is the current error message
	// +operator-sdk:csv:customresourcedefinitions:type=status
	LastErrorMessage string `json:"lastErrorMessage,omitempty"`

	// observedGeneration is the current generation applied
	// +operator-sdk:csv:customresourcedefinitions:type=status
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}

BasicObjectStatus is the default status for basic Object

func (*BasicObjectStatus) DeepCopy

func (in *BasicObjectStatus) DeepCopy() *BasicObjectStatus

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

func (*BasicObjectStatus) DeepCopyInto

func (in *BasicObjectStatus) DeepCopyInto(out *BasicObjectStatus)

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

func (*BasicObjectStatus) GetConditions

func (h *BasicObjectStatus) GetConditions() []metav1.Condition

func (*BasicObjectStatus) GetIsOnError

func (h *BasicObjectStatus) GetIsOnError() bool

func (*BasicObjectStatus) GetLastErrorMessage

func (h *BasicObjectStatus) GetLastErrorMessage() string

func (*BasicObjectStatus) GetObservedGeneration

func (h *BasicObjectStatus) GetObservedGeneration() int64

func (*BasicObjectStatus) SetConditions

func (h *BasicObjectStatus) SetConditions(conditions []metav1.Condition)

func (*BasicObjectStatus) SetIsOnError

func (h *BasicObjectStatus) SetIsOnError(isError bool)

func (*BasicObjectStatus) SetLastErrorMessage

func (h *BasicObjectStatus) SetLastErrorMessage(message string)

func (*BasicObjectStatus) SetObservedGeneration

func (h *BasicObjectStatus) SetObservedGeneration(version int64)

type BasicRemoteObjectStatus

type BasicRemoteObjectStatus struct {
	BasicObjectStatus `json:",inline"`

	// IsSync is true if controller successfully apply on remote API
	// +operator-sdk:csv:customresourcedefinitions:type=status
	IsSync *bool `json:"isSync,omitempty"`

	// LastAppliedConfiguration is the last applied configuration to use 3-way diff
	// +operator-sdk:csv:customresourcedefinitions:type=status
	LastAppliedConfiguration string `json:"lastAppliedConfiguration,omitempty"`
}

RemoteObjectStatus is the default status for CRD used to call remote API (not create K8s resources)

func (*BasicRemoteObjectStatus) DeepCopy

func (in *BasicRemoteObjectStatus) DeepCopy() *BasicRemoteObjectStatus

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

func (*BasicRemoteObjectStatus) DeepCopyInto

func (in *BasicRemoteObjectStatus) DeepCopyInto(out *BasicRemoteObjectStatus)

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

func (*BasicRemoteObjectStatus) GetIsSync

func (h *BasicRemoteObjectStatus) GetIsSync() bool

func (*BasicRemoteObjectStatus) GetLastAppliedConfiguration

func (h *BasicRemoteObjectStatus) GetLastAppliedConfiguration() string

func (*BasicRemoteObjectStatus) SetIsSync

func (h *BasicRemoteObjectStatus) SetIsSync(isSync bool)

func (*BasicRemoteObjectStatus) SetLastAppliedConfiguration

func (h *BasicRemoteObjectStatus) SetLastAppliedConfiguration(object string)

type MapAny

type MapAny struct {
	// Data is the map[string]any contend
	Data map[string]any `json:"-"`
}

MapAny is YAML map[string]any representation +kubebuilder:validation:Type=object

func (*MapAny) DeepCopy

func (in *MapAny) DeepCopy() *MapAny

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

func (*MapAny) DeepCopyInto

func (ma *MapAny) DeepCopyInto(maCopy *MapAny)

DeepCopyInto is needed by controller

func (MapAny) MarshalJSON

func (ma MapAny) MarshalJSON() ([]byte, error)

MarshalJSON implements the Marshaler interface.

func (*MapAny) UnmarshalJSON

func (ma *MapAny) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the Unmarshaler interface.