Merge upstream 2020 06 04

.gitignore

@@ -1,4 +1,5 @@
 # Temporary Build Files
+bin
 build/_output
 build/_test
 # Created by https://www.gitignore.io/api/go,vim,emacs,visualstudiocode

.travis.yml

@@ -13,8 +13,7 @@ before_install:
 
 env:
   - TARGET=unit-verbose
-  - TARGET=lint
   - TARGET=docker
-  - TARGET=golint-check
+  - TARGET=lint
 
 script: make $TARGET

Makefile

@@ -19,16 +19,8 @@ export GO111MODULE=on
 export GOFLAGS=
 
 .PHONY: help
-help:
-	@echo "Targets:"
-	@echo "  test             -- run unit tests and linter"
-	@echo "  unit             -- run the unit tests"
-	@echo "  unit-cover       -- run the unit tests and write code coverage statistics to console"
-	@echo "  unit-cover-html  -- run the unit tests and open code coverage statistics in a browser"
-	@echo "  unit-verbose     -- run unit tests with verbose flag enabled"
-	@echo "  lint             -- run the linter"
-	@echo "  e2e-local        -- run end-to-end tests locally"
-	@echo "  help             -- this help output"
+help:  ## Display this help
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 	@echo
 	@echo "Variables:"
 	@echo "  TEST_NAMESPACE   -- project name to use ($(TEST_NAMESPACE))"
@@ -37,11 +29,12 @@ help:
 	@echo "  DEBUG            -- debug flag, if any ($(DEBUG))"
 
 .PHONY: test
-test: generate unit lint
+test: fmt generate lint vet unit ## Run common developer tests
 
 .PHONY: generate
-generate:
-	operator-sdk generate k8s
+generate: bin/operator-sdk ## Run the operator-sdk code generator
+	./bin/operator-sdk generate $(VERBOSE) k8s
+	./bin/operator-sdk generate $(VERBOSE) crds
 	openapi-gen \
 		--input-dirs ./pkg/apis/metal3/v1alpha1 \
 		--output-package ./pkg/apis/metal3/v1alpha1 \
@@ -50,15 +43,21 @@ generate:
 		--report-filename "-" \
 		--go-header-file /dev/null
 
+bin/operator-sdk: bin
+	make -C tools/operator-sdk install
+
+bin:
+	mkdir -p bin
+
 .PHONY: travis
 travis: unit-verbose lint
 
 .PHONY: unit
-unit:
+unit: ## Run unit tests
 	go test $(GO_TEST_FLAGS) ./cmd/... ./pkg/...
 
 .PHONY: unit-cover
-unit-cover:
+unit-cover: ## Run unit tests with code coverage
 	go test -coverprofile=cover.out $(GO_TEST_FLAGS) ./cmd/... ./pkg/...
 	go tool cover -func=cover.out
 
@@ -68,14 +67,18 @@ unit-cover-html:
 	go tool cover -html=cover.out
 
 .PHONY: unit-verbose
-unit-verbose:
+unit-verbose: ## Run unit tests with verbose output
 	VERBOSE=-v make unit
 
-crd_file=deploy/crds/metal3.io_baremetalhosts_crd.yaml
-crd_tmp=.crd.yaml.tmp
+.PHONY: linters
+linters: sec lint generate-check fmt-check vet ## Run all linters
+
+.PHONY: vet
+vet: ## Run go vet
+	go vet ./pkg/... ./cmd/...
 
-.PHONY: golint-check
-lint: $GOPATH/bin/golint
+.PHONY: lint
+lint: golint-binary ## Run golint
 	find ./pkg ./cmd -type f -name \*.go  |grep -v zz_ | xargs -L1 golint -set_exit_status
 
 .PHONY: generate-check
@@ -86,16 +89,27 @@ generate-check:
 generate-check-local:
 	IS_CONTAINER=local ./hack/generate.sh
 
-.PHONY: test-sec
-test-sec: $GOPATH/bin/gosec
-	gosec -severity medium --confidence medium -quiet ./...
+.PHONY: sec
+sec: $GOPATH/bin/gosec
+	gosec -severity medium --confidence medium -quiet ./pkg/... ./cmd/...
 
 $GOPATH/bin/gosec:
 	go get -u github.com/securego/gosec/cmd/gosec
 
+.PHONY: golint-binary
+golint-binary:
+	which golint 2>&1 >/dev/null || $(MAKE) $GOPATH/bin/golint
 $GOPATH/bin/golint:
 	go get -u golang.org/x/lint/golint
 
