meta

Documentation

Overview

Package meta contains the generic metadata APIs for use by GitOps Toolkit components.

It is intended only to help adhere to Kubernetes API conventions, utility integrations, and Flux project considered best practices. It may therefore be suitable for usage by Kubernetes resources with no relationship to the GitOps Toolkit. +kubebuilder:object:generate=true

Index

• Constants
• func ReconcileAnnotationValue(annotations map[string]string) (string, bool)
• type LocalObjectReference
  • func (in *LocalObjectReference) DeepCopy() *LocalObjectReference
  • func (in *LocalObjectReference) DeepCopyInto(out *LocalObjectReference)
• type NamespacedObjectKindReference
  • func (in *NamespacedObjectKindReference) DeepCopy() *NamespacedObjectKindReference
  • func (in *NamespacedObjectKindReference) DeepCopyInto(out *NamespacedObjectKindReference)
• type NamespacedObjectReference
  • func (in *NamespacedObjectReference) DeepCopy() *NamespacedObjectReference
  • func (in *NamespacedObjectReference) DeepCopyInto(out *NamespacedObjectReference)
• type ObjectWithConditions
• type ObjectWithConditionsSetter
• type ObjectWithDependencies
• type ReconcileRequestStatus
  • func (in *ReconcileRequestStatus) DeepCopy() *ReconcileRequestStatus
  • func (in *ReconcileRequestStatus) DeepCopyInto(out *ReconcileRequestStatus)
  • func (in ReconcileRequestStatus) GetLastHandledReconcileRequest() string
  • func (in *ReconcileRequestStatus) SetLastHandledReconcileRequest(token string)
• type SecretKeyReference
  • func (in *SecretKeyReference) DeepCopy() *SecretKeyReference
  • func (in *SecretKeyReference) DeepCopyInto(out *SecretKeyReference)
• type StatusWithHandledReconcileRequest
• type StatusWithHandledReconcileRequestSetter

Constants

const (
	// ReadyCondition indicates the resource is ready and fully reconciled.
	// If the Condition is False, the resource SHOULD be considered to be in the process of reconciling and not a
	// representation of actual state.
	ReadyCondition string = "Ready"

	// StalledCondition indicates the reconciliation of the resource has stalled, e.g. because the controller has
	// encountered an error during the reconcile process or it has made insufficient progress (timeout).
	// The Condition adheres to an "abnormal-true" polarity pattern, and MUST only be present on the resource if the
	// Condition is True.
	// For more information about polarity patterns, see:
	// https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties
	StalledCondition string = "Stalled"

	// ReconcilingCondition indicates the controller is currently working on reconciling the latest changes. This MAY be
	// True for multiple reconciliation attempts, e.g. when an transient error occurred.
	// The Condition adheres to an "abnormal-true" polarity pattern, and MUST only be present on the resource if the
	// Condition is True.
	// For more information about polarity patterns, see:
	// https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties
	ReconcilingCondition string = "Reconciling"
)

These constants define generic Condition types to be used by GitOps Toolkit components.

The ReadyCondition SHOULD be implemented by all components' Kubernetes resources to indicate they have been fully reconciled by their respective reconciler. This MAY suffice for simple resources, e.g. a resource that just declares state once and is not expected to receive any updates afterwards.

For Kubernetes resources that are expected to receive spec updates over time, take a longer time to reconcile, or deal with more complex logic in which for example a finite error state can be observed, it is RECOMMENDED to implement the StalledCondition and ReconcilingCondition.

By doing this, observers making use of kstatus to determine the current state of the resource will have a better experience while they are e.g. waiting for a change to be reconciled, and will be able to stop waiting for a change if a StalledCondition is observed, without having to rely on a timeout.

For more information on kstatus, see: https://github.com/kubernetes-sigs/cli-utils/blob/v0.25.0/pkg/kstatus/README.md

