operator-sdk upgrade to 1.4.2

Upgrade the operator-framework version we use for the NFD-Operator,
currently uses a very old and deprecated one. this patchs bumps it to
1.4.2 version, adding kustomize as the way to handle the manifests as
  part of the new features of the framwork

Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>

Author: ArangoGutierrez

.dockerignore

@@ -0,0 +1,5 @@
+# More info: https://docs.docker.com/engine/reference/builder/#dockerignore-file
+# Ignore all files which are not go type
+!**/*.go
+!**/*.mod
+!**/*.sum

.gitignore

@@ -0,0 +1,25 @@
+
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+bin
+testbin/*
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Kubernetes Generated files - skip generated files, except for vendored files
+
+!vendor/**/zz_generated.*
+
+# editor and IDE paraphernalia
+.idea
+*.swp
+*.swo
+*~

Dockerfile

@@ -1,23 +1,27 @@
-# Build the operator
-FROM golang:1.15.4 AS builder
-WORKDIR /go/src/github.com/kubernetes-sigs/node-feature-discovery-operator
+# Build the manager binary
+FROM golang:1.15.4 as builder
 
-# Fetch/cache dependencies
+WORKDIR /workspace
+# Copy the Go Modules manifests
 COPY go.mod go.sum ./
+
+# cache deps before building and copying source so that we don't need to re-download as much
+# and so that source changes don't invalidate our downloaded layer
 RUN go mod download
 
-# do the actual build
+# Build
 COPY . .
 RUN make build
 
 # Create production image for running the operator
 FROM registry.access.redhat.com/ubi8/ubi
-COPY --from=builder /go/src/github.com/kubernetes-sigs/node-feature-discovery-operator/node-feature-discovery-operator /usr/bin/
+COPY --from=builder /workspace/node-feature-discovery-operator /
 
 RUN mkdir -p /opt/nfd
-COPY assets /opt/nfd
+COPY build/assets /opt/nfd
+
+RUN useradd nfd-operator
+USER nfd-operator
 
-RUN useradd node-feature-discovery-operator
-USER node-feature-discovery-operator
-ENTRYPOINT ["/usr/bin/node-feature-discovery-operator"]
+ENTRYPOINT ["/node-feature-discovery-operator"]
 LABEL io.k8s.display-name="node-feature-discovery-operator"

Makefile

@@ -20,8 +20,40 @@ SITE_BASEURL ?=
 SITE_DESTDIR ?= _site
 JEKYLL_OPTS := -d '$(SITE_DESTDIR)' $(if $(SITE_BASEURL),-b '$(SITE_BASEURL)',)
 
+# VERSION defines the project version for the bundle. 
+# Update this value when you upgrade the version of your project.
+# To re-generate a bundle for another specific version without changing the standard setup, you can:
+# - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.2.1)
+# - use environment variables to overwrite this value (e.g export VERSION=0.2.1)
 VERSION := $(shell git describe --tags --dirty --always)
 
