vaultresourcecontroller

Documentation

Index

• Constants
• func AdvancedTemplateFuncMap(config *rest.Config, logger logr.Logger) template.FuncMap
• func GetDynamicClientForAPIResource(context context.Context, resource *metav1.APIResource) (dynamic.NamespaceableResourceInterface, error)
• func GetDynamicClientForGVK(context context.Context, gvk schema.GroupVersionKind) (dynamic.NamespaceableResourceInterface, bool, error)
• func GetDynamicClientOnUnstructured(context context.Context, obj *unstructured.Unstructured) (dynamic.ResourceInterface, error)
• func IsOwner(owner, owned metav1.Object) bool
• func ManageOutcome(context context.Context, r ReconcilerBase, obj client.Object, issue error) (reconcile.Result, error)
• func ManageOutcomeWithRequeue(context context.Context, r ReconcilerBase, obj client.Object, issue error, ...) (reconcile.Result, error)
• func NewLookupFunction(config *rest.Config, logger logr.Logger) lookupFunc
• func SetIndexField(context context.Context, cache cache.Cache, obj client.Object, path string) error
• type ReconcilerBase
  • func NewFromManager(mgr manager.Manager, controllerName string) ReconcilerBase
  • func NewReconcilerBase(client client.Client, scheme *runtime.Scheme, restConfig *rest.Config, ...) ReconcilerBase
  • func (r *ReconcilerBase) CreateOrUpdateResource(context context.Context, owner client.Object, namespace string, ...) error
  • func (r *ReconcilerBase) DeleteResourceIfExists(context context.Context, obj client.Object) error
  • func (r *ReconcilerBase) GetClient() client.Client
  • func (r *ReconcilerBase) GetDiscoveryClient() (*discovery.DiscoveryClient, error)
  • func (r *ReconcilerBase) GetRecorder() record.EventRecorder
  • func (r *ReconcilerBase) GetRestConfig() *rest.Config
  • func (r *ReconcilerBase) GetScheme() *runtime.Scheme
• type ResourceGenerationChangedPredicate
  • func (ResourceGenerationChangedPredicate) Update(e event.UpdateEvent) bool
• type VaultEngineResource
  • func NewVaultEngineResource(reconcilerBase *ReconcilerBase, obj client.Object) *VaultEngineResource
  • func (r *VaultEngineResource) Reconcile(ctx context.Context, instance client.Object) (ctrl.Result, error)
• type VaultPKIEngineResource
  • func NewVaultPKIEngineResource(reconcilerBase *ReconcilerBase, obj client.Object) *VaultPKIEngineResource
  • func (r *VaultPKIEngineResource) Reconcile(ctx context.Context, instance client.Object) (ctrl.Result, error)
• type VaultResource
  • func NewVaultResource(reconcilerBase *ReconcilerBase, obj client.Object) *VaultResource
  • func (r *VaultResource) Reconcile(ctx context.Context, instance client.Object) (ctrl.Result, error)

Constants

const ReconcileFailed = "ReconcileFailed"

const ReconcileFailedReason = "LastReconcileCycleFailed"

const ReconcileSuccessful = "ReconcileSuccessful"

const ReconcileSuccessfulReason = "LastReconcileCycleSucceded"

Functions

func AdvancedTemplateFuncMap

func AdvancedTemplateFuncMap(config *rest.Config, logger logr.Logger) template.FuncMap

AdvancedTemplateFuncMap to add Sprig and additional templating functions

func GetDynamicClientForAPIResource

func GetDynamicClientForAPIResource(context context.Context, resource *metav1.APIResource) (dynamic.NamespaceableResourceInterface, error)

GetDynamicClientOnAPIResource returns a dynamic client on an APIResource. This client can be further namespaced. needs context with log and restConfig

func GetDynamicClientForGVK

func GetDynamicClientForGVK(context context.Context, gvk schema.GroupVersionKind) (dynamic.NamespaceableResourceInterface, bool, error)

GetDynamicClientForGVK returns a dynamic client on an gvk type. Also returns whether this reosurce is namespaced. This client can be further namespaced. needs context with log and restConfig

func GetDynamicClientOnUnstructured

func GetDynamicClientOnUnstructured(context context.Context, obj *unstructured.Unstructured) (dynamic.ResourceInterface, error)

GetDynamicClientOnUnstructured returns a dynamic client on an Unstructured type. This client can be further namespaced. needs context with log and restConfig TODO consider refactoring using apimachinery.RESTClientForGVK in controller-runtime

func IsOwner

func IsOwner(owner, owned metav1.Object) bool

func ManageOutcome

