-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Use cache when build docker images * Adjust makefile * Add license to all source files * Switch from `busybox` to `debian-slim` Do not compile `fio` and `stress-ng`, install them from package
- Loading branch information
Showing
89 changed files
with
1,362 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,157 @@ | ||
|
|
||
| # Image URL to use all building/pushing image targets | ||
| IMG ?= controller:latest | ||
|
|
||
| # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary. | ||
| ENVTEST_K8S_VERSION = 1.26.0 | ||
| INVENTORY_BIN_NAME = "inventory" | ||
| LLDP_UPDATE_BIN_NAME = "nic-updater" | ||
| BENCHMARK_BIN_NAME = "benchmark" | ||
| BENCHMARK_SCHEDULER_BIN_NAME = "benchmark-scheduler" | ||
|
|
||
| DOCKER_REGISTRY ?= localhost:5000 | ||
| DOCKER_IMAGE_NAME ?= inventory | ||
| DOCKER_IMAGE_TAG ?= latest | ||
|
|
||
| GOPRIVATE ?= "github.com/onmetal/*" | ||
| GITHUB_PAT_PATH ?= | ||
| ifeq (,$(GITHUB_PAT_PATH)) | ||
| GITHUB_PAT_MOUNT ?= | ||
| # 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 | ||
| GITHUB_PAT_MOUNT ?= --secret id=github_pat,src=$(GITHUB_PAT_PATH) | ||
| GOBIN=$(shell go env GOBIN) | ||
| endif | ||
|
|
||
|
|
||
| # Setting SHELL to bash allows bash commands to be executed by recipes. | ||
| # Options are set to exit when a recipe line exits non-zero or a piped command fails. | ||
| SHELL = /usr/bin/env bash -o pipefail | ||
| .SHELLFLAGS = -ec | ||
| .PHONY: all | ||
| all: build | ||
|
|
||
| .PHONY: build | ||
| build: fmt vet | ||
| for BIN_NAME in $(INVENTORY_BIN_NAME) $(LLDP_UPDATE_BIN_NAME) $(BENCHMARK_BIN_NAME) $(BENCHMARK_SCHEDULER_BIN_NAME); do \ | ||
| go build -o dist/$$BIN_NAME cmd/$$BIN_NAME/main.go; \ | ||
| done | ||
| cp -rf res/ dist/ | ||
| ##@ General | ||
|
|
||
| # The help target prints out all targets with their descriptions organized | ||
| # beneath their categories. The categories are represented by '##@' and the | ||
| # target descriptions by '##'. The awk commands is responsible for reading the | ||
| # entire set of makefiles included in this invocation, looking for lines of the | ||
| # file as xyz: ## something, and then pretty-format the target and help. Then, | ||
| # if there's a line with ##@ something, that gets pretty-printed as a category. | ||
| # More info on the usage of ANSI control characters for terminal formatting: | ||
| # https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters | ||
| # More info on the awk command: | ||
| # http://linuxcommand.org/lc3_adv_awk.php | ||
|
|
||
| .PHONY: help | ||
| help: ## Display this help. | ||
| @awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) | ||
|
|
||
| ##@ Development | ||
|
|
||
| .PHONY: fmt | ||
| fmt: | ||
| fmt: ## Run go fmt against code. | ||
| go fmt ./... | ||
|
|
||
| .PHONY: vet | ||
| vet: | ||
| vet: ## Run go vet against code. | ||
| go vet ./... | ||
|
|
||
| .PHONY: test | ||
| test: fmt vet envtest checklicense ## Run tests. | ||
| @echo "--> Project testing" | ||
| KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test -race ./... -coverprofile cover.out | ||
| @echo "--> Making coverage html page" | ||
| go tool cover -html cover.out -o ./index.html | ||
|
|
||
| .PHONY: addlicense | ||
| addlicense: ## Add license headers to all go files. | ||
| find . -name '*.go' -exec go run github.com/google/addlicense -c 'OnMetal authors' {} + | ||
|
|
||
| .PHONY: checklicense | ||
| checklicense: ## Check that every file has a license header present. | ||
| find . -name '*.go' -exec go run github.com/google/addlicense -check -c 'OnMetal authors' {} + | ||
|
|
||
| lint: ## Run golangci-lint against code. | ||
| golangci-lint run ./... | ||
|
|
||
| check: checklicense lint test | ||
|
|
||
| ##@ Build | ||
|
|
||
| .PHONY: build | ||
| build: fmt vet ## Build manager binary. | ||
| for BIN_NAME in $(INVENTORY_BIN_NAME) $(LLDP_UPDATE_BIN_NAME) $(BENCHMARK_BIN_NAME) $(BENCHMARK_SCHEDULER_BIN_NAME); do \ | ||
| go build -o dist/$$BIN_NAME cmd/$$BIN_NAME/main.go; \ | ||
| done | ||
| cp -rf res/ dist/ | ||
|
|
||
| .PHONY: dl-pciids | ||
| dl-pciids: | ||
| curl https://pci-ids.ucw.cz/v2.2/pci.ids --output ./res/pci.ids | ||
|
|
||
| .PHONY: run | ||
| run: fmt vet ## Run a controller from your host. | ||
| go run ./main.go | ||
|
|
||
| # If you wish built the manager image targeting other platforms you can use the --platform flag. | ||
| # (i.e. docker build --platform linux/arm64 ). However, you must enable docker buildKit for it. | ||
| # More info: https://docs.docker.com/develop/develop-images/build_enhancements/ | ||
| .PHONY: docker-build | ||
| docker-build: | ||
| docker build . -t $(DOCKER_REGISTRY)/$(DOCKER_IMAGE_NAME):$(DOCKER_IMAGE_TAG) --build-arg GOPRIVATE=$(GOPRIVATE) --build-arg GIT_USER=$(GIT_USER) --build-arg GIT_PASSWORD=$(GIT_PASSWORD) $(GITHUB_PAT_MOUNT) | ||
| docker-build: test ## Build docker image with the manager. | ||
| docker build -t ${IMG} . | ||
|
|
||
| .PHONY: docker-push | ||
| docker-push: | ||
| docker push $(DOCKER_REGISTRY)/$(DOCKER_IMAGE_NAME):$(DOCKER_IMAGE_TAG) | ||
| docker-push: ## Push docker image with the manager. | ||
| docker push ${IMG} | ||
|
|
||
| # PLATFORMS defines the target platforms for the manager image be build to provide support to multiple | ||
| # architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to: | ||
| # - able to use docker buildx . More info: https://docs.docker.com/build/buildx/ | ||
| # - have enable BuildKit, More info: https://docs.docker.com/develop/develop-images/build_enhancements/ | ||
| # - be able to push the image for your registry (i.e. if you do not inform a valid value via IMG=<myregistry/image:<tag>> then the export will fail) | ||
| # To properly provided solutions that supports more than one platform you should use this option. | ||
| PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le | ||
| .PHONY: docker-buildx | ||
| docker-buildx: test ## Build and push docker image for the manager for cross-platform support | ||
| # copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile | ||
| sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross | ||
| - docker buildx create --name project-v3-builder | ||
| docker buildx use project-v3-builder | ||
| - docker buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross . | ||
| - docker buildx rm project-v3-builder | ||
| rm Dockerfile.cross | ||
|
|
||
| .PHONY: clean | ||
| clean: | ||
| rm -rf ./dist/ | ||
|
|
||
| test: | ||
| @echo "--> Project testing" | ||
| go test -race -v ./... -coverprofile cover.out | ||
| @echo "--> Making coverage html page" | ||
| go tool cover -html cover.out -o ./index.html | ||
| ##@ Build Dependencies | ||
|
|
||
| ## Location to install dependencies to | ||
| LOCALBIN ?= $(shell pwd)/bin | ||
| $(LOCALBIN): | ||
| mkdir -p $(LOCALBIN) | ||
|
|
||
| ## Tool Binaries | ||
| KUSTOMIZE ?= $(LOCALBIN)/kustomize | ||
| CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen | ||
| ENVTEST ?= $(LOCALBIN)/setup-envtest | ||
|
|
||
| ## Tool Versions | ||
| KUSTOMIZE_VERSION ?= v3.8.7 | ||
| CONTROLLER_TOOLS_VERSION ?= v0.11.1 | ||
|
|
||
| KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh" | ||
| .PHONY: kustomize | ||
| kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary. If wrong version is installed, it will be removed before downloading. | ||
| $(KUSTOMIZE): $(LOCALBIN) | ||
| @if test -x $(LOCALBIN)/kustomize && ! $(LOCALBIN)/kustomize version | grep -q $(KUSTOMIZE_VERSION); then \ | ||
| echo "$(LOCALBIN)/kustomize version is not expected $(KUSTOMIZE_VERSION). Removing it before installing."; \ | ||
| rm -rf $(LOCALBIN)/kustomize; \ | ||
| fi | ||
| test -s $(LOCALBIN)/kustomize || { curl -Ss $(KUSTOMIZE_INSTALL_SCRIPT) | bash -s -- $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN); } | ||
|
|
||
| .PHONY: controller-gen | ||
| controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary. If wrong version is installed, it will be overwritten. | ||
| $(CONTROLLER_GEN): $(LOCALBIN) | ||
| test -s $(LOCALBIN)/controller-gen && $(LOCALBIN)/controller-gen --version | grep -q $(CONTROLLER_TOOLS_VERSION) || \ | ||
| GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION) | ||
|
|
||
| .PHONY: envtest | ||
| envtest: $(ENVTEST) ## Download envtest-setup locally if necessary. | ||
| $(ENVTEST): $(LOCALBIN) | ||
| test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| // Copyright 2023 OnMetal 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 tools | ||
|
|
||
| //go:build tools | ||
| // +build tools | ||
|
|
||
| package tools | ||
|
|
||
| import ( | ||
| // Use addlicense for adding license headers. | ||
| _ "github.com/google/addlicense" | ||
| ) |
Oops, something went wrong.