+# CHANNELS define the bundle channels used in the bundle. 
+# Add a new line here if you would like to change its default config. (E.g CHANNELS = "preview,fast,stable")
+# To re-generate a bundle for other specific channels without changing the standard setup, you can:
+# - use the CHANNELS as arg of the bundle target (e.g make bundle CHANNELS=preview,fast,stable)
+# - use environment variables to overwrite this value (e.g export CHANNELS="preview,fast,stable")
+ifneq ($(origin CHANNELS), undefined)
+BUNDLE_CHANNELS := --channels=$(CHANNELS)
+endif
+
+# DEFAULT_CHANNEL defines the default channel used in the bundle. 
+# Add a new line here if you would like to change its default config. (E.g DEFAULT_CHANNEL = "stable")
+# To re-generate a bundle for any other default channel without changing the default setup, you can:
+# - use the DEFAULT_CHANNEL as arg of the bundle target (e.g make bundle DEFAULT_CHANNEL=stable)
+# - use environment variables to overwrite this value (e.g export DEFAULT_CHANNEL="stable")
+ifneq ($(origin DEFAULT_CHANNEL), undefined)
+BUNDLE_DEFAULT_CHANNEL := --default-channel=$(DEFAULT_CHANNEL)
+endif
+BUNDLE_METADATA_OPTS ?= $(BUNDLE_CHANNELS) $(BUNDLE_DEFAULT_CHANNEL)
+
+# BUNDLE_IMG defines the image:tag used for the bundle. 
+# You can use it as an arg. (E.g make bundle-build BUNDLE_IMG=<some-registry>/<project-name-bundle>:<tag>)
+BUNDLE_IMG ?= controller-bundle:$(VERSION)
+
+# Image URL to use all building/pushing image targets
+IMAGE_BUILD_CMD ?= docker build
+IMAGE_PUSH_CMD ?= docker push
+IMAGE_BUILD_EXTRA_OPTS ?=
 IMAGE_REGISTRY ?= k8s.gcr.io/nfd
 IMAGE_NAME := node-feature-discovery-operator
 IMAGE_TAG_NAME ?= $(VERSION)
@@ -30,54 +62,69 @@ IMAGE_REPO := $(IMAGE_REGISTRY)/$(IMAGE_NAME)
 IMAGE_TAG := $(IMAGE_REPO):$(IMAGE_TAG_NAME)
 IMAGE_EXTRA_TAGS := $(foreach tag,$(IMAGE_EXTRA_TAG_NAMES),$(IMAGE_REPO):$(tag))
 
-NAMESPACE      := node-feature-discovery-operator
-PULLPOLICY     ?= Always
-TEMPLATE_CMD    = sed 's+REPLACE_IMAGE+$(IMAGE_TAG)+g; s+REPLACE_NAMESPACE+$(NAMESPACE)+g; s+IfNotPresent+$(PULLPOLICY)+'
-GOFMT_CHECK=$(shell find . -not \( \( -wholename './.*' -o -wholename '*/vendor/*' \) -prune \) -name '*.go' | sort -u | xargs gofmt -s -l)
+# Produce CRDs that work back to Kubernetes 1.11 (no version conversion)
+CRD_OPTIONS ?= "crd:trivialVersions=true,preserveUnknownFields=false"
 
-DEPLOY_OBJECTS  = manifests/0100_namespace.yaml manifests/0200_service_account.yaml manifests/0300_cluster_role.yaml manifests/0400_cluster_role_binding.yaml manifests/0600_operator.yaml
-DEPLOY_CRDS     = manifests/0500_crd.yaml
-DEPLOY_CRS      = manifests/0700_cr.yaml
+# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
+ifeq (,$(shell go env GOBIN))
+GOBIN=$(shell go env GOPATH)/bin
+else
+GOBIN=$(shell go env GOBIN)
+endif
 
-PACKAGE=github.com/kubernetes-sigs/node-feature-discovery-operator
-MAIN_PACKAGE=$(PACKAGE)/cmd/manager
+GOOS=linux
 
+PACKAGE=github.com/kubernetes-sigs/node-feature-discovery-operator
+MAIN_PACKAGE=main.go
 BIN=node-feature-discovery-operator
 
-DOCKERFILE=Dockerfile
-
-GOOS=linux
-
 all: build
 
+# Run tests
+ENVTEST_ASSETS_DIR=$(shell pwd)/testbin
+test: generate fmt vet manifests
+	mkdir -p ${ENVTEST_ASSETS_DIR}
+	test -f ${ENVTEST_ASSETS_DIR}/setup-envtest.sh || curl -sSLo ${ENVTEST_ASSETS_DIR}/setup-envtest.sh https://raw.githubusercontent.com/kubernetes-sigs/controller-runtime/v0.7.0/hack/setup-envtest.sh
+	source ${ENVTEST_ASSETS_DIR}/setup-envtest.sh; fetch_envtest_tools $(ENVTEST_ASSETS_DIR); setup_envtest_env $(ENVTEST_ASSETS_DIR); go test ./... -coverprofile cover.out
 go_mod:
 	@go mod download
 
