[Feature/Operator] Upgrade cert-manager & operator sdk dependencies (#85

)

* upgrade operator sdk to 1.5.0 & cert-manager to 1.2.0

* update documentation

* update documentation

* append changelog

* update golang version for ci

* fix build image

.circleci/config.yml

@@ -31,7 +31,7 @@ orbs:
     executors:
       operator-build:
         docker:
-          - image: orangeopensource/nifikop-build:v0.18.0
+          - image: orangeopensource/nifikop-build:1.15
     # Define jobs list
     jobs:
       # Build job, which build operator docker image (with operator-sdk build)

CHANGELOG.md

@@ -4,15 +4,19 @@
 
 ### Changed
 
+- [PR #85](https://github.com/Orange-OpenSource/nifikop/pull/85) - **[Operator/Dependencies]** Upgrade cert-manager & operator sdk dependencies
+
 ### Deprecated
 
+- [PR #85](https://github.com/Orange-OpenSource/nifikop/pull/85) - **[Operator/Finalizers]** The finalizer name format suggested by [Kubernetes docs](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#finalizers) is <qualified-group>/<finalizer-name>, while the format previously documented by Operator SDK docs was <finalizer-name>.<qualified-group>. If your operator uses any finalizers with names matching the incorrect format, change them to match the official format. For example, finalizer.nifiusergroups.nifi.orange.com should be changed to nifiusergroups.nifi.orange.com/finalizer.
+
 ### Removed
 
 ### Fixed Bugs
 
 ## v0.5.3
 
-### Fixed Bugs**
+### Fixed Bugs
 
 - [PR #82](https://github.com/Orange-OpenSource/nifikop/pull/82) - **[Operator/NifiParameterContext]** Enable empty value
 - [PR #83](https://github.com/Orange-OpenSource/nifikop/pull/83) - **[Operator/NiFiUser]** Rework the certificate secret creation, to prevent issues with JKS password creation.

Makefile

@@ -3,13 +3,17 @@ SERVICE_NAME			:= nifikop
 DOCKER_REGISTRY_BASE 	?= orangeopensource
 IMAGE_TAG				?= $(shell git describe --tags --abbrev=0 --match '[0-9].*[0-9].*[0-9]' 2>/dev/null)
 IMAGE_NAME 				?= $(SERVICE_NAME)
+BUILD_IMAGE				?= orangeopensource/nifikop-build
+GOLANG_VERSION          ?= 1.15
 
 # workdir
 WORKDIR := /go/nifikop
 
 # Debug variables
 TELEPRESENCE_REGISTRY ?= datawire
 
+DEV_DIR := docker/build-image
+
 # Repository url for this project
 # in gitlab CI_REGISTRY_IMAGE=repo/path/name:tag
 ifdef CI_REGISTRY_IMAGE
@@ -235,4 +239,26 @@ debug-telepresence:
 	$(call debug_telepresence)
 
 debug-telepresence-with-alias:
-	$(call debug_telepresence,--also-proxy,10.40.0.0/16)
+	$(call debug_telepresence,--also-proxy,10.40.0.0/16)
+
+# Build the docker development environment
+build-ci-image:
+	docker build --cache-from $(BUILD_IMAGE):latest \
+	  --build-arg GOLANG_VERSION=$(GOLANG_VERSION) \
+		-t $(BUILD_IMAGE):latest \
+		-t $(BUILD_IMAGE):$(GOLANG_VERSION) \
+		-f $(DEV_DIR)/Dockerfile \
+		.
+
+push-ci-image:
+	docker push $(BUILD_IMAGE):$(GOLANG_VERSION)
+ifdef PUSHLATEST
+	docker push $(BUILD_IMAGE):latest
+endif
+
+## Test if the dependencies we need to run this Makefile are installed
+#deps-development:
+#ifndef DOCKER
+#	@echo "Docker is not available. Please install docker"
+#	@exit 1
+#endif

PROJECT

@@ -3,31 +3,79 @@ layout: go.kubebuilder.io/v3
 projectName: nifikop
 repo: github.com/Orange-OpenSource/nifikop
 resources:
-- crdVersion: v1
+- api:
+    crdVersion: v1
+    # TODO(user): Uncomment the below line if this resource's CRD is namespace scoped, else delete it.
+    # namespaced: true
+  # TODO(user): Uncomment the below line if this resource implements a controller, else delete it.
+  # controller: true
+  domain: orange.com
   group: nifi
   kind: NifiCluster
+  # TODO(user): Update the package path for your API if the below value is incorrect.
+  path: github.com/Orange-OpenSource/nifikop/api/v1alpha1
   version: v1alpha1
-- crdVersion: v1
+- api:
+    crdVersion: v1
+    # TODO(user): Uncomment the below line if this resource's CRD is namespace scoped, else delete it.
+    # namespaced: true
+  # TODO(user): Uncomment the below line if this resource implements a controller, else delete it.
+  # controller: true
+  domain: orange.com
   group: nifi
   kind: NifiUserGroup
+  # TODO(user): Update the package path for your API if the below value is incorrect.
+  path: github.com/Orange-OpenSource/nifikop/api/v1alpha1
   version: v1alpha1
-- crdVersion: v1
+- api:
+    crdVersion: v1
+    # TODO(user): Uncomment the below line if this resource's CRD is namespace scoped, else delete it.
+    # namespaced: true
+  # TODO(user): Uncomment the below line if this resource implements a controller, else delete it.
+  # controller: true
+  domain: orange.com
   group: nifi
   kind: NifiUser
+  # TODO(user): Update the package path for your API if the below value is incorrect.
+  path: github.com/Orange-OpenSource/nifikop/api/v1alpha1
   version: v1alpha1
-- crdVersion: v1
+- api:
+    crdVersion: v1
+    # TODO(user): Uncomment the below line if this resource's CRD is namespace scoped, else delete it.
+    # namespaced: true
+  # TODO(user): Uncomment the below line if this resource implements a controller, else delete it.
+  # controller: true
+  domain: orange.com
   group: nifi
   kind: NifiRegistryClient
+  # TODO(user): Update the package path for your API if the below value is incorrect.
+  path: github.com/Orange-OpenSource/nifikop/api/v1alpha1
   version: v1alpha1
-- crdVersion: v1
+- api:
+    crdVersion: v1
+    # TODO(user): Uncomment the below line if this resource's CRD is namespace scoped, else delete it.
+    # namespaced: true
+  # TODO(user): Uncomment the below line if this resource implements a controller, else delete it.
+  # controller: true
+  domain: orange.com
   group: nifi
   kind: NifiDataflow
+  # TODO(user): Update the package path for your API if the below value is incorrect.
+  path: github.com/Orange-OpenSource/nifikop/api/v1alpha1
   version: v1alpha1
-- crdVersion: v1
+- api:
+    crdVersion: v1
+    # TODO(user): Uncomment the below line if this resource's CRD is namespace scoped, else delete it.
+    # namespaced: true
+  # TODO(user): Uncomment the below line if this resource implements a controller, else delete it.
+  # controller: true
+  domain: orange.com
   group: nifi
   kind: NifiParameterContext
+  # TODO(user): Update the package path for your API if the below value is incorrect.
+  path: github.com/Orange-OpenSource/nifikop/api/v1alpha1
   version: v1alpha1
-version: 3-alpha
+version: "3"
 plugins:
   manifests.sdk.operatorframework.io/v2: {}
   scorecard.sdk.operatorframework.io/v2: {}

config/crd/bases/nifi.orange.com_nificlusters.yaml

@@ -1331,10 +1331,13 @@ spec:
                           act as CA : https://cert-manager.io/docs/concepts/issuer/'
                         properties:
                           group:
+                            description: Group of the resource being referred to.
                             type: string
                           kind:
+                            description: Kind of the resource being referred to.
                             type: string
                           name:
+                            description: Name of the resource being referred to.
                             type: string
                         required:
                         - name

config/manager/manager.yaml

@@ -53,3 +53,4 @@ spec:
             cpu: 100m
             memory: 20Mi
       terminationGracePeriodSeconds: 10
+      serviceAccountName: controller-manager

config/rbac/kustomization.yaml

@@ -10,3 +10,4 @@ resources:
 - auth_proxy_role.yaml
 - auth_proxy_role_binding.yaml
 - auth_proxy_client_clusterrole.yaml
+- service_account.yaml

config/rbac/role_binding.yaml

@@ -8,5 +8,5 @@ roleRef:
   name: manager-role
 subjects:
 - kind: ServiceAccount
-  name: default
+  name: controller-manager
   namespace: system

config/rbac/service_account.yaml

@@ -0,0 +1,5 @@
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: controller-manager
+  namespace: system

config/scorecard/patches/basic.config.yaml

@@ -4,7 +4,7 @@
     entrypoint:
     - scorecard-test
     - basic-check-spec
-    image: quay.io/operator-framework/scorecard-test:v1.3.0
+    image: quay.io/operator-framework/scorecard-test:v1.5.0
     labels:
       suite: basic
       test: basic-check-spec-test

config/scorecard/patches/olm.config.yaml

@@ -4,7 +4,7 @@
     entrypoint:
     - scorecard-test
     - olm-bundle-validation
-    image: quay.io/operator-framework/scorecard-test:v1.3.0
+    image: quay.io/operator-framework/scorecard-test:v1.5.0
     labels:
       suite: olm
       test: olm-bundle-validation-test
@@ -14,7 +14,7 @@
     entrypoint:
     - scorecard-test
     - olm-crds-have-validation
-    image: quay.io/operator-framework/scorecard-test:v1.3.0
+    image: quay.io/operator-framework/scorecard-test:v1.5.0
     labels:
       suite: olm
       test: olm-crds-have-validation-test
@@ -24,7 +24,7 @@
     entrypoint:
     - scorecard-test
     - olm-crds-have-resources
-    image: quay.io/operator-framework/scorecard-test:v1.3.0
+    image: quay.io/operator-framework/scorecard-test:v1.5.0
     labels:
       suite: olm
       test: olm-crds-have-resources-test
@@ -34,7 +34,7 @@
     entrypoint:
     - scorecard-test
     - olm-spec-descriptors
-    image: quay.io/operator-framework/scorecard-test:v1.3.0
+    image: quay.io/operator-framework/scorecard-test:v1.5.0
     labels:
       suite: olm
       test: olm-spec-descriptors-test
@@ -44,7 +44,7 @@
     entrypoint:
     - scorecard-test
     - olm-status-descriptors
-    image: quay.io/operator-framework/scorecard-test:v1.3.0
+    image: quay.io/operator-framework/scorecard-test:v1.5.0
     labels:
       suite: olm
       test: olm-status-descriptors-test

controllers/nificluster_controller.go

@@ -40,8 +40,8 @@ import (
 	"github.com/Orange-OpenSource/nifikop/api/v1alpha1"
 )
 
-var clusterFinalizer = "finalizer.nificlusters.nifi.orange.com"
-var clusterUsersFinalizer = "users.nificlusters.nifi.orange.com"
+var clusterFinalizer = "nificlusters.nifi.orange.com/finalizer"
+var clusterUsersFinalizer = "nificlusters.nifi.orange.com/users"
 
 // NifiClusterReconciler reconciles a NifiCluster object
 type NifiClusterReconciler struct {

controllers/nifidataflow_controller.go

@@ -36,7 +36,7 @@ import (
 	"github.com/Orange-OpenSource/nifikop/api/v1alpha1"
 )
 
-var dataflowFinalizer = "finalizer.nifidataflows.nifi.orange.com"
+var dataflowFinalizer = "nifidataflows.nifi.orange.com/finalizer"
 
 // NifiDataflowReconciler reconciles a NifiDataflow object
 type NifiDataflowReconciler struct {

controllers/nifiparametercontext_controller.go

@@ -37,7 +37,7 @@ import (
 	"github.com/Orange-OpenSource/nifikop/api/v1alpha1"
 )
 
-var parameterContextFinalizer = "finalizer.nifiparametercontexts.nifi.orange.com"
+var parameterContextFinalizer = "nifiparametercontexts.nifi.orange.com/finalizer"
 
 // NifiParameterContextReconciler reconciles a NifiParameterContext object
 type NifiParameterContextReconciler struct {

controllers/nifiregistryclient_controller.go

@@ -34,7 +34,7 @@ import (
 	"github.com/Orange-OpenSource/nifikop/api/v1alpha1"
 )
 
-var registryClientFinalizer = "finalizer.nifiregistryclients.nifi.orange.com"
+var registryClientFinalizer = "nifiregistryclients.nifi.orange.com/finalizer"
 
 // NifiRegistryClientReconciler reconciles a NifiRegistryClient object
 type NifiRegistryClientReconciler struct {

controllers/nifiuser_controller.go

@@ -38,7 +38,7 @@ import (
 	"github.com/Orange-OpenSource/nifikop/api/v1alpha1"
 )
 
-var userFinalizer = "finalizer.nifiusers.nifi.orange.com"
+var userFinalizer = "nifiusers.nifi.orange.com/finalizer"
 
 // NifiUserReconciler reconciles a NifiUser object
 type NifiUserReconciler struct {

controllers/nifiusergroup_controller.go

@@ -35,7 +35,7 @@ import (
 	"github.com/Orange-OpenSource/nifikop/api/v1alpha1"
 )
 
-var userGroupFinalizer = "finalizer.nifiusergroups.nifi.orange.com"
+var userGroupFinalizer = "nifiusergroups.nifi.orange.com/finalizer"
 
 // NifiUserGroupReconciler reconciles a NifiUserGroup object
 type NifiUserGroupReconciler struct {