Makefile 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345
  1. export GO111MODULE=on
  2. .PHONY: push container clean container-name container-latest push-latest fmt lint test unit vendor header generate client deepcopy informer lister openapi manifest manfest-latest manifest-annotate manifest manfest-latest manifest-annotate release gen-docs
  3. OS ?= $(shell go env GOOS)
  4. ARCH ?= $(shell go env GOARCH)
  5. ALL_OS := linux darwin windows
  6. ALL_ARCH := amd64 arm arm64
  7. DOCKER_ARCH := "amd64" "arm v7" "arm64 v8"
  8. ifeq ($(OS),linux)
  9. BINS := bin/$(OS)/$(ARCH)/kg bin/$(OS)/$(ARCH)/kgctl
  10. else
  11. BINS := bin/$(OS)/$(ARCH)/kgctl
  12. endif
  13. RELEASE_BINS := $(addprefix bin/release/kgctl-, $(addprefix linux-, $(ALL_ARCH)) darwin-amd64 windows-amd64)
  14. PROJECT := kilo
  15. PKG := github.com/squat/$(PROJECT)
  16. REGISTRY ?= index.docker.io
  17. IMAGE ?= squat/$(PROJECT)
  18. TAG := $(shell git describe --abbrev=0 --tags HEAD 2>/dev/null)
  19. COMMIT := $(shell git rev-parse HEAD)
  20. VERSION := $(COMMIT)
  21. ifneq ($(TAG),)
  22. ifeq ($(COMMIT), $(shell git rev-list -n1 $(TAG)))
  23. VERSION := $(TAG)
  24. endif
  25. endif
  26. DIRTY := $(shell test -z "$$(git diff --shortstat 2>/dev/null)" || echo -dirty)
  27. VERSION := $(VERSION)$(DIRTY)
  28. LD_FLAGS := -ldflags '-X $(PKG)/pkg/version.Version=$(VERSION)'
  29. SRC := $(shell find . -type f -name '*.go' -not -path "./vendor/*")
  30. GO_FILES ?= $$(find . -name '*.go' -not -path './vendor/*')
  31. GO_PKGS ?= $$(go list ./... | grep -v "$(PKG)/vendor")
  32. CLIENT_GEN_BINARY := bin/client-gen
  33. DOCS_GEN_BINARY := bin/docs-gen
  34. DEEPCOPY_GEN_BINARY := bin/deepcopy-gen
  35. INFORMER_GEN_BINARY := bin/informer-gen
  36. LISTER_GEN_BINARY := bin/lister-gen
  37. OPENAPI_GEN_BINARY := bin/openapi-gen
  38. GOLINT_BINARY := bin/golint
  39. EMBEDMD_BINARY := bin/embedmd
  40. BUILD_IMAGE ?= golang:1.15.7-alpine
  41. BASE_IMAGE ?= alpine:3.12
  42. build: $(BINS)
  43. build-%:
  44. @$(MAKE) --no-print-directory OS=$(word 1,$(subst -, ,$*)) ARCH=$(word 2,$(subst -, ,$*)) build
  45. container-latest-%:
  46. @$(MAKE) --no-print-directory ARCH=$* container-latest
  47. container-%:
  48. @$(MAKE) --no-print-directory ARCH=$* container
  49. push-latest-%:
  50. @$(MAKE) --no-print-directory ARCH=$* push-latest
  51. push-%:
  52. @$(MAKE) --no-print-directory ARCH=$* push
  53. all-build: $(addprefix build-$(OS)-, $(ALL_ARCH))
  54. all-container: $(addprefix container-, $(ALL_ARCH))
  55. all-push: $(addprefix push-, $(ALL_ARCH))
  56. all-container-latest: $(addprefix container-latest-, $(ALL_ARCH))
  57. all-push-latest: $(addprefix push-latest-, $(ALL_ARCH))
  58. generate: client deepcopy informer lister openapi
  59. client: pkg/k8s/clientset/versioned/typed/kilo/v1alpha1/peer.go
  60. pkg/k8s/clientset/versioned/typed/kilo/v1alpha1/peer.go: .header pkg/k8s/apis/kilo/v1alpha1/types.go $(CLIENT_GEN_BINARY)
  61. $(CLIENT_GEN_BINARY) \
  62. --clientset-name versioned \
  63. --input-base "" \
  64. --input $(PKG)/pkg/k8s/apis/kilo/v1alpha1 \
  65. --output-base $(CURDIR) \
  66. --output-package $(PKG)/pkg/k8s/clientset \
  67. --go-header-file=.header \
  68. --logtostderr
  69. rm -r pkg/k8s/clientset || true
  70. mv $(PKG)/pkg/k8s/clientset pkg/k8s
  71. rm -r github.com || true
  72. go fmt ./pkg/k8s/clientset/...
  73. deepcopy: pkg/k8s/apis/kilo/v1alpha1/zz_generated.deepcopy.go
  74. pkg/k8s/apis/kilo/v1alpha1/zz_generated.deepcopy.go: .header pkg/k8s/apis/kilo/v1alpha1/types.go $(DEEPCOPY_GEN_BINARY)
  75. $(DEEPCOPY_GEN_BINARY) \
  76. --input-dirs ./$(@D) \
  77. --go-header-file=.header \
  78. --logtostderr \
  79. --output-base $(CURDIR) \
  80. --output-file-base zz_generated.deepcopy
  81. mv $(PKG)/$@ $@ || true
  82. rm -r github.com || true
  83. go fmt $@
  84. informer: pkg/k8s/informers/kilo/v1alpha1/peer.go
  85. pkg/k8s/informers/kilo/v1alpha1/peer.go: .header pkg/k8s/apis/kilo/v1alpha1/types.go $(INFORMER_GEN_BINARY)
  86. $(INFORMER_GEN_BINARY) \
  87. --input-dirs $(PKG)/pkg/k8s/apis/kilo/v1alpha1 \
  88. --go-header-file=.header \
  89. --logtostderr \
  90. --versioned-clientset-package $(PKG)/pkg/k8s/clientset/versioned \
  91. --listers-package $(PKG)/pkg/k8s/listers \
  92. --output-base $(CURDIR) \
  93. --output-package $(PKG)/pkg/k8s/informers \
  94. --single-directory
  95. rm -r pkg/k8s/informers || true
  96. mv $(PKG)/pkg/k8s/informers pkg/k8s
  97. rm -r github.com || true
  98. go fmt ./pkg/k8s/informers/...
  99. lister: pkg/k8s/listers/kilo/v1alpha1/peer.go
  100. pkg/k8s/listers/kilo/v1alpha1/peer.go: .header pkg/k8s/apis/kilo/v1alpha1/types.go $(LISTER_GEN_BINARY)
  101. $(LISTER_GEN_BINARY) \
  102. --input-dirs $(PKG)/pkg/k8s/apis/kilo/v1alpha1 \
  103. --go-header-file=.header \
  104. --logtostderr \
  105. --output-base $(CURDIR) \
  106. --output-package $(PKG)/pkg/k8s/listers
  107. rm -r pkg/k8s/listers || true
  108. mv $(PKG)/pkg/k8s/listers pkg/k8s
  109. rm -r github.com || true
  110. go fmt ./pkg/k8s/listers/...
  111. openapi: pkg/k8s/apis/kilo/v1alpha1/openapi_generated.go
  112. pkg/k8s/apis/kilo/v1alpha1/openapi_generated.go: pkg/k8s/apis/kilo/v1alpha1/types.go $(OPENAPI_GEN_BINARY)
  113. $(OPENAPI_GEN_BINARY) \
  114. --input-dirs $(PKG)/$(@D),k8s.io/apimachinery/pkg/apis/meta/v1,k8s.io/api/core/v1 \
  115. --output-base $(CURDIR) \
  116. --output-package ./$(@D) \
  117. --logtostderr \
  118. --report-filename /dev/null \
  119. --go-header-file=.header
  120. go fmt $@
  121. gen-docs: generate docs/api.md
  122. docs/api.md: pkg/k8s/apis/kilo/v1alpha1/types.go $(DOCS_GEN_BINARY)
  123. $(DOCS_GEN_BINARY) $< > $@
  124. $(BINS): $(SRC) go.mod
  125. @mkdir -p bin/$(word 2,$(subst /, ,$@))/$(word 3,$(subst /, ,$@))
  126. @echo "building: $@"
  127. @docker run --rm \
  128. -u $$(id -u):$$(id -g) \
  129. -v $$(pwd):/$(PROJECT) \
  130. -w /$(PROJECT) \
  131. $(BUILD_IMAGE) \
  132. /bin/sh -c " \
  133. GOARCH=$(word 3,$(subst /, ,$@)) \
  134. GOOS=$(word 2,$(subst /, ,$@)) \
  135. GOCACHE=/$(PROJECT)/.cache \
  136. CGO_ENABLED=0 \
  137. go build -mod=vendor -o $@ \
  138. $(LD_FLAGS) \
  139. ./cmd/$(@F)/... \
  140. "
  141. fmt:
  142. @echo $(GO_PKGS)
  143. gofmt -w -s $(GO_FILES)
  144. lint: header $(GOLINT_BINARY)
  145. @echo 'go vet $(GO_PKGS)'
  146. @vet_res=$$(GO111MODULE=on go vet -mod=vendor $(GO_PKGS) 2>&1); if [ -n "$$vet_res" ]; then \
  147. echo ""; \
  148. echo "Go vet found issues. Please check the reported issues"; \
  149. echo "and fix them if necessary before submitting the code for review:"; \
  150. echo "$$vet_res"; \
  151. exit 1; \
  152. fi
  153. @echo '$(GOLINT_BINARY) $(GO_PKGS)'
  154. @lint_res=$$($(GOLINT_BINARY) $(GO_PKGS)); if [ -n "$$lint_res" ]; then \
  155. echo ""; \
  156. echo "Golint found style issues. Please check the reported issues"; \
  157. echo "and fix them if necessary before submitting the code for review:"; \
  158. echo "$$lint_res"; \
  159. exit 1; \
  160. fi
  161. @echo 'gofmt -d -s $(GO_FILES)'
  162. @fmt_res=$$(gofmt -d -s $(GO_FILES)); if [ -n "$$fmt_res" ]; then \
  163. echo ""; \
  164. echo "Gofmt found style issues. Please check the reported issues"; \
  165. echo "and fix them if necessary before submitting the code for review:"; \
  166. echo "$$fmt_res"; \
  167. exit 1; \
  168. fi
  169. unit:
  170. go test -mod=vendor --race ./...
  171. test: lint unit
  172. header: .header
  173. @HEADER=$$(cat .header); \
  174. HEADER_LEN=$$(wc -l .header | awk '{print $$1}'); \
  175. FILES=; \
  176. for f in $(GO_FILES); do \
  177. for i in 0 1 2 3 4 5; do \
  178. FILE=$$(t=$$(mktemp) && tail -n +$$i $$f > $$t && head -n $$HEADER_LEN $$t | sed "s/[0-9]\{4\}/YEAR/"); \
  179. [ "$$FILE" = "$$HEADER" ] && continue 2; \
  180. done; \
  181. FILES="$$FILES$$f "; \
  182. done; \
  183. if [ -n "$$FILES" ]; then \
  184. printf 'the following files are missing the license header: %s\n' "$$FILES"; \
  185. exit 1; \
  186. fi
  187. tmp/help.txt: bin/$(OS)/$(ARCH)/kg
  188. mkdir -p tmp
  189. bin//$(OS)/$(ARCH)/kg --help 2>&1 | head -n -1 > $@
  190. docs/kg.md: $(EMBEDMD_BINARY) tmp/help.txt
  191. $(EMBEDMD_BINARY) -w $@
  192. website/docs/README.md: README.md
  193. rm -rf website/static/img/graphs
  194. find docs -type f -name '*.md' | xargs -I{} sh -c 'cat $(@D)/$$(basename {} .md) > website/{}'
  195. find docs -type f -name '*.md' | xargs -I{} sh -c 'cat {} >> website/{}'
  196. cat $(@D)/$$(basename $@ .md) > $@
  197. cat README.md >> $@
  198. cp -r docs/graphs website/static/img/
  199. sed -i 's/\.\/docs\///g' $@
  200. find $(@D) -type f -name '*.md' | xargs -I{} sed -i 's/\.\/\(.\+\.svg\)/\/img\/\1/g' {}
  201. sed -i 's/graphs\//\/img\/graphs\//g' $@
  202. website/build/index.html: website/docs/README.md docs/api.md
  203. yarn --cwd website install
  204. yarn --cwd website build
  205. container: .container-$(ARCH)-$(VERSION) container-name
  206. .container-$(ARCH)-$(VERSION): bin/linux/$(ARCH)/kg Dockerfile
  207. @i=0; for a in $(ALL_ARCH); do [ "$$a" = $(ARCH) ] && break; i=$$((i+1)); done; \
  208. ia=""; iv=""; \
  209. j=0; for a in $(DOCKER_ARCH); do \
  210. [ "$$i" -eq "$$j" ] && ia=$$(echo "$$a" | awk '{print $$1}') && iv=$$(echo "$$a" | awk '{print $$2}') && break; j=$$((j+1)); \
  211. done; \
  212. SHA=$$(docker manifest inspect $(BASE_IMAGE) | jq '.manifests[] | select(.platform.architecture == "'$$ia'") | if .platform | has("variant") then select(.platform.variant == "'$$iv'") else . end | .digest' -r); \
  213. docker build -t $(IMAGE):$(ARCH)-$(VERSION) --build-arg FROM=$(BASE_IMAGE)@$$SHA --build-arg GOARCH=$(ARCH) .
  214. @docker images -q $(IMAGE):$(ARCH)-$(VERSION) > $@
  215. container-latest: .container-$(ARCH)-$(VERSION)
  216. @docker tag $(IMAGE):$(ARCH)-$(VERSION) $(IMAGE):$(ARCH)-latest
  217. @echo "container: $(IMAGE):$(ARCH)-latest"
  218. container-name:
  219. @echo "container: $(IMAGE):$(ARCH)-$(VERSION)"
  220. manifest: .manifest-$(VERSION) manifest-name
  221. .manifest-$(VERSION): Dockerfile $(addprefix push-, $(ALL_ARCH))
  222. @docker manifest create --amend $(IMAGE):$(VERSION) $(addsuffix -$(VERSION), $(addprefix squat/$(PROJECT):, $(ALL_ARCH)))
  223. @$(MAKE) --no-print-directory manifest-annotate-$(VERSION)
  224. @docker manifest push $(IMAGE):$(VERSION) > $@
  225. manifest-latest: Dockerfile $(addprefix push-latest-, $(ALL_ARCH))
  226. @docker manifest create --amend $(IMAGE):latest $(addsuffix -latest, $(addprefix squat/$(PROJECT):, $(ALL_ARCH)))
  227. @$(MAKE) --no-print-directory manifest-annotate-latest
  228. @docker manifest push $(IMAGE):latest
  229. @echo "manifest: $(IMAGE):latest"
  230. manifest-annotate: manifest-annotate-$(VERSION)
  231. manifest-annotate-%:
  232. @i=0; \
  233. for a in $(ALL_ARCH); do \
  234. annotate=; \
  235. j=0; for da in $(DOCKER_ARCH); do \
  236. if [ "$$j" -eq "$$i" ] && [ -n "$$da" ]; then \
  237. annotate="docker manifest annotate $(IMAGE):$* $(IMAGE):$$a-$* --os linux --arch"; \
  238. k=0; for ea in $$da; do \
  239. [ "$$k" = 0 ] && annotate="$$annotate $$ea"; \
  240. [ "$$k" != 0 ] && annotate="$$annotate --variant $$ea"; \
  241. k=$$((k+1)); \
  242. done; \
  243. $$annotate; \
  244. fi; \
  245. j=$$((j+1)); \
  246. done; \
  247. i=$$((i+1)); \
  248. done
  249. manifest-name:
  250. @echo "manifest: $(IMAGE_ROOT):$(VERSION)"
  251. push: .push-$(ARCH)-$(VERSION) push-name
  252. .push-$(ARCH)-$(VERSION): .container-$(ARCH)-$(VERSION)
  253. @docker push $(REGISTRY)/$(IMAGE):$(ARCH)-$(VERSION)
  254. @docker images -q $(IMAGE):$(ARCH)-$(VERSION) > $@
  255. push-latest: container-latest
  256. @docker push $(REGISTRY)/$(IMAGE):$(ARCH)-latest
  257. @echo "pushed: $(IMAGE):$(ARCH)-latest"
  258. push-name:
  259. @echo "pushed: $(IMAGE):$(ARCH)-$(VERSION)"
  260. release: $(RELEASE_BINS)
  261. $(RELEASE_BINS):
  262. @make OS=$(word 2,$(subst -, ,$(@F))) ARCH=$(word 3,$(subst -, ,$(@F)))
  263. mkdir -p $(@D)
  264. cp bin/$(word 2,$(subst -, ,$(@F)))/$(word 3,$(subst -, ,$(@F)))/kgctl $@
  265. clean: container-clean bin-clean
  266. rm -rf .cache
  267. container-clean:
  268. rm -rf .container-* .manifest-* .push-*
  269. bin-clean:
  270. rm -rf bin
  271. vendor:
  272. go mod tidy
  273. go mod vendor
  274. $(CLIENT_GEN_BINARY):
  275. go build -mod=vendor -o $@ k8s.io/code-generator/cmd/client-gen
  276. $(DEEPCOPY_GEN_BINARY):
  277. go build -mod=vendor -o $@ k8s.io/code-generator/cmd/deepcopy-gen
  278. $(INFORMER_GEN_BINARY):
  279. go build -mod=vendor -o $@ k8s.io/code-generator/cmd/informer-gen
  280. $(LISTER_GEN_BINARY):
  281. go build -mod=vendor -o $@ k8s.io/code-generator/cmd/lister-gen
  282. $(OPENAPI_GEN_BINARY):
  283. go build -mod=vendor -o $@ k8s.io/kube-openapi/cmd/openapi-gen
  284. $(DOCS_GEN_BINARY): cmd/docs-gen/main.go
  285. go build -mod=vendor -o $@ ./cmd/docs-gen
  286. $(GOLINT_BINARY):
  287. go build -mod=vendor -o $@ golang.org/x/lint/golint
  288. $(EMBEDMD_BINARY):
  289. go build -mod=vendor -o $@ github.com/campoy/embedmd