+.PHONY: fmt
+fmt: ## Run gofmt and write changes to each file
+	gofmt -l -w ./pkg ./cmd
+
+.PHONY: fmt-check
+fmt-check: ## Run gofmt and report an error if any changes are made
+	./hack/gofmt.sh
+
 .PHONY: docs
 docs: $(patsubst %.dot,%.png,$(wildcard docs/*.dot))
 
@@ -110,35 +124,44 @@ e2e-local:
 		$(DEBUG) --go-test-flags "$(GO_TEST_FLAGS)"
 
 .PHONY: run
-run:
-	operator-sdk up local \
+run: ## Run the operator outside of a cluster in development mode
+	operator-sdk run --local \
 		--go-ldflags=$(LDFLAGS) \
-		--namespace=$(RUN_NAMESPACE) \
+		--watch-namespace=$(RUN_NAMESPACE) \
 		--operator-flags="-dev"
 
 .PHONY: demo
-demo:
-	operator-sdk up local \
+demo: ## Run the operator outside of a cluster using the demo driver
+	operator-sdk run --local \
 		--go-ldflags=$(LDFLAGS) \
-		--namespace=$(RUN_NAMESPACE) \
+		--watch-namespace=$(RUN_NAMESPACE) \
 		--operator-flags="-dev -demo-mode"
 
 .PHONY: docker
-docker:
+docker: docker-operator docker-sdk docker-golint ## Build docker images
+
+.PHONY: docker-operator
+docker-operator:
 	docker build . -f build/Dockerfile
 
+.PHONY: docker-sdk
+docker-sdk:
+	docker build . -f hack/Dockerfile.operator-sdk
+
+.PHONY: docker-golint
+docker-golint:
+	docker build . -f hack/Dockerfile.golint
+
 .PHONY: build
-build:
+build: ## Build the operator binary
 	@echo LDFLAGS=$(LDFLAGS)
-	go build -mod=vendor -o build/_output/bin/baremetal-operator cmd/manager/main.go
+	go build -mod=vendor -ldflags $(LDFLAGS) -o build/_output/bin/baremetal-operator cmd/manager/main.go
 
 .PHONY: tools
 tools:
-	@echo LDFLAGS=$(LDFLAGS)
-	go build -mod=vendor -o build/_output/bin/get-hardware-details cmd/get-hardware-details/main.go
+	go build -o build/_output/bin/get-hardware-details cmd/get-hardware-details/main.go
 
 .PHONY: deploy
 deploy:
 	cd deploy && kustomize edit set namespace $(RUN_NAMESPACE) && cd ..
 	kustomize build deploy | kubectl apply -f -
-

cmd/get-hardware-details/main.go

@@ -23,7 +23,7 @@ func main() {
 			IronicInspectorEndpoint: os.Args[1],
 		})
 	if err != nil {
-		fmt.Printf("could not get inpsector client: %s", err)
+		fmt.Printf("could not get inspector client: %s", err)
 		os.Exit(1)
 	}
 

cmd/manager/main.go

@@ -21,8 +21,8 @@ import (
 )
 
 var (
-	log                     = logf.Log.WithName("cmd")
-	watchNamespace          string
+	log            = logf.Log.WithName("cmd")
+	watchNamespace string
 )
 
 func printVersion() {

deploy/bmo-capm3/README.md

@@ -0,0 +1,5 @@
+# BMO AS PART OF DEPLOYMENT OF CAPM3
+
+The main goal is to deploy BMO as part of deployment in CAPM3 project.
+Ironic will be running outside of the cluster. Only the needed variables
+inside the ironic_bmo_configmap.env are kept and parameterized.

deploy/bmo-capm3/ironic_bmo_configmap.env

@@ -0,0 +1,4 @@
+DEPLOY_KERNEL_URL=${DEPLOY_KERNEL_URL}
+DEPLOY_RAMDISK_URL=${DEPLOY_RAMDISK_URL}
+IRONIC_ENDPOINT=${IRONIC_URL}
+IRONIC_INSPECTOR_ENDPOINT=${IRONIC_INSPECTOR_URL}

deploy/bmo-capm3/kustomization.yaml

@@ -0,0 +1,10 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+- ../rbac
+- ../crds
+- ../operator/no_ironic
+configMapGenerator:
+- envs:
+  - ironic_bmo_configmap.env
+  name: ironic-bmo-configmap