-
Notifications
You must be signed in to change notification settings - Fork 61
/
Makefile
209 lines (160 loc) · 8.14 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# IMAGE_TAG_BASE defines the docker.io namespace and part of the image name for remote images.
# This variable is used to construct full image tags for bundle and catalog images.
#
# For example, running 'make bundle-build bundle-push catalog-build catalog-push' will build and push both
# cloud.redhat.com/clowder-bundle:$VERSION and cloud.redhat.com/clowder-catalog:$VERSION.
IMAGE_TAG_BASE ?= quay.io/cloudservices/clowder
CLOWDER_BUILD_TAG ?= $(shell git rev-parse --short=8 HEAD)
GO_CMD ?= go
# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
ENVTEST_K8S_VERSION = 1.28
# Image URL to use all building/pushing image targets
ifeq ($(findstring -minikube,${MAKECMDGOALS}), -minikube)
IMG ?= 127.0.0.1:5000/clowder:$(CLOWDER_BUILD_TAG)
else
IMG ?= quay.io/cloudservices/clowder:$(CLOWDER_BUILD_TAG)
endif
CLOWDER_VERSION ?= $(shell git describe --tags)
# Use podman by default, docker as fallback
ifeq (,$(shell which podman))
$(info "no podman in $(PATH), using docker")
RUNTIME ?= docker
else
RUNTIME ?= podman
endif
# Install gojsonschema if not found
GOJSONSCHEMA_BIN := $(shell which gojsonschema 2> /dev/null)
ifndef GOJSONSCHEMA_BIN
$(info gojsonschema binary not found. Installing...)
$(shell $(GO_CMD) install github.com/atombender/go-jsonschema/cmd/gojsonschema@v0.12.1)
$(info Ensure that $$GOPATH/bin is in your PATH.)
endif
KUTTL_TEST ?= ""
# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
ifeq (,$(shell $(GO_CMD) env GOBIN))
GOBIN=$(shell $(GO_CMD) env GOPATH)/bin
else
GOBIN=$(shell $(GO_CMD) env GOBIN)
endif
# Setting SHELL to bash allows bash commands to be executed by recipes.
# This is a requirement for 'setup-envtest.sh' in the test target.
# 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
all: build
##@ 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
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
api-docs:
./build/build_api_docs.sh
./build/build_config_docs.sh
build-template: manifests kustomize controller-gen
$(KUSTOMIZE) build config/deployment-template | ./manifest2template.py --config config/deployment-template/clowder_config.yaml --mutate > deploy-mutate.yml
$(KUSTOMIZE) build config/deployment-template | ./manifest2template.py --config config/deployment-template/clowder_config.yaml > deploy.yml
release: manifests kustomize controller-gen
echo "---" > manifest.yaml
cat config/manager/clowder_config.yaml >> manifest.yaml
echo "---" >> manifest.yaml
cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
cd ../..
$(KUSTOMIZE) build config/release-manifest >> manifest.yaml
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
generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
fmt: ## Run go fmt against code.
$(GO_CMD) fmt ./...
vet: ## Run go vet against code.
$(GO_CMD) vet ./...
test: update-version manifests envtest generate fmt vet
KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" CLOWDER_CONFIG_PATH=$(PROJECT_DIR)/test_config.json $(GO_CMD) test ./... -coverprofile cover.out
vscode-debug: update-version manifests envtest generate fmt vet
KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" code .
# Run kuttl tests, make kuttl. Or pass in a test to run, make kuttl KUTTL_TEST="--test=testephemeral-gateway"
kuttl: manifests generate fmt vet envtest
KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" kubectl kuttl test \
--config tests/kuttl/kuttl-test.yaml \
--manifest-dir config/crd/bases/ \
tests/kuttl/ \
$(KUTTL_TEST)
##@ Build
genconfig:
cd controllers/cloud.redhat.com/config && gojsonschema -p config -o types.go schema.json
build: update-version generate fmt vet ## Build manager binary.
$(GO_CMD) build -o bin/manager main.go
run: update-version manifests generate fmt vet ## Run a controller from your host.
$(GO_CMD) run ./main.go
docker-build-and-push-base:
$(RUNTIME) build -f Dockerfile.base . -t $(BASE_IMG)
$(RUNTIME) push $(BASE_IMG)
# Build the docker image
docker-build: update-version
$(RUNTIME) build . -t ${IMG} --build-arg BASE_IMAGE=$(BASE_IMG)
# Build the docker image
docker-build-no-test-quick: update-version
CGO_ENABLED=0 GOOS=linux GO111MODULE=on $(GO_CMD) build -o bin/manager-cgo main.go
$(RUNTIME) build -f build/Dockerfile-local . -t ${IMG}
# Build the docker image
docker-build-no-test:
$(RUNTIME) build . -t ${IMG}
# Push the docker image
docker-push:
$(RUNTIME) push ${IMG}
# Push the docker image
docker-push-minikube:
$(RUNTIME) push ${IMG} $(shell minikube ip):5000/clowder:$(CLOWDER_BUILD_TAG) --tls-verify=false
deploy-minikube: docker-build-no-test docker-push-minikube deploy
deploy-minikube-quick: docker-build-no-test-quick docker-push-minikube deploy
# we can't git ignore these files, but we want to avoid overwriting them
no-update:
git fetch origin
git checkout origin/master -- config/manager/kustomization.yaml \
controllers/cloud.redhat.com/version.txt \
config/manifests/bases/clowder.clusterserviceversion.yaml
##@ Deployment
pre-push: manifests generate genconfig build-template api-docs no-update
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 -
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/release-manifest | minikube kubectl -- apply --validate=false -f -
undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config.
$(KUSTOMIZE) build config/release-manifest | kubectl delete -f -
update-version: ## Updates the version in the image
$(shell echo -n $(CLOWDER_VERSION) > controllers/cloud.redhat.com/version.txt)
echo "Building version: $(CLOWDER_VERSION)"
CONTROLLER_GEN = $(shell pwd)/bin/controller-gen
controller-gen: ## Download controller-gen locally if necessary.
$(call go-install-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen@v0.8.0)
KUSTOMIZE = $(shell pwd)/bin/kustomize
kustomize: ## Download kustomize locally if necessary.
$(call go-install-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v4@v4.5.2)
ENVTEST = $(shell pwd)/bin/setup-envtest
envtest: ## Download envtest-setup locally if necessary.
$(call go-install-tool,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest@d0396a3d6f9fb554ef2da382a3d0bf05f7565e65)
# go-install-tool will 'go install' any package $2 and install it to $1.
PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
define go-install-tool
@[ -f $(1) ] || { \
set -e ;\
TMP_DIR=$$(mktemp -d) ;\
cd $$TMP_DIR ;\
$(GO_CMD) mod init tmp ;\
echo "Downloading $(2)" ;\
GOBIN=$(PROJECT_DIR)/bin $(GO_CMD) install $(2) ;\
rm -rf $$TMP_DIR ;\
}
endef