+# Build binary
 build: go_mod
-	@GOOS=$(GOOS) go build -o $(BIN) $(MAIN_PACKAGE)
-
-deploy-crds:
-	for obj in $(DEPLOY_CRDS); do \
-		$(TEMPLATE_CMD) $$obj | kubectl apply -f - ;\
-		sleep 1;\
-	done
-
-deploy-objects: deploy-crds
-	for obj in $(DEPLOY_OBJECTS); do \
-		$(TEMPLATE_CMD) $$obj | kubectl apply -f - ;\
-		sleep 1;\
-	done
-
-deploy: deploy-objects
-	for obj in $(DEPLOY_CRS); do \
-		$(TEMPLATE_CMD) $$obj | kubectl apply -f - ;\
-		sleep 1;\
-	done
+	@GOOS=$(GOOS) GO111MODULE=on CGO_ENABLED=0 go build -o $(BIN) $(MAIN_PACKAGE)
 
+# Run against the configured Kubernetes cluster in ~/.kube/config
+run: generate fmt vet manifests
+	go run ./main.go
+
+# Install CRDs into a cluster
+install: manifests kustomize
+	$(KUSTOMIZE) build config/crd | kubectl apply -f -
+
+# Uninstall CRDs from a cluster
+uninstall: manifests kustomize
+	$(KUSTOMIZE) build config/crd | kubectl delete -f -
+
+# Deploy controller in the configured Kubernetes cluster in ~/.kube/config
+deploy: kustomize
+	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMAGE_TAG}
+	$(KUSTOMIZE) build config/default | kubectl apply -f -
+
+# UnDeploy controller from the configured Kubernetes cluster in ~/.kube/config
 undeploy:
-	for obj in $(DEPLOY_OBJECTS) $(DEPLOY_CRDS) $(DEPLOY_CRS); do \
-		$(TEMPLATE_CMD) $$obj | kubectl delete -f - ;\
-	done
+	$(KUSTOMIZE) build config/default | kubectl delete -f -
+
+# Generate manifests e.g. CRD, RBAC etc.
+manifests: controller-gen
+	$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
+
+# Run go fmt against code
+fmt:
+	go fmt ./...
+
+# Run go vet against code
+vet:
+	go vet ./...
 
 verify:	verify-gofmt ci-lint
 
@@ -94,17 +141,22 @@ clean:
 	go clean
 	rm -f $(BIN)
 
+# clean NFD labels on all nodes
+# devel only 
 clean-labels:
 	kubectl get no -o yaml | sed -e '/^\s*nfd.node.kubernetes.io/d' -e '/^\s*feature.node.kubernetes.io/d' | kubectl replace -f -
 
-image:
+# Generate code
+generate: controller-gen
+	$(CONTROLLER_GEN) object:headerFile="utils/boilerplate.go.txt" paths="./..."
+
+# Build the docker image
+image: 
 	$(IMAGE_BUILD_CMD) -t $(IMAGE_TAG) \
 		$(foreach tag,$(IMAGE_EXTRA_TAGS),-t $(tag)) \
 		$(IMAGE_BUILD_EXTRA_OPTS) ./
 
-test:
-	go test ./cmd/... ./pkg/... -coverprofile cover.out
-
+# Push the docker image
 push:
 	$(IMAGE_PUSH_CMD) $(IMAGE_TAG)
 	for tag in $(IMAGE_EXTRA_TAGS); do $(IMAGE_PUSH_CMD) $$tag; done
@@ -119,3 +171,39 @@ site-serve:
 
 .PHONY: all build test generate verify verify-gofmt clean deploy-objects deploy-operator deploy-crds push image
 .SILENT: go_mod
