kustomize no-op with go build tags

Author: yuwenma

pkg/patterns/declarative/kustomize/disabled.go

@@ -0,0 +1,27 @@
+//go:build without_kustomize
+// +build without_kustomize
+
+package kustomize
+
+import (
+	"context"
+
+	"sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/kustomize/kyaml/filesys"
+)
+
+func init() {
+	Kustomize = &SkipKustomize{}
+}
+
+var _ Kustomizer = &SkipKustomize{}
+
+// NoopKustomize ignore the `kustomization.yaml` file and won't run `kustomize build`.
+type SkipKustomize struct{}
+
+// Run is a no-op
+func (k *SkipKustomize) Run(ctx context.Context, _ filesys.FileSystem, _ string) ([]byte, error) {
+	log := log.FromContext(ctx)
+	log.WithValues("kustomizer", "SkipKustomize").Info("skip running kustomize")
+	return nil, nil
+}

pkg/patterns/declarative/kustomize/enabled.go

@@ -0,0 +1,38 @@
+package kustomize
+
+import (
+	"context"
+	"fmt"
+
+	"sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/kustomize/api/krusty"
+	"sigs.k8s.io/kustomize/kyaml/filesys"
+)
+
+func init() {
+	Kustomize = &EnabledKustomize{}
+}
+
+var _ Kustomizer = &EnabledKustomize{}
+
+// EnabledKustomize runs kustomize build. It requires kustomize/api v0.12.1 and above
+type EnabledKustomize struct{}
+
+// Run calls the kustomize/api library to run `kustomize build`.
+func (k *EnabledKustomize) Run(ctx context.Context, fs filesys.FileSystem, manifestPath string) ([]byte, error) {
+	log := log.FromContext(ctx)
+	log.WithValues("kustomizer", "EnabledKustomize").Info("running kustomize")
+	// run kustomize to create final manifest
+	opts := krusty.MakeDefaultOptions()
+	kustomizer := krusty.MakeKustomizer(opts)
+	m, err := kustomizer.Run(fs, manifestPath)
+	if err != nil {
+		return nil, fmt.Errorf("error running kustomize: %v", err)
+	}
+
+	manifestYaml, err := m.AsYaml()
+	if err != nil {
+		return nil, fmt.Errorf("error converting kustomize output to yaml: %v", err)
+	}
+	return manifestYaml, nil
+}

pkg/patterns/declarative/kustomize/kustomizer.go

@@ -0,0 +1,16 @@
+package kustomize
+
+import (
+	"context"
+
+	"sigs.k8s.io/kustomize/kyaml/filesys"
+)
+
+// Kustomize will be initialized differently according to the go build constraints.
+var Kustomize Kustomizer
+
+// Kustomizer interface defines a `Run` method to differentiate the `kustomize` behavior under
+// different go build constraints
+type Kustomizer interface {
+	Run(context.Context, filesys.FileSystem, string) ([]byte, error)
+}

pkg/patterns/declarative/reconciler.go

@@ -24,6 +24,7 @@ import (
 	"strings"
 
 	"k8s.io/apimachinery/pkg/api/meta"
+	"sigs.k8s.io/kubebuilder-declarative-pattern/pkg/patterns/declarative/kustomize"
 
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 
@@ -39,7 +40,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
-	"sigs.k8s.io/kustomize/api/krusty"
 	"sigs.k8s.io/kustomize/kyaml/filesys"
 
 	"sigs.k8s.io/kubebuilder-declarative-pattern/pkg/patterns/declarative/pkg/applier"
@@ -390,20 +390,12 @@ func (r *Reconciler) BuildDeploymentObjectsWithFs(ctx context.Context, name type
 	// Here, the manifest is built using Kustomize and then replaces the Object items with the created manifest
 	if r.IsKustomizeOptionUsed() {
 		// run kustomize to create final manifest
-		opts := krusty.MakeDefaultOptions()
-		k := krusty.MakeKustomizer(opts)
-		m, err := k.Run(fs, manifestObjects.Path)
+		manifestYaml, err := kustomize.Kustomize.Run(ctx, fs, manifestObjects.Path)
 		if err != nil {
-			log.Error(err, "running kustomize to create final manifest")
+			log.Error(err, "run kustomize build")
 			return nil, fmt.Errorf("error running kustomize: %v", err)
 		}
 
-		manifestYaml, err := m.AsYaml()
-		if err != nil {
-			log.Error(err, "creating final manifest yaml")
-			return nil, fmt.Errorf("error converting kustomize output to yaml: %v", err)
-		}
-
 		objects, err := r.parseManifest(ctx, instance, string(manifestYaml))
 		if err != nil {
 			log.Error(err, "creating final manifest yaml")