kubebuilder-declarative-pattern is structured in a way that makes it easy for you to turn functionality (provided in kubebuilder-declarative-pattern) on and off in the operator you have created. This also makes it easy to add new functionality to your operator. This README serves as a reference for these functionalities and indicates which ones are enabled by default.
The options are:
WithRawManifestOperation takes in a set of functions that transforms raw string manifests before applying it. The functions should be of the form:
type ManifestOperation = func(context.Context, DeclarativeObject, string) (string, error)
WithObjectTransform takes in a set of functions that transforms the manifest objects before applying it The functions should be of the form:
type ObjectTransform = func(context.Context, DeclarativeObject, *manifest.Objects) error
WithManifestController overrides the default source for loading manifests.
WithApplyPrune turns on the --prune behavior of kubectl apply. This behavior deletes any objects that exist in the API server that are not deployed by the current version of the manifest which match a label specific to the addon instance. This option requires WithLabels to be used.
WithOwner sets an owner ref on each deployed object by the OwnerSelector.
WithLabels sets a fixed set of labels configured provided by a LabelMaker to all deployment objecs for a given DeclarativeObject
WithStatus provides a Status interface that will be used during Reconcile.
WithPreserveNamespace preserves the namespaces defined in the deployment manifest instead of matching the namespace of the DeclarativeObject
WithApplyKustomize runs the kustomize build to create final manifest. This feature needs the go dependency kustomize/api.
If you do not need kustomize or want to use a conflict version of kustomize/api, you can opt out the kustomize and
the kustomize/api dependency via go build tag without_kustomize. e.g. go run ./main.go -tags without_kustomize
WithManagedApplication is a transform that will modify the Application object in the deployment to match the configuration of the rest of the deployment.
WithApplyValidation enables validation with kubectl apply
WithReconcileMetrics enables metrics of declarative reconciler.