7aa132ffc7
The man page namespace is global, so in order to avoid colliding with other man pages named "config.toml" rename ours to be more descriptive. This also helps with discoverability (now tab-completion of 'man containerd<tab>' will return the config man page), as well as making it much cleaner from the perspective of distributions that want to package containerd. Signed-off-by: Aleksa Sarai <asarai@suse.de>
257 lines
8.7 KiB
Makefile
257 lines
8.7 KiB
Makefile
# Copyright The containerd 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.
|
|
|
|
|
|
# Root directory of the project (absolute path).
|
|
ROOTDIR=$(dir $(abspath $(lastword $(MAKEFILE_LIST))))
|
|
|
|
# Base path used to install.
|
|
DESTDIR=/usr/local
|
|
|
|
# Used to populate variables in version package.
|
|
VERSION=$(shell git describe --match 'v[0-9]*' --dirty='.m' --always)
|
|
REVISION=$(shell git rev-parse HEAD)$(shell if ! git diff --no-ext-diff --quiet --exit-code; then echo .m; fi)
|
|
|
|
ifneq "$(strip $(shell command -v go 2>/dev/null))" ""
|
|
GOOS ?= $(shell go env GOOS)
|
|
GOARCH ?= $(shell go env GOARCH)
|
|
else
|
|
ifeq ($(GOOS),)
|
|
# approximate GOOS for the platform if we don't have Go and GOOS isn't
|
|
# set. We leave GOARCH unset, so that may need to be fixed.
|
|
ifeq ($(OS),Windows_NT)
|
|
GOOS = windows
|
|
else
|
|
UNAME_S := $(shell uname -s)
|
|
ifeq ($(UNAME_S),Linux)
|
|
GOOS = linux
|
|
endif
|
|
ifeq ($(UNAME_S),Darwin)
|
|
GOOS = darwin
|
|
endif
|
|
ifeq ($(UNAME_S),FreeBSD)
|
|
GOOS = freebsd
|
|
endif
|
|
endif
|
|
else
|
|
GOOS ?= $$GOOS
|
|
GOARCH ?= $$GOARCH
|
|
endif
|
|
endif
|
|
|
|
WHALE = "🇩"
|
|
ONI = "👹"
|
|
|
|
RELEASE=containerd-$(VERSION:v%=%).${GOOS}-${GOARCH}
|
|
|
|
PKG=github.com/containerd/containerd
|
|
|
|
# Project packages.
|
|
PACKAGES=$(shell go list ./... | grep -v /vendor/)
|
|
INTEGRATION_PACKAGE=${PKG}
|
|
TEST_REQUIRES_ROOT_PACKAGES=$(filter \
|
|
${PACKAGES}, \
|
|
$(shell \
|
|
for f in $$(git grep -l testutil.RequiresRoot | grep -v Makefile); do \
|
|
d="$$(dirname $$f)"; \
|
|
[ "$$d" = "." ] && echo "${PKG}" && continue; \
|
|
echo "${PKG}/$$d"; \
|
|
done | sort -u) \
|
|
)
|
|
|
|
# Project binaries.
|
|
COMMANDS=ctr containerd containerd-stress containerd-release
|
|
MANPAGES=ctr.1 containerd.1 containerd-config.1 containerd-config.toml.5
|
|
|
|
# Build tags seccomp and apparmor are needed by CRI plugin.
|
|
BUILDTAGS ?= seccomp apparmor
|
|
GO_TAGS=$(if $(BUILDTAGS),-tags "$(BUILDTAGS)",)
|
|
GO_LDFLAGS=-ldflags '-s -w -X $(PKG)/version.Version=$(VERSION) -X $(PKG)/version.Revision=$(REVISION) -X $(PKG)/version.Package=$(PKG) $(EXTRA_LDFLAGS)'
|
|
SHIM_GO_LDFLAGS=-ldflags '-s -w -X $(PKG)/version.Version=$(VERSION) -X $(PKG)/version.Revision=$(REVISION) -X $(PKG)/version.Package=$(PKG) -extldflags "-static"'
|
|
|
|
#Replaces ":" (*nix), ";" (windows) with newline for easy parsing
|
|
GOPATHS=$(shell echo ${GOPATH} | tr ":" "\n" | tr ";" "\n")
|
|
|
|
TESTFLAGS_RACE=
|
|
GO_BUILD_FLAGS=
|
|
# See Golang issue re: '-trimpath': https://github.com/golang/go/issues/13809
|
|
GO_GCFLAGS=$(shell \
|
|
set -- ${GOPATHS}; \
|
|
echo "-gcflags=-trimpath=$${1}/src"; \
|
|
)
|
|
|
|
#include platform specific makefile
|
|
-include Makefile.$(GOOS)
|
|
|
|
BINARIES=$(addprefix bin/,$(COMMANDS))
|
|
|
|
# Flags passed to `go test`
|
|
TESTFLAGS ?= -v $(TESTFLAGS_RACE)
|
|
TESTFLAGS_PARALLEL ?= 8
|
|
|
|
.PHONY: clean all AUTHORS build binaries test integration generate protos checkprotos coverage ci check help install uninstall vendor release mandir install-man
|
|
.DEFAULT: default
|
|
|
|
all: binaries
|
|
|
|
check: proto-fmt ## run all linters
|
|
@echo "$(WHALE) $@"
|
|
gometalinter --config .gometalinter.json ./...
|
|
|
|
ci: check binaries checkprotos coverage coverage-integration ## to be used by the CI
|
|
|
|
AUTHORS: .mailmap .git/HEAD
|
|
git log --format='%aN <%aE>' | sort -fu > $@
|
|
|
|
generate: protos
|
|
@echo "$(WHALE) $@"
|
|
@PATH=${ROOTDIR}/bin:${PATH} go generate -x ${PACKAGES}
|
|
|
|
protos: bin/protoc-gen-gogoctrd ## generate protobuf
|
|
@echo "$(WHALE) $@"
|
|
@PATH=${ROOTDIR}/bin:${PATH} protobuild --quiet ${PACKAGES}
|
|
|
|
check-protos: protos ## check if protobufs needs to be generated again
|
|
@echo "$(WHALE) $@"
|
|
@test -z "$$(git status --short | grep ".pb.go" | tee /dev/stderr)" || \
|
|
((git diff | cat) && \
|
|
(echo "$(ONI) please run 'make protos' when making changes to proto files" && false))
|
|
|
|
check-api-descriptors: protos ## check that protobuf changes aren't present.
|
|
@echo "$(WHALE) $@"
|
|
@test -z "$$(git status --short | grep ".pb.txt" | tee /dev/stderr)" || \
|
|
((git diff $$(find . -name '*.pb.txt') | cat) && \
|
|
(echo "$(ONI) please run 'make protos' when making changes to proto files and check-in the generated descriptor file changes" && false))
|
|
|
|
proto-fmt: ## check format of proto files
|
|
@echo "$(WHALE) $@"
|
|
@test -z "$$(find . -path ./vendor -prune -o -path ./protobuf/google/rpc -prune -o -name '*.proto' -type f -exec grep -Hn -e "^ " {} \; | tee /dev/stderr)" || \
|
|
(echo "$(ONI) please indent proto files with tabs only" && false)
|
|
@test -z "$$(find . -path ./vendor -prune -o -name '*.proto' -type f -exec grep -Hn "Meta meta = " {} \; | grep -v '(gogoproto.nullable) = false' | tee /dev/stderr)" || \
|
|
(echo "$(ONI) meta fields in proto files must have option (gogoproto.nullable) = false" && false)
|
|
|
|
build: ## build the go packages
|
|
@echo "$(WHALE) $@"
|
|
@go build ${GO_GCFLAGS} ${GO_BUILD_FLAGS} ${EXTRA_FLAGS} ${GO_LDFLAGS} ${PACKAGES}
|
|
|
|
test: ## run tests, except integration tests and tests that require root
|
|
@echo "$(WHALE) $@"
|
|
@go test ${TESTFLAGS} $(filter-out ${INTEGRATION_PACKAGE},${PACKAGES})
|
|
|
|
root-test: ## run tests, except integration tests
|
|
@echo "$(WHALE) $@"
|
|
@go test ${TESTFLAGS} $(filter-out ${INTEGRATION_PACKAGE},${TEST_REQUIRES_ROOT_PACKAGES}) -test.root
|
|
|
|
integration: ## run integration tests
|
|
@echo "$(WHALE) $@"
|
|
@go test ${TESTFLAGS} -test.root -parallel ${TESTFLAGS_PARALLEL}
|
|
|
|
benchmark: ## run benchmarks tests
|
|
@echo "$(WHALE) $@"
|
|
@go test ${TESTFLAGS} -bench . -run Benchmark -test.root
|
|
|
|
FORCE:
|
|
|
|
# Build a binary from a cmd.
|
|
bin/%: cmd/% FORCE
|
|
@echo "$(WHALE) $@${BINARY_SUFFIX}"
|
|
@go build ${GO_GCFLAGS} ${GO_BUILD_FLAGS} -o $@${BINARY_SUFFIX} ${GO_LDFLAGS} ${GO_TAGS} ./$<
|
|
|
|
bin/containerd-shim: cmd/containerd-shim FORCE # set !cgo and omit pie for a static shim build: https://github.com/golang/go/issues/17789#issuecomment-258542220
|
|
@echo "$(WHALE) bin/containerd-shim"
|
|
@CGO_ENABLED=0 go build ${GO_BUILD_FLAGS} -o bin/containerd-shim ${SHIM_GO_LDFLAGS} ${GO_TAGS} ./cmd/containerd-shim
|
|
|
|
bin/containerd-shim-runc-v1: cmd/containerd-shim-runc-v1 FORCE # set !cgo and omit pie for a static shim build: https://github.com/golang/go/issues/17789#issuecomment-258542220
|
|
@echo "$(WHALE) bin/containerd-shim-runc-v1"
|
|
@CGO_ENABLED=0 go build ${GO_BUILD_FLAGS} -o bin/containerd-shim-runc-v1 ${SHIM_GO_LDFLAGS} ${GO_TAGS} ./cmd/containerd-shim-runc-v1
|
|
|
|
binaries: $(BINARIES) ## build binaries
|
|
@echo "$(WHALE) $@"
|
|
|
|
man: mandir $(addprefix man/,$(MANPAGES))
|
|
@echo "$(WHALE) $@"
|
|
|
|
mandir:
|
|
@mkdir -p man
|
|
|
|
man/%: docs/man/%.md FORCE
|
|
@echo "$(WHALE) $<"
|
|
go-md2man -in "$<" -out "$@"
|
|
|
|
define installmanpage
|
|
mkdir -p $(DESTDIR)/man/man$(2);
|
|
gzip -c $(1) >$(DESTDIR)/man/man$(2)/$(3).gz;
|
|
endef
|
|
|
|
install-man:
|
|
@echo "$(WHALE) $@"
|
|
$(foreach manpage,$(addprefix man/,$(MANPAGES)), $(call installmanpage,$(manpage),$(subst .,,$(suffix $(manpage))),$(notdir $(manpage))))
|
|
|
|
release: $(BINARIES)
|
|
@echo "$(WHALE) $@"
|
|
@rm -rf releases/$(RELEASE) releases/$(RELEASE).tar.gz
|
|
@install -d releases/$(RELEASE)/bin
|
|
@install $(BINARIES) releases/$(RELEASE)/bin
|
|
@cd releases/$(RELEASE) && tar -czf ../$(RELEASE).tar.gz *
|
|
|
|
clean: ## clean up binaries
|
|
@echo "$(WHALE) $@"
|
|
@rm -f $(BINARIES)
|
|
|
|
install: ## install binaries
|
|
@echo "$(WHALE) $@ $(BINARIES)"
|
|
@mkdir -p $(DESTDIR)/bin
|
|
@install $(BINARIES) $(DESTDIR)/bin
|
|
|
|
uninstall:
|
|
@echo "$(WHALE) $@"
|
|
@rm -f $(addprefix $(DESTDIR)/bin/,$(notdir $(BINARIES)))
|
|
|
|
|
|
coverage: ## generate coverprofiles from the unit tests, except tests that require root
|
|
@echo "$(WHALE) $@"
|
|
@rm -f coverage.txt
|
|
@go test -i ${TESTFLAGS} $(filter-out ${INTEGRATION_PACKAGE},${PACKAGES}) 2> /dev/null
|
|
@( for pkg in $(filter-out ${INTEGRATION_PACKAGE},${PACKAGES}); do \
|
|
go test ${TESTFLAGS} \
|
|
-cover \
|
|
-coverprofile=profile.out \
|
|
-covermode=atomic $$pkg || exit; \
|
|
if [ -f profile.out ]; then \
|
|
cat profile.out >> coverage.txt; \
|
|
rm profile.out; \
|
|
fi; \
|
|
done )
|
|
|
|
root-coverage: ## generate coverage profiles for unit tests that require root
|
|
@echo "$(WHALE) $@"
|
|
@go test -i ${TESTFLAGS} $(filter-out ${INTEGRATION_PACKAGE},${TEST_REQUIRES_ROOT_PACKAGES}) 2> /dev/null
|
|
@( for pkg in $(filter-out ${INTEGRATION_PACKAGE},${TEST_REQUIRES_ROOT_PACKAGES}); do \
|
|
go test ${TESTFLAGS} \
|
|
-cover \
|
|
-coverprofile=profile.out \
|
|
-covermode=atomic $$pkg -test.root || exit; \
|
|
if [ -f profile.out ]; then \
|
|
cat profile.out >> coverage.txt; \
|
|
rm profile.out; \
|
|
fi; \
|
|
done )
|
|
|
|
vendor:
|
|
@echo "$(WHALE) $@"
|
|
@vndr
|
|
|
|
help: ## this help
|
|
@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort
|