forked from kubernetes-sigs/kubebuilder
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove deprecated
go get from Makefile templates
Signed-off-by: Ryan King <[email protected]> In go 1.18, using `go get` to install go binaries will be removed from in favor of using `go install`. This commit updates the Makefile templates to use alternative installation methods to install the tools used at generation. Since `go install` adds extra constraints on what go packages can be installed, not all tools were a simple `go get` => `go install` change: - `kustomize`: Incompatible with `go install` because its `go.mod` has `exclude` and `replace` directives. The template now uses the official install script. - `controller-gen`: Fully compatible with `go install`. - `setup-envtest`: Can be installed using `go install`, but not a specific version since the repo does not have the tag scheme since it is in a sub-module. It would need a tag in the format `tools/setup-envtest/vX.Y.Z`. The commit also regenerated all book source code using this new pattern.
- Loading branch information
Showing
42 changed files
with
3,835 additions
and
1,768 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 |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |
| # 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.22 | ||
| ENVTEST_K8S_VERSION = 1.23 | ||
|
|
||
| # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set) | ||
| ifeq (,$(shell go env GOBIN)) | ||
|
|
@@ -17,6 +17,7 @@ endif | |
| SHELL = /usr/bin/env bash -o pipefail | ||
| .SHELLFLAGS = -ec | ||
|
|
||
| .PHONY: all | ||
| all: build | ||
|
|
||
| ##@ General | ||
|
|
@@ -32,78 +33,101 @@ all: build | |
| # 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: manifests | ||
| manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects. | ||
| $(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases | ||
|
|
||
| .PHONY: generate | ||
| generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations. | ||
| $(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..." | ||
|
|
||
| .PHONY: fmt | ||
| fmt: ## Run go fmt against code. | ||
| go fmt ./... | ||
|
|
||
| .PHONY: vet | ||
| vet: ## Run go vet against code. | ||
| go vet ./... | ||
|
|
||
| .PHONY: test | ||
| test: manifests generate fmt vet envtest ## Run tests. | ||
| KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test ./... -coverprofile cover.out | ||
|
|
||
| ##@ Build | ||
|
|
||
| .PHONY: build | ||
| build: generate fmt vet ## Build manager binary. | ||
| go build -o bin/manager main.go | ||
|
|
||
| .PHONY: run | ||
| run: manifests generate fmt vet ## Run a controller from your host. | ||
| go run ./main.go | ||
|
|
||
| .PHONY: docker-build | ||
| docker-build: test ## Build docker image with the manager. | ||
| docker build -t ${IMG} . | ||
|
|
||
| .PHONY: docker-push | ||
| docker-push: ## Push docker image with the manager. | ||
| docker push ${IMG} | ||
|
|
||
| ##@ Deployment | ||
|
|
||
| ifndef ignore-not-found | ||
| ignore-not-found = false | ||
| endif | ||
|
|
||
| .PHONY: install | ||
| install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config. | ||
| $(KUSTOMIZE) build config/crd | kubectl apply -f - | ||
|
|
||
| uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified in ~/.kube/config. | ||
| $(KUSTOMIZE) build config/crd | kubectl delete -f - | ||
| .PHONY: uninstall | ||
| uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion. | ||
| $(KUSTOMIZE) build config/crd | kubectl delete --ignore-not-found=$(ignore-not-found) -f - | ||
|
|
||
| .PHONY: deploy | ||
| deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config. | ||
| cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG} | ||
| $(KUSTOMIZE) build config/default | kubectl apply -f - | ||
|
|
||
| undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config. | ||
| $(KUSTOMIZE) build config/default | kubectl delete -f - | ||
|
|
||
|
|
||
| CONTROLLER_GEN = $(shell pwd)/bin/controller-gen | ||
| controller-gen: ## Download controller-gen locally if necessary. | ||
| $(call go-get-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/[email protected]) | ||
|
|
||
| KUSTOMIZE = $(shell pwd)/bin/kustomize | ||
| kustomize: ## Download kustomize locally if necessary. | ||
| $(call go-get-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/[email protected]) | ||
|
|
||
| ENVTEST = $(shell pwd)/bin/setup-envtest | ||
| envtest: ## Download envtest-setup locally if necessary. | ||
| $(call go-get-tool,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest@latest) | ||
|
|
||
| # 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 | ||
| .PHONY: undeploy | ||
| undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion. | ||
| $(KUSTOMIZE) build config/default | kubectl delete --ignore-not-found=$(ignore-not-found) -f - | ||
|
|
||
| ##@ Build Dependencies | ||
|
|
||
| ## Location to install dependencies to | ||
| LOCALBIN ?= $(shell pwd)/bin | ||
| $(LOCALBIN): ## Ensure that the directory exists | ||
| 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.8.0 | ||
|
|
||
| KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh" | ||
| .PHONY: kustomize | ||
| kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary. | ||
| $(KUSTOMIZE): | ||
| curl -s $(KUSTOMIZE_INSTALL_SCRIPT) | bash -s -- $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN) | ||
|
|
||
| .PHONY: controller-gen | ||
| controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary. | ||
| $(CONTROLLER_GEN): | ||
| 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): | ||
| GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest | ||
1 change: 1 addition & 0 deletions
1
docs/book/src/component-config-tutorial/testdata/project/api/v2/zz_generated.deepcopy.go
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
3 changes: 1 addition & 2 deletions
3
...rial/testdata/project/config/crd/bases/config.tutorial.kubebuilder.io_projectconfigs.yaml
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 |
|---|---|---|
|
|
@@ -3,4 +3,4 @@ kind: ProjectConfig | |
| metadata: | ||
| name: projectconfig-sample | ||
| spec: | ||
| # Add fields here | ||
| # TODO(user): Add fields here | ||
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
Oops, something went wrong.