shared

Documentation

Index

• Constants
• func IsEnabled(value string) bool
• type Channel
  • func (c Channel) Equals(value string) bool
• type Kind
  • func (k Kind) Plural() string
• 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)
  • func (r Resource) ID() string
  • func (r Resource) ToUnstructured() *unstructured.Unstructured
• type State
  • func AllStates() []State
  • func (state State) IsSupportedState() bool
• type Status
  • func (in *Status) DeepCopy() *Status
  • func (in *Status) DeepCopyInto(out *Status)
  • func (s Status) WithErr(err error) Status
  • func (s Status) WithOperation(operation string) Status
  • func (s Status) WithState(state State) Status

Constants

const (
	KymaFinalizer            = OperatorGroup + Separator + string(KymaKind)
	PurgeFinalizer           = OperatorGroup + Separator + "purge-finalizer"
	WatcherFinalizer         = OperatorGroup + Separator + "watcher"
	MandatoryModuleFinalizer = OperatorGroup + Separator + "mandatory-module"
)

const (
	FQDN = OperatorGroup + Separator + "fqdn"

	// OwnedByAnnotation defines the resource managing the resource. Differing from ManagedBy
	// in that it does not reference controllers. Used by the runtime-watcher to determine the
	// corresponding CR in KCP.
	OwnedByAnnotation          = OperatorGroup + Separator + "owned-by"
	OwnedByFormat              = "%s/%s"
	IsClusterScopedAnnotation  = OperatorGroup + Separator + "is-cluster-scoped"
	CustomStateCheckAnnotation = OperatorGroup + Separator + "custom-state-check"
	ModuleVersionAnnotation    = OperatorGroup + Separator + "module-version"
	UnmanagedAnnotation        = OperatorGroup + Separator + "is-unmanaged"
)

const (
	OperatorGroup  = "operator.kyma-project.io"
	Separator      = "/"
	ControllerName = OperatorGroup + Separator + "controller-name"
	ChannelLabel   = OperatorGroup + Separator + "channel"
	// ManagedBy defines the controller managing the resource.
	ManagedBy           = OperatorGroup + Separator + "managed-by"
	ManagedByLabelValue = kymaValue

	IstioInjectionLabel = "istio-injection"
	WardenLabel         = "namespaces.warden.kyma-project.io/validate"
	EnabledValue        = "enabled"
	KymaName            = OperatorGroup + Separator + "kyma-name"
	Signature           = OperatorGroup + Separator + "signature"
	ModuleName          = OperatorGroup + Separator + "module-name"
	IsMandatoryModule   = OperatorGroup + Separator + "mandatory-module"

	//nolint:gosec // OCI registry credits label, no confidential content
	OCIRegistryCredLabel = "oci-registry-cred"
	OperatorName         = "lifecycle-manager"
	// WatchedByLabel defines a redirect to a controller that should be getting a notification
	// if this resource is changed.
	WatchedByLabel      = OperatorGroup + Separator + "watched-by"
	WatchedByLabelValue = kymaValue
	// PurposeLabel defines the purpose of the resource, i.e. Secrets which will be used to certificate management.
	PurposeLabel = OperatorGroup + Separator + "purpose"
	CertManager  = "klm-watcher-cert-manager"
	// SkipReconcileLabel indicates this specific resource will be skipped during reconciliation.
	SkipReconcileLabel     = OperatorGroup + Separator + "skip-reconciliation"
	UnmanagedKyma          = "unmanaged-kyma"
	DefaultRemoteKymaName  = "default"
	DefaultRemoteNamespace = "kyma-system"
	InternalLabel          = OperatorGroup + Separator + "internal"
	BetaLabel              = OperatorGroup + Separator + "beta"

	// Controls ModuleTemplate sync logic.
	// If put on the Kyma object, allows to disable sync for all ModuleTemplatesByLabel
	// If put on a single ModuleTemplate, allows to disable sync just for this object.
	SyncLabel = OperatorGroup + Separator + "sync"

	EnableLabelValue  = "true"
	DisableLabelValue = "false"
)

const (
	InstanceIDLabel = "kyma-project.io/instance-id"
)

const (
	// This annotation carries the FQDN of the shoot cluster, for example: "<shootid>.kyma.ondemand.com".
	SKRDomainAnnotation = "skr-domain"
)

Functions

func IsEnabled

func IsEnabled(value string) bool

Types

type Channel

type Channel string

const (
	// NoneChannel when this value is defined for the ModuleTemplate, it means that the ModuleTemplate is not assigned to any channel.
	NoneChannel Channel = "none"
)

func (Channel) Equals

func (c Channel) Equals(value string) bool

type Kind

type Kind string

const (
	KymaKind              Kind = "Kyma"
	ModuleTemplateKind    Kind = "ModuleTemplate"
	WatcherKind           Kind = "Watcher"
	ManifestKind          Kind = "Manifest"
	ModuleReleaseMetaKind Kind = "ModuleReleaseMeta"
)

func (Kind) Plural

func (k Kind) Plural() string

type LastOperation

type LastOperation struct {
	Operation      string         `json:"operation"`
	LastUpdateTime apimetav1.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"`
	apimetav1.GroupVersionKind `json:",inline"`
}

+k8s:deepcopy-gen=true

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.

func (Resource) ID

func (r Resource) ID() string

func (Resource) ToUnstructured

func (r Resource) ToUnstructured() *unstructured.Unstructured

type State

type State string

+kubebuilder:validation:Enum=Processing;Deleting;Ready;Error;"";Warning;Unmanaged

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"
	// 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"

	// 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"

	StateUnmanaged State = "Unmanaged"
)

Valid States.

func AllStates

func AllStates() []State

func (State) IsSupportedState

func (state State) IsSupportedState() bool

IsSupportedState These states will be used by module CR.

type Status

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

	// Conditions contain a set of conditionals to determine the State of Status.
	// If all Conditions are met, the State is expected to be in StateReady.
	// +listType=map
	// +listMapKey=type
	Conditions []apimetav1.Condition `json:"conditions,omitempty" patchMergeKey:"type" patchStrategy:"merge"`

	// Synced determine a list of Resources that are currently actively synced.
	// All resources that are synced are considered for orphan removal on configuration changes,
	// and it is used to determine effective differences from one state to the next.
	// +listType=atomic
	Synced        []Resource `json:"synced,omitempty"`
	LastOperation `json:"lastOperation,omitempty"`
}

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

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) WithErr

func (s Status) WithErr(err error) Status

func (Status) WithOperation

func (s Status) WithOperation(operation string) Status

func (Status) WithState

func (s Status) WithState(state State) Status