func ManageOutcome(context context.Context, r ReconcilerBase, obj client.Object, issue error) (reconcile.Result, error)

func ManageOutcomeWithRequeue

func ManageOutcomeWithRequeue(context context.Context, r ReconcilerBase, obj client.Object, issue error, requeueAfter time.Duration) (reconcile.Result, error)

func NewLookupFunction

func NewLookupFunction(config *rest.Config, logger logr.Logger) lookupFunc

NewLookupFunction get information at runtime from cluster

func SetIndexField

func SetIndexField(context context.Context, cache cache.Cache, obj client.Object, path string) error

SetIndexField this function allows to prepare an index field for an objct so that fieldSelector can be used. It needs a cache object probably obtained via mrg.GetCache() This is a generic implementation, so it's relatively slow path should be expressed in the form of .<field>.<field> ... needs context with log

Types

type ReconcilerBase

type ReconcilerBase struct {
	Log            logr.Logger
	ControllerName string
	// contains filtered or unexported fields
}

func NewFromManager

func NewFromManager(mgr manager.Manager, controllerName string) ReconcilerBase

NewReconcilerBase is a contruction function to create a new ReconcilerBase.

func NewReconcilerBase

func NewReconcilerBase(client client.Client, scheme *runtime.Scheme, restConfig *rest.Config, recorder record.EventRecorder, apireader client.Reader, log logr.Logger, controllerName string) ReconcilerBase

func (*ReconcilerBase) CreateOrUpdateResource

func (r *ReconcilerBase) CreateOrUpdateResource(context context.Context, owner client.Object, namespace string, obj client.Object) error

CreateOrUpdateResource creates a resource if it doesn't exist, and updates (overwrites it), if it exist if owner is not nil, the owner field os set if namespace is not "", the namespace field of the object is overwritten with the passed value

func (*ReconcilerBase) DeleteResourceIfExists

func (r *ReconcilerBase) DeleteResourceIfExists(context context.Context, obj client.Object) error

DeleteResourceIfExists deletes an existing resource. It doesn't fail if the resource does not exist

func (*ReconcilerBase) GetClient

func (r *ReconcilerBase) GetClient() client.Client

GetClient returns the underlying client

func (*ReconcilerBase) GetDiscoveryClient

func (r *ReconcilerBase) GetDiscoveryClient() (*discovery.DiscoveryClient, error)

GetDiscoveryClient returns a discovery client for the current reconciler

func (*ReconcilerBase) GetRecorder

func (r *ReconcilerBase) GetRecorder() record.EventRecorder

GetRecorder returns the underlying recorder

func (*ReconcilerBase) GetRestConfig

func (r *ReconcilerBase) GetRestConfig() *rest.Config

GetRestConfig returns the undelying rest config

func (*ReconcilerBase) GetScheme

func (r *ReconcilerBase) GetScheme() *runtime.Scheme

GetScheme returns the scheme

type ResourceGenerationChangedPredicate

type ResourceGenerationChangedPredicate struct {
	predicate.Funcs
}

ResourceGenerationChangedPredicate this predicate will fire an update event when the spec of a resource is changed (controller by ResourceGeneration), or when the finalizers are changed

func (ResourceGenerationChangedPredicate) Update

func (ResourceGenerationChangedPredicate) Update(e event.UpdateEvent) bool

Update implements default UpdateEvent filter for validating resource version change

type VaultEngineResource

type VaultEngineResource struct {
	// contains filtered or unexported fields
}

func NewVaultEngineResource

func NewVaultEngineResource(reconcilerBase *ReconcilerBase, obj client.Object) *VaultEngineResource

func (*VaultEngineResource) Reconcile

func (r *VaultEngineResource) Reconcile(ctx context.Context, instance client.Object) (ctrl.Result, error)

type VaultPKIEngineResource

type VaultPKIEngineResource struct {
	// contains filtered or unexported fields
}

func NewVaultPKIEngineResource

func NewVaultPKIEngineResource(reconcilerBase *ReconcilerBase, obj client.Object) *VaultPKIEngineResource

func (*VaultPKIEngineResource) Reconcile

func (r *VaultPKIEngineResource) Reconcile(ctx context.Context, instance client.Object) (ctrl.Result, error)

type VaultResource

type VaultResource struct {
	// contains filtered or unexported fields
}

func NewVaultResource

func NewVaultResource(reconcilerBase *ReconcilerBase, obj client.Object) *VaultResource

func (*VaultResource) Reconcile

func (r *VaultResource) Reconcile(ctx context.Context, instance client.Object) (ctrl.Result, error)