align with kb to use common plugin instead of duplicate the code

changelog/fragments/add_common_kb.yaml

@@ -0,0 +1,46 @@
+# entries is a list of entries to include in
+# release notes and/or the migration guide
+entries:
+  - description: >
+      (ansible/v1,helm/v1) Add componentConfig option. For further information check [here](https://master.book.kubebuilder.io/component-config-tutorial/tutorial.html)
+    kind: "addition"
+    breaking: false
+    migration:
+      header: (ansible/v1,helm/v1) Add componentConfig option.
+      body: >
+        To add this option your project you will need to:
+        - Create the file [/config/default/manager_config_patch.yaml](https://github.com/operator-framework/operator-sdk/blob/v1.6.0/testdata/ansible/memcached-operator/config/default/manager_config_patch.yaml).
+        - Create the file [/config/default/manager_config_patch.yaml](https://github.com/operator-framework/operator-sdk/blob/v1.6.0/testdata/ansible/memcached-operator/config/manager/controller_manager_config.yaml) .
+        - Update the `config/default/kustomization.yaml` by adding:
+          ```yaml
+          # Mount the controller config file for loading manager configurations
+          # through a ComponentConfig type
+          #- manager_config_patch.yaml
+          ```
+        - Update the `config/manager/kustomization.yaml` by adding:
+          ```yaml
+          generatorOptions:
+            disableNameSuffixHash: true
+
+          configMapGenerator:
+          - files:
+            - controller_manager_config.yaml
+            name: manager-config
+          apiVersion: kustomize.config.k8s.io/v1beta1
+          kind: Kustomization
+          images:
+          - name: controller
+            newName: quay.io/example/memcached-operator
+            newTag: v0.0.1
+          ```
+        - Add the rule for the `apiGroups` `coordination.k8s.io` and the resource `leases` in config/rbac/leader_election_role.yaml:
+          ```yaml
+          rules:
+          - apiGroups:
+            - ""
+            - coordination.k8s.io
+            resources:
+            - configmaps
+            - leases
+          ```
+

go.mod

@@ -48,6 +48,7 @@ replace (
 	github.com/containerd/containerd => github.com/containerd/containerd v1.4.3
 	github.com/mattn/go-sqlite3 => github.com/mattn/go-sqlite3 v1.10.0
 	golang.org/x/text => golang.org/x/text v0.3.3 // Required to fix CVE-2020-14040
+	sigs.k8s.io/kubebuilder/v3 => github.com/camilamacedo86/kubebuilder/v3 v3.0.0-20210401164150-9e816f59e280
 )
 
 exclude github.com/spf13/viper v1.3.2 // Required to fix CVE-2018-1098

go.sum

@@ -161,6 +161,10 @@ github.com/bugsnag/osext v0.0.0-20130617224835-0dd3f918b21b/go.mod h1:obH5gd0Bsq
 github.com/bugsnag/panicwrap v0.0.0-20151223152923-e2c28503fcd0/go.mod h1:D/8v3kj0zr8ZAKg1AQ6crr+5VwKN5eIywRkfhyM/+dE=
 github.com/bugsnag/panicwrap v1.2.0 h1:OzrKrRvXis8qEvOkfcxNcYbOd2O7xXS2nnKMEMABFQA=
 github.com/bugsnag/panicwrap v1.2.0/go.mod h1:D/8v3kj0zr8ZAKg1AQ6crr+5VwKN5eIywRkfhyM/+dE=
+github.com/camilamacedo86/kubebuilder/v3 v3.0.0-20210325181645-7ebc46bb648d h1:vYixz9WHw09qP7b3ow1UMfqj2G5Qfx04pPnCfnSAlCU=
+github.com/camilamacedo86/kubebuilder/v3 v3.0.0-20210325181645-7ebc46bb648d/go.mod h1:eVtLdWzmvL1ixDYLlVrvQe8wjpikJVoSOg5PghTk2Lw=
+github.com/camilamacedo86/kubebuilder/v3 v3.0.0-20210401164150-9e816f59e280 h1:FiRMNNzN2WN9Idfntmp9L62P3cNSr6iB+S4DPYnSMb4=
+github.com/camilamacedo86/kubebuilder/v3 v3.0.0-20210401164150-9e816f59e280/go.mod h1:eVtLdWzmvL1ixDYLlVrvQe8wjpikJVoSOg5PghTk2Lw=
 github.com/casbin/casbin/v2 v2.1.2/go.mod h1:YcPU1XXisHhLzuxH9coDNf2FbKpjGlbCg3n9yuLkIJQ=
 github.com/cenkalti/backoff v2.2.1+incompatible/go.mod h1:90ReRw6GdpyfrHakVjL/QHaoyV4aDUVVkXQJJJ3NXXM=
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
@@ -1557,8 +1561,7 @@ sigs.k8s.io/controller-tools v0.4.1 h1:VkuV0MxlRPmRu5iTgBZU4UxUX2LiR99n3sdQGRxZF
 sigs.k8s.io/controller-tools v0.4.1/go.mod h1:G9rHdZMVlBDocIxGkK3jHLWqcTMNvveypYJwrvYKjWU=
 sigs.k8s.io/controller-tools v0.5.0 h1:3u2RCwOlp0cjCALAigpOcbAf50pE+kHSdueUosrC/AE=
 sigs.k8s.io/controller-tools v0.5.0/go.mod h1:JTsstrMpxs+9BUj6eGuAaEb6SDSPTeVtUyp0jmnAM/I=
-sigs.k8s.io/kubebuilder/v3 v3.0.0-beta.1 h1:WGYvUPZ5tVrAOgvGW/NEqOXV2uYtplB6hJ/SFndrvIc=
-sigs.k8s.io/kubebuilder/v3 v3.0.0-beta.1/go.mod h1:eVtLdWzmvL1ixDYLlVrvQe8wjpikJVoSOg5PghTk2Lw=
+sigs.k8s.io/kubebuilder v1.0.8 h1:XYctSbuOICM9z1Ok0GIWChc1cj90EEEczeJQnb7ZPf0=
 sigs.k8s.io/kustomize v2.0.3+incompatible h1:JUufWFNlI44MdtnjUqVnvh29rR37PQFzPbLXqhyOyX0=
 sigs.k8s.io/kustomize v2.0.3+incompatible/go.mod h1:MkjgH3RdOWrievjo6c9T245dYlB5QeXV4WCbnt/PEpU=
 sigs.k8s.io/kustomize/kyaml v0.10.10 h1:caAxDDkaXZp+0kDsZVik4leFJV8LCy09PdVqpaoNeF4=

hack/generate/samples/internal/ansible/advanced_molecule.go

@@ -25,6 +25,7 @@ import (
 
 	"github.com/operator-framework/operator-sdk/hack/generate/samples/internal/pkg"
 	"github.com/operator-framework/operator-sdk/internal/testutils"
+	"github.com/operator-framework/operator-sdk/internal/util"
 )
 
 // AdvancedMolecule defines the context for the sample
@@ -89,21 +90,21 @@ func (ma *AdvancedMolecule) Run() {
         data:
           sentinel: '{{ sentinel }}'
           groups: '{{ groups | to_nice_yaml }}'`
-	err = testutils.ReplaceInFile(
+	err = util.ReplaceInFile(
 		inventoryRoleTask,
 		"# tasks file for InventoryTest",
 		inventoryRoleTaskFragment)
 	pkg.CheckError("replacing inventory task", err)
 
 	log.Infof("updating inventorytest sample")
-	err = testutils.ReplaceInFile(
+	err = util.ReplaceInFile(
 		filepath.Join(ma.ctx.Dir, "config", "samples", "test_v1alpha1_inventorytest.yaml"),
 		"name: inventorytest-sample",
 		inventorysampleFragment)
 	pkg.CheckError("updating inventorytest sample", err)
 
 	log.Infof("updating spec of inventorytest sample")
-	err = testutils.ReplaceInFile(
+	err = util.ReplaceInFile(
 		filepath.Join(ma.ctx.Dir, "config", "samples", "test_v1alpha1_inventorytest.yaml"),
 		"foo: bar",
 		"size: 3")
@@ -146,27 +147,27 @@ func (ma *AdvancedMolecule) updateConfig() {
       - update
       - watch
 #+kubebuilder:scaffold:rules`
-	err := testutils.ReplaceInFile(
+	err := util.ReplaceInFile(
 		filepath.Join(ma.ctx.Dir, "config", "rbac", "role.yaml"),
 		"#+kubebuilder:scaffold:rules",
 		cmRolesFragment)
 	pkg.CheckError("adding customized roles", err)
 
 	log.Infof("adding manager arg")
 	const ansibleVaultArg = `
-            - "--ansible-args='--vault-password-file /opt/ansible/pwd.yml'"`
+        - --ansible-args='--vault-password-file /opt/ansible/pwd.yml'`
 	err = kbtestutils.InsertCode(
 		filepath.Join(ma.ctx.Dir, "config", "manager", "manager.yaml"),
-		"- \"--leader-election-id=advanced-molecule-operator\"",
+		"- --leader-election-id=advanced-molecule-operator",
 		ansibleVaultArg)
 	pkg.CheckError("adding manager arg", err)
 
 	log.Infof("adding manager env")
 	const managerEnv = `
-            - name: ANSIBLE_DEBUG_LOGS
-              value: "TRUE"
-            - name: ANSIBLE_INVENTORY
-              value: /opt/ansible/inventory`
+          - name: ANSIBLE_DEBUG_LOGS
+            value: "TRUE"
+          - name: ANSIBLE_INVENTORY
+            value: /opt/ansible/inventory`
 	err = kbtestutils.InsertCode(
 		filepath.Join(ma.ctx.Dir, "config", "manager", "manager.yaml"),
 		"value: explicit",
@@ -183,7 +184,7 @@ func (ma *AdvancedMolecule) updateConfig() {
 	pkg.CheckError("adding vaulting args to the proxy auth", err)
 
 	log.Infof("adding task to not pull image to the config/testing")
-	err = testutils.ReplaceInFile(
+	err = util.ReplaceInFile(
 		filepath.Join(ma.ctx.Dir, "config", "testing", "kustomization.yaml"),
 		"- manager_image.yaml",
 		"- manager_image.yaml\n- pull_policy/Never.yaml")
@@ -229,7 +230,7 @@ func (ma *AdvancedMolecule) addMocksFromTestdata() {
 
 func (ma *AdvancedMolecule) updateDockerfile() {
 	log.Infof("replacing project Dockerfile to use ansible base image with the dev tag")
-	err := testutils.ReplaceRegexInFile(
+	err := util.ReplaceRegexInFile(
 		filepath.Join(ma.ctx.Dir, "Dockerfile"),
 		"quay.io/operator-framework/ansible-operator:.*",
 		"quay.io/operator-framework/ansible-operator:dev")
@@ -281,7 +282,7 @@ func (ma *AdvancedMolecule) updatePlaybooks() {
           data:
             msg: The decrypted value is {{the_secret.the_secret}}
 `
-	err := testutils.ReplaceInFile(
+	err := util.ReplaceInFile(
 		filepath.Join(ma.ctx.Dir, "playbooks", "argstest.yml"),
 		originalPlaybookFragment,
 		argsPlaybook)
@@ -305,7 +306,7 @@ func (ma *AdvancedMolecule) updatePlaybooks() {
           data:
             shouldBeCamel: '{{ camelCaseVar | default("false") }}'
 `
-	err = testutils.ReplaceInFile(
+	err = util.ReplaceInFile(
 		filepath.Join(ma.ctx.Dir, "playbooks", "casetest.yml"),
 		originalPlaybookFragment,
 		casePlaybook)
@@ -324,7 +325,7 @@ func (ma *AdvancedMolecule) updatePlaybooks() {
   tasks:
     - command: echo hello
     - debug: msg='{{ "hello" | test }}'`
-	err = testutils.ReplaceInFile(
+	err = util.ReplaceInFile(
 		filepath.Join(ma.ctx.Dir, "playbooks", "inventorytest.yml"),
 		"---\n- hosts: localhost\n  gather_facts: no\n  collections:\n    - community.kubernetes\n    - operator_sdk.util\n  tasks:\n    - import_role:\n        name: \"inventorytest\"",
 		inventoryPlaybook)
@@ -382,7 +383,7 @@ func (ma *AdvancedMolecule) updatePlaybooks() {
         time: 1s
       when: configmap.resources|length > 0 and (configmap.resources.0.data.iterations|int) < 5
 `
-	err = testutils.ReplaceInFile(
+	err = util.ReplaceInFile(
 		filepath.Join(ma.ctx.Dir, "playbooks", "reconciliationtest.yml"),
 		originalPlaybookFragment,
 		reconciliationPlaybook)
@@ -406,7 +407,7 @@ func (ma *AdvancedMolecule) updatePlaybooks() {
           data:
             hello: "world"
 `
-	err = testutils.ReplaceInFile(
+	err = util.ReplaceInFile(
 		filepath.Join(ma.ctx.Dir, "playbooks", "selectortest.yml"),
 		originalPlaybookFragment,
 		selectorPlaybook)
@@ -465,7 +466,7 @@ func (ma *AdvancedMolecule) updatePlaybooks() {
           execCommandStderr: '{{ exec_result.stderr.strip() }}'
           logs: '{{ log_result.log }}'
 `
-	err = testutils.ReplaceInFile(
+	err = util.ReplaceInFile(
 		filepath.Join(ma.ctx.Dir, "playbooks", "subresourcestest.yml"),
 		originalPlaybookFragment,
 		subresourcesPlaybook)
@@ -497,7 +498,7 @@ func (ma *AdvancedMolecule) addPlaybooks() {
 		task := fmt.Sprintf("%s_test.yml", k)
 		logMsgForKind = fmt.Sprintf("removing FIXME assert from %s", task)
 		log.Infof(logMsgForKind)
-		err = testutils.ReplaceInFile(
+		err = util.ReplaceInFile(
 			filepath.Join(ma.ctx.Dir, "molecule", "default", "tasks", task),
 			fixmeAssert,
 			"")

hack/generate/samples/internal/ansible/memcached.go

@@ -24,6 +24,7 @@ import (
 
 	"github.com/operator-framework/operator-sdk/hack/generate/samples/internal/pkg"
 	"github.com/operator-framework/operator-sdk/internal/testutils"
+	"github.com/operator-framework/operator-sdk/internal/util"
 )
 
 // MemcachedAnsible defines the context for the sample
@@ -91,7 +92,7 @@ func (ma *MemcachedAnsible) addingMoleculeMockData() {
 	moleculeTaskPath := filepath.Join(ma.ctx.Dir, "molecule", "default", "tasks",
 		fmt.Sprintf("%s_test.yml", strings.ToLower(ma.ctx.Kind)))
 
-	err := testutils.ReplaceInFile(moleculeTaskPath,
+	err := util.ReplaceInFile(moleculeTaskPath,
 		originaMemcachedMoleculeTask, fmt.Sprintf(moleculeTaskFragment, ma.ctx.ProjectName, ma.ctx.ProjectName))
 	pkg.CheckError("replacing molecule default tasks", err)
 }
@@ -105,13 +106,13 @@ func (ma *MemcachedAnsible) addingAnsibleTask() {
 		roleFragment)
 	pkg.CheckError("adding task", err)
 
-	err = testutils.ReplaceInFile(filepath.Join(ma.ctx.Dir, "roles", strings.ToLower(ma.ctx.Kind),
+	err = util.ReplaceInFile(filepath.Join(ma.ctx.Dir, "roles", strings.ToLower(ma.ctx.Kind),
 		"defaults", "main.yml"),
 		fmt.Sprintf("# defaults file for %s", ma.ctx.Kind),
 		defaultsFragment)
 	pkg.CheckError("adding defaulting", err)
 
-	err = testutils.ReplaceInFile(filepath.Join(ma.ctx.Dir, "config", "samples",
+	err = util.ReplaceInFile(filepath.Join(ma.ctx.Dir, "config", "samples",
 		fmt.Sprintf("%s_%s_%s.yaml", ma.ctx.Group, ma.ctx.Version, strings.ToLower(ma.ctx.Kind))),
 		"foo: bar", "size: 1")
 	pkg.CheckError("updating sample CR", err)

hack/generate/samples/internal/ansible/memcached_molecule.go

@@ -20,11 +20,12 @@ import (
 	"path/filepath"
 	"strings"
 
+	log "github.com/sirupsen/logrus"
 	kbtestutils "sigs.k8s.io/kubebuilder/v3/test/e2e/utils"
 
 	"github.com/operator-framework/operator-sdk/hack/generate/samples/internal/pkg"
 	"github.com/operator-framework/operator-sdk/internal/testutils"
-	log "github.com/sirupsen/logrus"
+	"github.com/operator-framework/operator-sdk/internal/util"
 )
 
 // MoleculeAnsible defines the context for the sample
@@ -76,11 +77,11 @@ func (ma *MoleculeAnsible) Run() {
 	pkg.CheckError("replacing memcached task to add foo check", err)
 
 	log.Infof("replacing project Dockerfile to use ansible base image with the dev tag")
-	err = testutils.ReplaceRegexInFile(filepath.Join(ma.ctx.Dir, "Dockerfile"), "quay.io/operator-framework/ansible-operator:.*", "quay.io/operator-framework/ansible-operator:dev")
+	err = util.ReplaceRegexInFile(filepath.Join(ma.ctx.Dir, "Dockerfile"), "quay.io/operator-framework/ansible-operator:.*", "quay.io/operator-framework/ansible-operator:dev")
 	pkg.CheckError("replacing Dockerfile", err)
 
 	log.Infof("adding RBAC permissions")
-	err = testutils.ReplaceInFile(filepath.Join(ma.ctx.Dir, "config", "rbac", "role.yaml"),
+	err = util.ReplaceInFile(filepath.Join(ma.ctx.Dir, "config", "rbac", "role.yaml"),
 		"#+kubebuilder:scaffold:rules", rolesForBaseOperator)
 	pkg.CheckError("replacing in role.yml", err)
 
@@ -106,12 +107,12 @@ func (ma *MoleculeAnsible) Run() {
 	pkg.CheckError("creating api", err)
 
 	log.Infof("adding task to delete config map")
-	err = testutils.ReplaceInFile(filepath.Join(ma.ctx.Dir, "roles", "memfin", "tasks", "main.yml"),
+	err = util.ReplaceInFile(filepath.Join(ma.ctx.Dir, "roles", "memfin", "tasks", "main.yml"),
 		"# tasks file for Memfin", taskToDeleteConfigMap)
 	pkg.CheckError("replacing in tasks/main.yml", err)
 
 	log.Infof("adding to watches finalizer and blacklist")
-	err = testutils.ReplaceInFile(filepath.Join(ma.ctx.Dir, "watches.yaml"),
+	err = util.ReplaceInFile(filepath.Join(ma.ctx.Dir, "watches.yaml"),
 		"playbook: playbooks/memcached.yml", memcachedWatchCustomizations)
 	pkg.CheckError("replacing in watches", err)
 
@@ -133,7 +134,7 @@ func (ma *MoleculeAnsible) Run() {
 	pkg.CheckError("creating api", err)
 
 	log.Infof("removing ignore group for the secret from watches as an workaround to work with core types")
-	err = testutils.ReplaceInFile(filepath.Join(ma.ctx.Dir, "watches.yaml"),
+	err = util.ReplaceInFile(filepath.Join(ma.ctx.Dir, "watches.yaml"),
 		"ignore.example.com", "\"\"")
 	pkg.CheckError("replacing the watches file", err)
 
@@ -143,22 +144,22 @@ func (ma *MoleculeAnsible) Run() {
 	pkg.CheckError("removing secret test file", err)
 
 	log.Infof("adding Secret task to the role")
-	err = testutils.ReplaceInFile(filepath.Join(ma.ctx.Dir, "roles", "secret", "tasks", "main.yml"),
+	err = util.ReplaceInFile(filepath.Join(ma.ctx.Dir, "roles", "secret", "tasks", "main.yml"),
 		originalTaskSecret, taskForSecret)
 	pkg.CheckError("replacing in secret/tasks/main.yml file", err)
 
 	log.Infof("adding ManageStatus == false for role secret")
-	err = testutils.ReplaceInFile(filepath.Join(ma.ctx.Dir, "watches.yaml"),
+	err = util.ReplaceInFile(filepath.Join(ma.ctx.Dir, "watches.yaml"),
 		"role: secret", manageStatusFalseForRoleSecret)
 	pkg.CheckError("replacing in watches.yaml", err)
 
 	log.Infof("removing FIXME asserts from memfin_test.yml")
-	err = testutils.ReplaceInFile(filepath.Join(ma.ctx.Dir, "molecule", "default", "tasks", "memfin_test.yml"),
+	err = util.ReplaceInFile(filepath.Join(ma.ctx.Dir, "molecule", "default", "tasks", "memfin_test.yml"),
 		fixmeAssert, "")
 	pkg.CheckError("replacing memfin_test.yml", err)
 
 	log.Infof("removing FIXME asserts from foo_test.yml")
-	err = testutils.ReplaceInFile(filepath.Join(ma.ctx.Dir, "molecule", "default", "tasks", "foo_test.yml"),
+	err = util.ReplaceInFile(filepath.Join(ma.ctx.Dir, "molecule", "default", "tasks", "foo_test.yml"),
 		fixmeAssert, "")
 	pkg.CheckError("replacing foo_test.yml", err)
 }

hack/generate/samples/internal/go/v2/memcached_with_webhooks.go

@@ -25,6 +25,7 @@ import (
 
 	"github.com/operator-framework/operator-sdk/hack/generate/samples/internal/pkg"
 	"github.com/operator-framework/operator-sdk/internal/testutils"
+	"github.com/operator-framework/operator-sdk/internal/util"
 )
 
 // MemcachedGoWithWebhooks defines the Memcached Sample in GO using webhooks
@@ -195,7 +196,7 @@ func (mh *MemcachedGoWithWebhooks) implementingWebhooks() {
 		webhooksFragment)
 	pkg.CheckError("replacing reconcile", err)
 
-	err = testutils.ReplaceInFile(webhookPath,
+	err = util.ReplaceInFile(webhookPath,
 		"// TODO(user): fill in your defaulting logic.", "if r.Spec.Size == 0 {\n\t\tr.Spec.Size = 3\n\t}")
 	pkg.CheckError("replacing default webhook implementation", err)
 
@@ -224,16 +225,16 @@ func (mh *MemcachedGoWithWebhooks) implementingController() {
 	pkg.CheckError("adding rbac", err)
 
 	// Replace reconcile content
-	err = testutils.ReplaceInFile(controllerPath, "_ = context.Background()", "ctx := context.Background()")
+	err = util.ReplaceInFile(controllerPath, "_ = context.Background()", "ctx := context.Background()")
 	pkg.CheckError("replacing reconcile content", err)
 
-	err = testutils.ReplaceInFile(controllerPath,
+	err = util.ReplaceInFile(controllerPath,
 		fmt.Sprintf("_ = r.Log.WithValues(\"%s\", req.NamespacedName)", strings.ToLower(mh.ctx.Kind)),
 		fmt.Sprintf("log := r.Log.WithValues(\"%s\", req.NamespacedName)", strings.ToLower(mh.ctx.Kind)))
 	pkg.CheckError("replacing reconcile content", err)
 
 	// Add reconcile implementation
-	err = testutils.ReplaceInFile(controllerPath,
+	err = util.ReplaceInFile(controllerPath,
 		"// your logic here", reconcileFragment)
 	pkg.CheckError("replacing reconcile", err)
 
@@ -243,7 +244,7 @@ func (mh *MemcachedGoWithWebhooks) implementingController() {
 	pkg.CheckError("adding helpers methods in the controller", err)
 
 	// Add watch for the Kind
-	err = testutils.ReplaceInFile(controllerPath,
+	err = util.ReplaceInFile(controllerPath,
 		fmt.Sprintf(watchOriginalFragment, mh.ctx.Group, mh.ctx.Version, mh.ctx.Kind),
 		fmt.Sprintf(watchCustomizedFragment, mh.ctx.Group, mh.ctx.Version, mh.ctx.Kind))
 	pkg.CheckError("replacing reconcile", err)
@@ -280,7 +281,7 @@ func (mh *MemcachedGoWithWebhooks) implementingAPI() {
 		fmt.Sprintf("%s_%s_%s.yaml", mh.ctx.Group, mh.ctx.Version, strings.ToLower(mh.ctx.Kind)))
 
 	log.Infof("updating sample to have size attribute")
-	err = testutils.ReplaceInFile(filepath.Join(mh.ctx.Dir, sampleFile), "foo: bar", "size: 1")
+	err = util.ReplaceInFile(filepath.Join(mh.ctx.Dir, sampleFile), "foo: bar", "size: 1")
 	pkg.CheckError("updating sample", err)
 }