# README
ResourceReconciler
ResourceReconciler
reconciles a single Kubernetes object against the API Server.
It creates the object if it doesn't exist or removes it in case its desired state is absent.
It uses the ObjectMatcher library to be able to tell if an already existing object needs to be updated or not.
It depends on logr logger and the controller-runtime client that is available in a typical kubebuilder or operator-sdk project.
Example:
package main
import (
corev1 "k8s.io/api/core/v1"
github.com/go-logr/logr
"github.com/cisco-open/operator-tools/pkg/reconciler"
runtimeClient "sigs.k8s.io/controller-runtime/pkg/client"
)
func example(client runtimeClient.Client, logger logr.Logger) {
resourceReconciler := reconciler.NewReconcilerWith(client, reconciler.WithLog(logger))
serviceObject := &corev1.Service{
Spec: corev1.ServiceSpec{
...
},
}
result, err := resourceReconciler.ReconcileResource(serviceObject, reconciler.StatePresent)
}
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewGenericReconciler returns GenericResourceReconciler Deprecated, use NewReconcilerWith.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Set patch maker calculate options.
Set patch maker implementation.
Use this option for the legacy behaviour.
Use this option for the legacy behaviour.
Matches no GVK.
Recreate only if the error message contains the given substring.
Disable checking the error message before recreating resources.
Recreate only if the error message contains the given substring.
Recreate workloads immediately without waiting for dependents to get GCd.
Apply the given amount of delay before recreating a resource after it has been removed.
No description provided by the author
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
# Structs
Collects results and errors of all subcomponents instead of failing and bailing out immediately.
No description provided by the author
No description provided by the author
Dispatcher orchestrates reconciliation of multiple ComponentReconciler objects focusing on handing off reconciled object to all of its components and calculating an aggregated result to return.
No description provided by the author
GenericResourceReconciler generic resource reconciler.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Recommended to use NewReconcilerWith + ResourceReconcilerOptions.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Interfaces
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
ComponentReconcilers is a list of component reconcilers that support getting components in Install and Uninstall order.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author