const (
	// SucceededReason indicates a condition or event observed a success, for example when declared desired state
	// matches actual state, or a performed action succeeded.
	//
	// More information about the reason of success MAY be available as additional metadata in an attached message.
	SucceededReason string = "Succeeded"

	// FailedReason indicates a condition or event observed a failure, for example when declared state does not match
	// actual state, or a performed action failed.
	//
	// More information about the reason of failure MAY be available as additional metadata in an attached message.
	FailedReason string = "Failed"

	// ProgressingReason indicates a condition or event observed progression, for example when the reconciliation of a
	// resource or an action has started.
	//
	// When this reason is given, other conditions and types MAY no longer be considered as an up-to-date observation.
	// Producers of the specific condition type or event SHOULD provide more information about the expectations and
	// precise meaning in their API specification.
	//
	// More information about the reason or the current state of the progression MAY be available as additional metadata
	// in an attached message.
	ProgressingReason string = "Progressing"

	// SuspendedReason indicates a condition or event has observed a suspension, for
	// example because a resource has been suspended, or a dependency is.
	SuspendedReason string = "Suspended"
)

These constants define generic Condition reasons to be used by GitOps Toolkit components.

Making use of a generic Reason is RECOMMENDED whenever it can be applied to a Condition in which it provides sufficient context together with the type to summarize the meaning of the Condition cause.

Where any of the generic Condition reasons does not suffice, GitOps Toolkit components can introduce new reasons to their API specification, or use an arbitrary PascalCase string when setting the Condition. Declaration of domain common Condition reasons in the API specification is RECOMMENDED, as it eases observations for user and computer.

For more information on Condition reason conventions, see: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties

const (
	// ReconcileRequestAnnotation is the annotation used for triggering a reconciliation
	// outside of a defined schedule. The value is interpreted as a token, and any change
	// in value SHOULD trigger a reconciliation.
	ReconcileRequestAnnotation string = "reconcile.fluxcd.io/requestedAt"
)

Functions

func ReconcileAnnotationValue

func ReconcileAnnotationValue(annotations map[string]string) (string, bool)

ReconcileAnnotationValue returns a value for the reconciliation request annotation, which can be used to detect changes; and, a boolean indicating whether the annotation was set.

Types

type LocalObjectReference

type LocalObjectReference struct {
	// Name of the referent.
	// +required
	Name string `json:"name"`
}

LocalObjectReference contains enough information to locate the referenced Kubernetes resource object.

func (*LocalObjectReference) DeepCopy

func (in *LocalObjectReference) DeepCopy() *LocalObjectReference

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

func (*LocalObjectReference) DeepCopyInto

func (in *LocalObjectReference) DeepCopyInto(out *LocalObjectReference)

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

type NamespacedObjectKindReference

type NamespacedObjectKindReference struct {
	// API version of the referent, if not specified the Kubernetes preferred version will be used.
	// +optional
	APIVersion string `json:"apiVersion,omitempty"`

	// Kind of the referent.
	// +required
	Kind string `json:"kind"`

	// Name of the referent.
	// +required
	Name string `json:"name"`

	// Namespace of the referent, when not specified it acts as LocalObjectReference.
	// +optional
	Namespace string `json:"namespace,omitempty"`
}

NamespacedObjectKindReference contains enough information to locate the typed referenced Kubernetes resource object in any namespace.

func (*NamespacedObjectKindReference) DeepCopy

func (in *NamespacedObjectKindReference) DeepCopy() *NamespacedObjectKindReference

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

func (*NamespacedObjectKindReference) DeepCopyInto

func (in *NamespacedObjectKindReference) DeepCopyInto(out *NamespacedObjectKindReference)

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

type NamespacedObjectReference

type NamespacedObjectReference struct {
	// Name of the referent.
	// +required
	Name string `json:"name"`

	// Namespace of the referent, when not specified it acts as LocalObjectReference.
	// +optional
	Namespace string `json:"namespace,omitempty"`
}

NamespacedObjectReference contains enough information to locate the referenced Kubernetes resource object in any namespace.

