mirror of
https://github.com/gravitational/teleport.git
synced 2026-11-02 06:08:23 +08:00
Alan Parra
0b76b44973
Change the proto layout of `api/` to a more standard setup, allowing the use of modern tools (like Buf) to format/lint (and maybe, one day, generate sources). The new layout looks like this: ``` api/ proto/ <- root of protos and proto imports teleport/ <- base package for Teleport protos (akin to "google/" or "gogoproto/") legacy/ <- root of "legacy" protos (most linters disabled) client/ proto/ types/ events/ webauthn/ wrappers/ ``` Non-legacy `api/` protos are expected to follow this layout: ``` api/ proto/ teleport/ mynewpackage/ <- package name v1/ <- protos explicitly versioned gen/ proto/ <- root for generated sources (multi-language possible, separate from hand-written code) go/ mynewpackage/ v1 <- generate Go sources go here. ``` Some outstanding issues, like lack of `go_package` declarations and non-standard import paths (`import "github.com/gravitational/teleport/.../some.proto"`) are fixed. Legacy protos still have irregular package declarations. It's possible to fix that, but it's a bit harder to reason about, as generated sources change in possibly-meaningful ways. Future iterations could change legacy packages to match the directory structure and apply a similar change to protos within lib/ packages, but this seems sufficient for a first step. * Add Buf to buildbox * Unify API protos under Buf * Fix proto generation * Reformat protos * Update generated protos * Generate protos using Buf * Appease linter * Review: make sure gogo protobuf versions are in sync * Clean leftovers from previous attempts * Fix operator/Makefile * Rename internal make gRPC targets to `*/host` * Sort `make fix-license` targets (nit)
173 lines
7.4 KiB
Makefile
173 lines
7.4 KiB
Makefile
# VERSION defines the project version for the bundle.
|
|
# Update this value when you upgrade the version of your project.
|
|
# To re-generate a bundle for another specific version without changing the standard setup, you can:
|
|
# - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
|
|
# - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
|
|
VERSION ?= 0.0.1
|
|
|
|
# CHANNELS define the bundle channels used in the bundle.
|
|
# Add a new line here if you would like to change its default config. (E.g CHANNELS = "candidate,fast,stable")
|
|
# To re-generate a bundle for other specific channels without changing the standard setup, you can:
|
|
# - use the CHANNELS as arg of the bundle target (e.g make bundle CHANNELS=candidate,fast,stable)
|
|
# - use environment variables to overwrite this value (e.g export CHANNELS="candidate,fast,stable")
|
|
ifneq ($(origin CHANNELS), undefined)
|
|
BUNDLE_CHANNELS := --channels=$(CHANNELS)
|
|
endif
|
|
|
|
# DEFAULT_CHANNEL defines the default channel used in the bundle.
|
|
# Add a new line here if you would like to change its default config. (E.g DEFAULT_CHANNEL = "stable")
|
|
# To re-generate a bundle for any other default channel without changing the default setup, you can:
|
|
# - use the DEFAULT_CHANNEL as arg of the bundle target (e.g make bundle DEFAULT_CHANNEL=stable)
|
|
# - use environment variables to overwrite this value (e.g export DEFAULT_CHANNEL="stable")
|
|
ifneq ($(origin DEFAULT_CHANNEL), undefined)
|
|
BUNDLE_DEFAULT_CHANNEL := --default-channel=$(DEFAULT_CHANNEL)
|
|
endif
|
|
BUNDLE_METADATA_OPTS ?= $(BUNDLE_CHANNELS) $(BUNDLE_DEFAULT_CHANNEL)
|
|
|
|
# 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
|
|
# teleport.dev/operator-bundle:$VERSION and teleport.dev/operator-catalog:$VERSION.
|
|
IMAGE_TAG_BASE ?= teleport.dev/operator
|
|
|
|
# BUNDLE_IMG defines the image:tag used for the bundle.
|
|
# You can use it as an arg. (E.g make bundle-build BUNDLE_IMG=<some-registry>/<project-name-bundle>:<tag>)
|
|
BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION)
|
|
|
|
# BUNDLE_GEN_FLAGS are the flags passed to the operator-sdk generate bundle command
|
|
BUNDLE_GEN_FLAGS ?= -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)
|
|
|
|
# USE_IMAGE_DIGESTS defines if images are resolved via tags or digests
|
|
# You can enable this value if you would like to use SHA Based Digests
|
|
# To enable set flag to true
|
|
USE_IMAGE_DIGESTS ?= false
|
|
ifeq ($(USE_IMAGE_DIGESTS), true)
|
|
BUNDLE_GEN_FLAGS += --use-image-digests
|
|
endif
|
|
|
|
# Image URL to use all building/pushing image targets
|
|
IMG ?= teleport-operator:latest
|
|
# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
|
|
ENVTEST_K8S_VERSION = 1.23
|
|
|
|
# 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
|
|
|
|
.PHONY: all
|
|
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
|
|
|
|
.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: crdgen
|
|
crdgen: ## Generate CRDs
|
|
make -C crdgen
|
|
|
|
.PHONY: manifests
|
|
manifests: crdgen controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
|
|
# Generate CRDs for apis/resources (custom generation through protoc plugin).
|
|
|
|
# The wrappers.proto file needed for this generator exist only inside the go mod cache,
|
|
# so we retrieve the file path for the cached proto files with go mod tools.
|
|
$(eval PROTOBUF_MOD_PATH := $(shell go mod download --json github.com/gogo/protobuf | awk -F: '/"Dir"/ { print $$2 }' | tr -d ' ",'))
|
|
$(eval CUSTOM_IMPORTS_TMP_DIR := $(shell mktemp -d))
|
|
mkdir -p $(CUSTOM_IMPORTS_TMP_DIR)/github.com/gravitational/teleport/api/proto/teleport/legacy/types/wrappers
|
|
cp ../api/proto/teleport/legacy/types/wrappers/wrappers.proto $(CUSTOM_IMPORTS_TMP_DIR)/github.com/gravitational/teleport/api/proto/teleport/legacy/types/wrappers
|
|
protoc \
|
|
-I=../api/proto \
|
|
-I=$(PROTOBUF_MOD_PATH) \
|
|
-I=$(CUSTOM_IMPORTS_TMP_DIR) \
|
|
--plugin=./crdgen/protoc-gen-crd \
|
|
--crd_out=:./config/crd/bases \
|
|
../api/proto/teleport/legacy/types/types.proto
|
|
rm -rf $(CUSTOM_IMPORTS_TMP_DIR)
|
|
|
|
cp ./config/crd/bases/* ./../examples/chart/teleport-cluster/charts/teleport-operator/templates/
|
|
# Some comments have `{{xyz}}` which triggers the golang templating engine when installing the chart.
|
|
# We don't want that, so we escape them.
|
|
sed -i 's/`{{/{{ `{{/g' ./../examples/chart/teleport-cluster/charts/teleport-operator/templates/*.yaml
|
|
sed -i 's/}}`/}}` }}/g' ./../examples/chart/teleport-cluster/charts/teleport-operator/templates/*.yaml
|
|
|
|
.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 crdgen-test ## Run tests.
|
|
KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test ./... -coverprofile cover.out
|
|
|
|
.PHONY: crdgen-test
|
|
crdgen-test: ## Run crdgen tests.
|
|
make -C crdgen test
|
|
|
|
##@ 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: ## Build docker image with the manager.
|
|
docker build -t ${IMG} .. -f ./Dockerfile
|
|
|
|
.PHONY: docker-push
|
|
docker-push: ## Push docker image with the manager.
|
|
docker push ${IMG}
|
|
|
|
##@ Build Dependencies
|
|
|
|
## Location to install dependencies to
|
|
LOCALBIN ?= $(shell pwd)/bin
|
|
$(LOCALBIN):
|
|
mkdir -p $(LOCALBIN)
|
|
|
|
## Tool Binaries
|
|
CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
|
|
ENVTEST ?= $(LOCALBIN)/setup-envtest
|
|
|
|
## Tool Versions
|
|
KUSTOMIZE_VERSION ?= v3.8.7
|
|
CONTROLLER_TOOLS_VERSION ?= v0.9.0
|
|
|
|
.PHONY: controller-gen
|
|
controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary.
|
|
$(CONTROLLER_GEN): $(LOCALBIN)
|
|
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)
|
|
GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
|