+# Download controller-gen locally if necessary
+CONTROLLER_GEN = $(shell pwd)/bin/controller-gen
+controller-gen:
+	$(call go-get-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/[email protected])
+
+# Download kustomize locally if necessary
+KUSTOMIZE = $(shell pwd)/bin/kustomize
+kustomize:
+	$(call go-get-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/[email protected])
+
+# go-get-tool will 'go get' any package $2 and install it to $1.
+PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
+define go-get-tool
+@[ -f $(1) ] || { \
+set -e ;\
+TMP_DIR=$$(mktemp -d) ;\
+cd $$TMP_DIR ;\
+go mod init tmp ;\
+echo "Downloading $(2)" ;\
+GOBIN=$(PROJECT_DIR)/bin go get $(2) ;\
+rm -rf $$TMP_DIR ;\
+}
+endef
+
+# Generate bundle manifests and metadata, then validate generated files.
+.PHONY: bundle
+bundle: manifests kustomize
+	operator-sdk generate kustomize manifests -q
+	cd config/manager && $(KUSTOMIZE) edit set image controller=$(IMAGE_TAG)
+	$(KUSTOMIZE) build config/manifests | operator-sdk generate bundle -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)
+	operator-sdk bundle validate ./bundle
+
+# Build the bundle image.
+.PHONY: bundle-build
+bundle-build:
+	$(IMAGE_BUILD_CMD)  -f bundle.Dockerfile -t $(BUNDLE_IMG) .

PROJECT

@@ -0,0 +1,13 @@
+domain: nodefeaturediscoveries.nfd.kubernetes.io
+layout: go.kubebuilder.io/v3
+projectName: node-feature-discovery-operator
+repo: github.com/kubernetes-sigs/node-feature-discovery-operator
+resources:
+- crdVersion: v1
+  group: nfd.kubernetes.io
+  kind: NodeFeatureDiscovery
+  version: v1
+version: 3-alpha
+plugins:
+  manifests.sdk.operatorframework.io/v2: {}
+  scorecard.sdk.operatorframework.io/v2: {}

api/v1/groupversion_info.go

@@ -0,0 +1,36 @@
+/*
+Copyright 2021. The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Package v1 contains API Schema definitions for the nfd.kubernetes.io v1 API group
+// +kubebuilder:object:generate=true
+// +groupName=nfd.kubernetes.io
+package v1
+
+import (
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"sigs.k8s.io/controller-runtime/pkg/scheme"
+)
+
+var (
+	// GroupVersion is group version used to register these objects
+	GroupVersion = schema.GroupVersion{Group: "nfd.kubernetes.io", Version: "v1"}
+
+	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
+	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
+
+	// AddToScheme adds the types in this group-version to the given scheme.
+	AddToScheme = SchemeBuilder.AddToScheme
+)

pkg/apis/nfd/v1/nodefeaturediscovery_types.go renamed to api/v1/nodefeaturediscovery_types.go

@@ -1,6 +1,23 @@
+/*
+Copyright 2021. The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package v1
 
 import (
+	conditionsv1 "github.com/openshift/custom-resource-status/conditions/v1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
@@ -33,14 +50,17 @@ type ConfigSpec struct {
 
 // NodeFeatureDiscoveryStatus defines the observed state of NodeFeatureDiscovery
 // +k8s:openapi-gen=true
-type NodeFeatureDiscoveryStatus struct{}
-
-// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+type NodeFeatureDiscoveryStatus struct {
+	// Conditions represents the latest available observations of current state.
+	// +optional
+	Conditions []conditionsv1.Condition `json:"conditions,omitempty"`
+}
 
-// NodeFeatureDiscovery is the Schema for the nodefeaturediscoveries API
-// +k8s:openapi-gen=true
+// +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +kubebuilder:resource:path=nodefeaturediscoveries,scope=Namespaced
+
+// NodeFeatureDiscovery is the Schema for the nodefeaturediscoveries API
 type NodeFeatureDiscovery struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -49,6 +69,7 @@ type NodeFeatureDiscovery struct {
 	Status NodeFeatureDiscoveryStatus `json:"status,omitempty"`
 }
 
+// +kubebuilder:object:root=true
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
 // NodeFeatureDiscoveryList contains a list of NodeFeatureDiscovery