Skip to content

Commit a32093e

Browse files
authored
Merge pull request #301 from yuwenma/kustomize-doc
Add doc for without-kustomize tag
2 parents c58a777 + adac0c2 commit a32093e

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

reconciler-options.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,22 @@ WithApplyPrune turns on the --prune behavior of kubectl apply. This behavior del
2525
This option requires (WithLabels)[#withLabels] to be used.
2626

2727
## WithOwner
28-
WithOwner sets an owner ref on each deployed object by the (OwnerSelector)[https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern/blob/master/pkg/patterns/declarative/options.go#L74].
28+
WithOwner sets an owner ref on each deployed object by the [OwnerSelector].
2929

3030
## WithLabels
3131
WithLabels sets a fixed set of labels configured provided by a LabelMaker to all deployment objecs for a given DeclarativeObject
3232

3333
## WithStatus
34-
WithStatus provides a (Status)[https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern/blob/master/pkg/patterns/declarative/status.go#L26] interface that will be used during Reconcile.
34+
WithStatus provides a [Status] interface that will be used during Reconcile.
3535

3636
## WithPreserveNamespace
3737
WithPreserveNamespace preserves the namespaces defined in the deployment manifest
3838
instead of matching the namespace of the DeclarativeObject
3939

4040
## WithApplyKustomize
41-
WithApplyKustomize run kustomize build to create final manifest
41+
WithApplyKustomize runs the kustomize build to create final manifest. This feature needs the go dependency `kustomize/api`.
42+
If you do not need kustomize or want to use a conflict version of `kustomize/api`, you can opt out the kustomize and
43+
the `kustomize/api` dependency via go build tag `without-kustomize`. e.g. `go run ./main.go -tags without-kustomize`
4244

4345
## WithManagedApplication
4446
WithManagedApplication is a transform that will modify the Application object in the deployment to match the configuration of the rest of the deployment.
@@ -48,3 +50,7 @@ WithApplyValidation enables validation with kubectl apply
4850

4951
## WithReconcileMetrics
5052
WithReconcileMetrics enables metrics of declarative reconciler.
53+
54+
55+
[OwnerSelector]: https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern/blob/master/pkg/patterns/declarative/options.go#L74
56+
[Status]: https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern/blob/master/pkg/patterns/declarative/status.go#L26

0 commit comments

Comments
 (0)