func (*NamespacedObjectReference) DeepCopy

func (in *NamespacedObjectReference) DeepCopy() *NamespacedObjectReference

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

func (*NamespacedObjectReference) DeepCopyInto

func (in *NamespacedObjectReference) DeepCopyInto(out *NamespacedObjectReference)

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

type ObjectWithConditions

type ObjectWithConditions interface {
	// GetConditions returns a slice of metav1.Condition
	GetConditions() []metav1.Condition
}

ObjectWithConditions describes a Kubernetes resource object with status conditions. +k8s:deepcopy-gen=false

type ObjectWithConditionsSetter

type ObjectWithConditionsSetter interface {
	// SetConditions sets the status conditions on the object
	SetConditions([]metav1.Condition)
}

ObjectWithConditionsSetter describes a Kubernetes resource object with a status conditions setter. +k8s:deepcopy-gen=false

type ObjectWithDependencies

type ObjectWithDependencies interface {
	// GetDependsOn returns a NamespacedObjectReference list the object depends on.
	GetDependsOn() []NamespacedObjectReference
}

ObjectWithDependencies describes a Kubernetes resource object with dependencies. +k8s:deepcopy-gen=false

type ReconcileRequestStatus

type ReconcileRequestStatus struct {
	// LastHandledReconcileAt holds the value of the most recent
	// reconcile request value, so a change of the annotation value
	// can be detected.
	// +optional
	LastHandledReconcileAt string `json:"lastHandledReconcileAt,omitempty"`
}

ReconcileRequestStatus is a struct to embed in a status type, so that all types using the mechanism have the same field. Use it like this:

	type FooStatus struct {
 	meta.ReconcileRequestStatus `json:",inline"`
 	// other status fields...
	}

func (*ReconcileRequestStatus) DeepCopy

func (in *ReconcileRequestStatus) DeepCopy() *ReconcileRequestStatus

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

func (*ReconcileRequestStatus) DeepCopyInto

func (in *ReconcileRequestStatus) DeepCopyInto(out *ReconcileRequestStatus)

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

func (ReconcileRequestStatus) GetLastHandledReconcileRequest

func (in ReconcileRequestStatus) GetLastHandledReconcileRequest() string

GetLastHandledReconcileRequest returns the most recent reconcile request value from the ReconcileRequestStatus.

func (*ReconcileRequestStatus) SetLastHandledReconcileRequest

func (in *ReconcileRequestStatus) SetLastHandledReconcileRequest(token string)

SetLastHandledReconcileRequest sets the most recent reconcile request value in the ReconcileRequestStatus.

type SecretKeyReference

type SecretKeyReference struct {
	// Name of the Secret.
	// +required
	Name string `json:"name"`

	// Key in the Secret, when not specified an implementation-specific default key is used.
	// +optional
	Key string `json:"key,omitempty"`
}

SecretKeyReference contains enough information to locate the referenced Kubernetes Secret object in the same namespace. Optionally a key can be specified. Use this type instead of core/v1 SecretKeySelector when the Key is optional and the Optional field is not applicable.

func (*SecretKeyReference) DeepCopy

func (in *SecretKeyReference) DeepCopy() *SecretKeyReference

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

func (*SecretKeyReference) DeepCopyInto

func (in *SecretKeyReference) DeepCopyInto(out *SecretKeyReference)

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

type StatusWithHandledReconcileRequest

type StatusWithHandledReconcileRequest interface {
	GetLastHandledReconcileRequest() string
}

StatusWithHandledReconcileRequest describes a status type which holds the value of the most recent ReconcileAnnotationValue. +k8s:deepcopy-gen=false

type StatusWithHandledReconcileRequestSetter

type StatusWithHandledReconcileRequestSetter interface {
	SetLastHandledReconcileRequest(token string)
}

StatusWithHandledReconcileRequestSetter describes a status with a setter for the most ReconcileAnnotationValue. +k8s:deepcopy-gen=false