Documentation
¶
Index ¶
- func ConfigMapReconcileField(desired, existing *v1.ConfigMap, fieldName string) bool
- func CreateOnlyMutator(existing, desired common.KubernetesObject) (bool, error)
- func DefaultsOnlySecretMutator(existingObj, desiredObj common.KubernetesObject) (bool, error)
- func DeploymentConfigAffinityMutator(desired, existing *appsv1.DeploymentConfig) bool
- func DeploymentConfigContainerResourcesMutator(desired, existing *appsv1.DeploymentConfig) bool
- func DeploymentConfigEnvVarReconciler(desired, existing *appsv1.DeploymentConfig, envVar string) bool
- func DeploymentConfigReplicasMutator(desired, existing *appsv1.DeploymentConfig) bool
- func DeploymentConfigTolerationsMutator(desired, existing *appsv1.DeploymentConfig) bool
- func GenericGrafanaDashboardsMutator(existingObj, desiredObj common.KubernetesObject) (bool, error)
- func GenericImageStreamMutator(existingObj, desiredObj common.KubernetesObject) (bool, error)
- func GenericPDBMutator(existingObj, desiredObj common.KubernetesObject) (bool, error)
- func SecretReconcileField(desired, existing *v1.Secret, fieldName string) bool
- func ServiceAccountImagePullPolicyMutator(existingObj, desiredObj common.KubernetesObject) (bool, error)
- type BaseReconciler
- func (b *BaseReconciler) APIClientReader() client.Reader
- func (b *BaseReconciler) Client() client.Client
- func (b *BaseReconciler) Context() context.Context
- func (b *BaseReconciler) CreateResource(obj common.KubernetesObject) error
- func (b *BaseReconciler) DeleteResource(obj common.KubernetesObject, options ...client.DeleteOption) error
- func (b *BaseReconciler) DiscoveryClient() discovery.DiscoveryInterface
- func (r *BaseReconciler) EnsureOwnerReference(owner, obj common.KubernetesObject) (bool, error)
- func (b *BaseReconciler) EventRecorder() record.EventRecorder
- func (b *BaseReconciler) GetResource(objKey types.NamespacedName, obj common.KubernetesObject) error
- func (b *BaseReconciler) HasConsoleLink() (bool, error)
- func (r *BaseReconciler) HasGrafanaDashboards() (bool, error)
- func (r *BaseReconciler) HasPodMonitors() (bool, error)
- func (r *BaseReconciler) HasPrometheusRules() (bool, error)
- func (r *BaseReconciler) HasServiceMonitors() (bool, error)
- func (b *BaseReconciler) Logger() logr.Logger
- func (b *BaseReconciler) Reconcile(reconcile.Request) (reconcile.Result, error)
- func (b *BaseReconciler) ReconcileResource(obj, desired common.KubernetesObject, mutateFn MutateFn) error
- func (b *BaseReconciler) Scheme() *runtime.Scheme
- func (r *BaseReconciler) SetOwnerReference(owner, obj common.KubernetesObject) error
- func (b *BaseReconciler) UpdateResource(obj common.KubernetesObject) error
- func (b *BaseReconciler) UpdateResourceStatus(obj common.KubernetesObject) error
- type DCMutateFn
- type MutateFn
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ConfigMapReconcileField ¶
func CreateOnlyMutator ¶
func CreateOnlyMutator(existing, desired common.KubernetesObject) (bool, error)
func DefaultsOnlySecretMutator ¶
func DefaultsOnlySecretMutator(existingObj, desiredObj common.KubernetesObject) (bool, error)
DefaultsOnlySecretMutator is useful for secrets pre-created by the user and when not all the fields are created. Fields referenced from deployment configs must exist, so defaults only reconciliation makes sure they exist with default values when user does doe pre-create them
func DeploymentConfigAffinityMutator ¶ added in v0.7.0
func DeploymentConfigAffinityMutator(desired, existing *appsv1.DeploymentConfig) bool
func DeploymentConfigContainerResourcesMutator ¶ added in v0.7.0
func DeploymentConfigContainerResourcesMutator(desired, existing *appsv1.DeploymentConfig) bool
func DeploymentConfigEnvVarReconciler ¶ added in v0.7.0
func DeploymentConfigEnvVarReconciler(desired, existing *appsv1.DeploymentConfig, envVar string) bool
DeploymentConfigEnvVarReconciler implements basic env var reconcilliation for single container deployment configs. Added when in desired and not in existing Updated when in desired and in existing but not equal Removed when not in desired and exists in existing DC
func DeploymentConfigReplicasMutator ¶ added in v0.7.0
func DeploymentConfigReplicasMutator(desired, existing *appsv1.DeploymentConfig) bool
func DeploymentConfigTolerationsMutator ¶ added in v0.7.0
func DeploymentConfigTolerationsMutator(desired, existing *appsv1.DeploymentConfig) bool
func GenericGrafanaDashboardsMutator ¶ added in v0.7.0
func GenericGrafanaDashboardsMutator(existingObj, desiredObj common.KubernetesObject) (bool, error)
func GenericImageStreamMutator ¶
func GenericImageStreamMutator(existingObj, desiredObj common.KubernetesObject) (bool, error)
func GenericPDBMutator ¶
func GenericPDBMutator(existingObj, desiredObj common.KubernetesObject) (bool, error)
func SecretReconcileField ¶
func ServiceAccountImagePullPolicyMutator ¶ added in v0.7.0
func ServiceAccountImagePullPolicyMutator(existingObj, desiredObj common.KubernetesObject) (bool, error)
Types ¶
type BaseReconciler ¶
type BaseReconciler struct {
// contains filtered or unexported fields
}
func NewBaseReconciler ¶
func NewBaseReconciler(client client.Client, scheme *runtime.Scheme, apiClientReader client.Reader, ctx context.Context, logger logr.Logger, discoveryClient discovery.DiscoveryInterface, recorder record.EventRecorder) *BaseReconciler
func (*BaseReconciler) APIClientReader ¶
func (b *BaseReconciler) APIClientReader() client.Reader
APIClientReader return a client that directly reads objects from the Kubernetes APIServer
func (*BaseReconciler) Client ¶
func (b *BaseReconciler) Client() client.Client
Client returns a split client that reads objects from the cache and writes to the Kubernetes APIServer
func (*BaseReconciler) Context ¶
func (b *BaseReconciler) Context() context.Context
func (*BaseReconciler) CreateResource ¶
func (b *BaseReconciler) CreateResource(obj common.KubernetesObject) error
func (*BaseReconciler) DeleteResource ¶
func (b *BaseReconciler) DeleteResource(obj common.KubernetesObject, options ...client.DeleteOption) error
func (*BaseReconciler) DiscoveryClient ¶
func (b *BaseReconciler) DiscoveryClient() discovery.DiscoveryInterface
func (*BaseReconciler) EnsureOwnerReference ¶ added in v0.7.0
func (r *BaseReconciler) EnsureOwnerReference(owner, obj common.KubernetesObject) (bool, error)
EnsureOwnerReference sets owner as a Controller OwnerReference on owned returns boolean to notify when the object has been updated
func (*BaseReconciler) EventRecorder ¶
func (b *BaseReconciler) EventRecorder() record.EventRecorder
func (*BaseReconciler) GetResource ¶
func (b *BaseReconciler) GetResource(objKey types.NamespacedName, obj common.KubernetesObject) error
func (*BaseReconciler) HasConsoleLink ¶ added in v0.7.0
func (b *BaseReconciler) HasConsoleLink() (bool, error)
HasConsoleLink checks if the ConsoleLink is supported in current cluster
func (*BaseReconciler) HasGrafanaDashboards ¶ added in v0.7.0
func (r *BaseReconciler) HasGrafanaDashboards() (bool, error)
HasGrafanaDashboards checks if the GrafanaDashboard CRD is supported in current cluster
func (*BaseReconciler) HasPodMonitors ¶ added in v0.7.0
func (r *BaseReconciler) HasPodMonitors() (bool, error)
HasPodMonitors checks if the PodMonitors CRD is supported in current cluster
func (*BaseReconciler) HasPrometheusRules ¶ added in v0.7.0
func (r *BaseReconciler) HasPrometheusRules() (bool, error)
HasPrometheusRules checks if the PrometheusRules CRD is supported in current cluster
func (*BaseReconciler) HasServiceMonitors ¶ added in v0.7.0
func (r *BaseReconciler) HasServiceMonitors() (bool, error)
HasServiceMonitors checks if the ServiceMonitors CRD is supported in current cluster
func (*BaseReconciler) Logger ¶
func (b *BaseReconciler) Logger() logr.Logger
func (*BaseReconciler) ReconcileResource ¶
func (b *BaseReconciler) ReconcileResource(obj, desired common.KubernetesObject, mutateFn MutateFn) error
ReconcileResource attempts to mutate the existing state in order to match the desired state. The object's desired state must be reconciled with the existing state inside the passed in callback MutateFn.
obj: Object of the same type as the 'desired' object.
Used to read the resource from the kubernetes cluster. Could be zero-valued initialized object.
desired: Object representing the desired state
It returns an error.
func (*BaseReconciler) Scheme ¶
func (b *BaseReconciler) Scheme() *runtime.Scheme
func (*BaseReconciler) SetOwnerReference ¶ added in v0.7.0
func (r *BaseReconciler) SetOwnerReference(owner, obj common.KubernetesObject) error
SetOwnerReference sets owner as a Controller OwnerReference on owned
func (*BaseReconciler) UpdateResource ¶
func (b *BaseReconciler) UpdateResource(obj common.KubernetesObject) error
func (*BaseReconciler) UpdateResourceStatus ¶
func (b *BaseReconciler) UpdateResourceStatus(obj common.KubernetesObject) error
type DCMutateFn ¶ added in v0.7.0
type DCMutateFn func(desired, existing *appsv1.DeploymentConfig) bool
DCMutateFn is a function which mutates the existing DeploymentConfig into it's desired state.
type MutateFn ¶
type MutateFn func(existing, desired common.KubernetesObject) (bool, error)
MutateFn is a function which mutates the existing object into it's desired state.
func DeploymentConfigMutator ¶ added in v0.7.0
func DeploymentConfigMutator(opts ...DCMutateFn) MutateFn
func GenericDeploymentConfigMutator ¶
func GenericDeploymentConfigMutator() MutateFn