external

Documentation

Overview

Package external implements external controller types.

Index

• func CreateFromTemplate(ctx context.Context, in *CreateFromTemplateInput) (*corev1.ObjectReference, error)
• func Delete(ctx context.Context, c client.Writer, ref *corev1.ObjectReference) error
• func FailuresFrom(obj *unstructured.Unstructured) (string, string, error)
• func GenerateTemplate(in *GenerateTemplateInput) (*unstructured.Unstructured, error)
• func Get(ctx context.Context, c client.Reader, ref *corev1.ObjectReference, ...) (*unstructured.Unstructured, error)
• func GetObjectReference(obj *unstructured.Unstructured) *corev1.ObjectReference
• func IsInitialized(obj *unstructured.Unstructured) (bool, error)
• func IsReady(obj *unstructured.Unstructured) (bool, error)
• type CreateFromTemplateInput
• type GenerateTemplateInput
• type ObjectTracker
  • func (o *ObjectTracker) Watch(log logr.Logger, obj runtime.Object, handler handler.EventHandler, ...) error
• type ReconcileOutput

Functions

func CreateFromTemplate

func CreateFromTemplate(ctx context.Context, in *CreateFromTemplateInput) (*corev1.ObjectReference, error)

CreateFromTemplate uses the client and the reference to create a new object from the template.

func Delete

func Delete(ctx context.Context, c client.Writer, ref *corev1.ObjectReference) error

Delete uses the client and reference to delete an external, unstructured object.

func FailuresFrom

func FailuresFrom(obj *unstructured.Unstructured) (string, string, error)

FailuresFrom returns the FailureReason and FailureMessage fields from the external object status.

func GenerateTemplate

func GenerateTemplate(in *GenerateTemplateInput) (*unstructured.Unstructured, error)

GenerateTemplate generates an object with the given template input.

func Get

func Get(ctx context.Context, c client.Reader, ref *corev1.ObjectReference, namespace string) (*unstructured.Unstructured, error)

Get uses the client and reference to get an external, unstructured object.

func GetObjectReference

func GetObjectReference(obj *unstructured.Unstructured) *corev1.ObjectReference

GetObjectReference converts an unstructured into object reference.

func IsInitialized

func IsInitialized(obj *unstructured.Unstructured) (bool, error)

IsInitialized returns true if the Status.Initialized field on an external object is true.

func IsReady

func IsReady(obj *unstructured.Unstructured) (bool, error)

IsReady returns true if the Status.Ready field on an external object is true.

Types

type CreateFromTemplateInput

type CreateFromTemplateInput struct {
	// Client is the controller runtime client.
	Client client.Client

	// TemplateRef is a reference to the template that needs to be cloned.
	TemplateRef *corev1.ObjectReference

	// Namespace is the Kubernetes namespace the cloned object should be created into.
	Namespace string

	// ClusterName is the cluster this object is linked to.
	ClusterName string

	// OwnerRef is an optional OwnerReference to attach to the cloned object.
	// +optional
	OwnerRef *metav1.OwnerReference

	// Labels is an optional map of labels to be added to the object.
	// +optional
	Labels map[string]string

	// Annotations is an optional map of annotations to be added to the object.
	// +optional
	Annotations map[string]string
}

CreateFromTemplateInput is the input to CreateFromTemplate.

type GenerateTemplateInput

type GenerateTemplateInput struct {
	// Template is the TemplateRef turned into an unstructured.
	Template *unstructured.Unstructured

	// TemplateRef is a reference to the template that needs to be cloned.
	TemplateRef *corev1.ObjectReference

	// Namespace is the Kubernetes namespace the cloned object should be created into.
	Namespace string

	// ClusterName is the cluster this object is linked to.
	ClusterName string

	// OwnerRef is an optional OwnerReference to attach to the cloned object.
	// +optional
	OwnerRef *metav1.OwnerReference

	// Labels is an optional map of labels to be added to the object.
	// +optional
	Labels map[string]string

	// Annotations is an optional map of annotations to be added to the object.
	// +optional
	Annotations map[string]string
}

GenerateTemplateInput is the input needed to generate a new template.

type ObjectTracker

type ObjectTracker struct {
	Controller controller.Controller
	Cache      cache.Cache
	// contains filtered or unexported fields
}

ObjectTracker is a helper struct to deal when watching external unstructured objects.

func (*ObjectTracker) Watch

func (o *ObjectTracker) Watch(log logr.Logger, obj runtime.Object, handler handler.EventHandler, p ...predicate.Predicate) error

Watch uses the controller to issue a Watch only if the object hasn't been seen before.

type ReconcileOutput

type ReconcileOutput struct {
	// RequeueAfter if greater than 0, tells the Controller to requeue the reconcile key after the Duration.
	// Implies that Requeue is true, there is no need to set Requeue to true at the same time as RequeueAfter.
	//
	// TODO(vincepri): Remove this field here and try to return a better struct that embeds ctrl.Result,
	// we can't do that today because the field would conflict with the current `Result` field,
	// which should probably be renamed to `Object` or something similar.
	RequeueAfter time.Duration
	// Details of the referenced external object.
	// +optional
	Result *unstructured.Unstructured
	// Indicates if the external object is paused.
	// +optional
	Paused bool
}

ReconcileOutput is a return type of the external reconciliation of referenced objects.