common

Documentation

Index

• Constants
• type LocalObjectReference
  • func (r *LocalObjectReference) NamespacedName(namespace string) apimachinery.NamespacedName
• type LocalSecretReference
• type ObjectReference
  • func (r *ObjectReference) NamespacedName() apimachinery.NamespacedName
• type SecretReference
• type Status
  • func (in *Status) DeepCopy() *Status
  • func (in *Status) DeepCopyInto(out *Status)

Constants

const (
	// StatusPhaseReady indicates that the resource is ready. All conditions are met and are in status "True".
	StatusPhaseReady = "Ready"
	// StatusPhaseProgressing indicates that the resource is not ready and being created or updated. At least one condition is not met and is in status "False".
	StatusPhaseProgressing = "Progressing"
	// StatusPhaseTerminating indicates that the resource is not ready and in deletion. At least one condition is not met and is in status "False".
	StatusPhaseTerminating = "Terminating"
)

const ClusterScoped = ""

ClusterScoped can be passed into a LocalObjectReference's NamespacedName method to indicate that the object is cluster-scoped.

Types

type LocalObjectReference

type LocalObjectReference corev1.LocalObjectReference

LocalObjectReference is a reference to an object in the same namespace as the resource referencing it.

func (*LocalObjectReference) NamespacedName

func (r *LocalObjectReference) NamespacedName(namespace string) apimachinery.NamespacedName

NamespacedName returns the NamespacedName of the LocalObjectReference. This is a convenience method to convert the LocalObjectReference to a NamespacedName, which can be passed into k8s client methods. Since LocalObjectReference refers to an object in the same namespace as the resource referencing it, which is only known from context, this method requires a namespace parameter. An empty string (or the ClusterScoped constant) can be used to indicate that the object is cluster-scoped.

type LocalSecretReference

type LocalSecretReference struct {
	LocalObjectReference `json:",inline"`
	// Key is the key in the secret to use.
	Key string `json:"key"`
}

LocalSecretReference is a reference to a secret in the same namespace as the resource referencing it with a key.

type ObjectReference

type ObjectReference struct {
	// Name is the name of the object.
	Name string `json:"name"`
	// Namespace is the namespace of the object.
	Namespace string `json:"namespace"`
}

ObjectReference is a reference to an object in any namespace.

func (*ObjectReference) NamespacedName

func (r *ObjectReference) NamespacedName() apimachinery.NamespacedName

NamespacedName returns the NamespacedName of the ObjectReference. This is a convenience method to convert the ObjectReference to a NamespacedName, which can be passed into k8s client methods.

type SecretReference

type SecretReference struct {
	ObjectReference `json:",inline"`
	// Key is the key in the secret to use.
	Key string `json:"key"`
}

SecretReference is a reference to a secret in any namespace with a key.

type Status

type Status struct {
	// ObservedGeneration is the generation of this resource that was last reconciled by the controller.
	ObservedGeneration int64 `json:"observedGeneration"`

	// Phase is the current phase of the resource.
	Phase string `json:"phase"`

	// Conditions contains the conditions.
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

Status represents the status of an openMCP resource.

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.