725 lines
31 KiB
Makefile
725 lines
31 KiB
Makefile
#!/bin/bash
|
|
#
|
|
# Copyright (c) 2019-2021 Red Hat, Inc.
|
|
# This program and the accompanying materials are made
|
|
# available under the terms of the Eclipse Public License 2.0
|
|
# which is available at https://www.eclipse.org/legal/epl-2.0/
|
|
#
|
|
# SPDX-License-Identifier: EPL-2.0
|
|
#
|
|
# Contributors:
|
|
# Red Hat, Inc. - initial API and implementation
|
|
#
|
|
|
|
# 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 ?= 1.0.2
|
|
|
|
ifeq (,$(shell which kubectl)$(shell which oc))
|
|
$(error oc or kubectl is required to proceed)
|
|
endif
|
|
|
|
ifneq (,$(shell which kubectl))
|
|
K8S_CLI := kubectl
|
|
else
|
|
K8S_CLI := oc
|
|
endif
|
|
|
|
# Detect image tool
|
|
ifneq (,$(shell which docker))
|
|
IMAGE_TOOL := docker
|
|
else
|
|
IMAGE_TOOL := podman
|
|
endif
|
|
|
|
ifndef VERBOSE
|
|
MAKEFLAGS += --silent
|
|
endif
|
|
|
|
ifeq ($(shell $(K8S_CLI) api-resources --api-group='route.openshift.io' 2>&1 | grep -o routes),routes)
|
|
PLATFORM := openshift
|
|
else
|
|
PLATFORM := kubernetes
|
|
endif
|
|
|
|
# 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 "[INFO] Downloading $(2)" ;\
|
|
GOBIN=$(PROJECT_DIR)/bin go get $(2) ;\
|
|
rm -rf $$TMP_DIR ;\
|
|
}
|
|
endef
|
|
|
|
mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))
|
|
mkfile_dir := $(dir $(mkfile_path))
|
|
|
|
# Default Eclipse Che operator image
|
|
IMG ?= quay.io/eclipse/che-operator:next
|
|
|
|
CONFIG_MANAGER="config/manager/manager.yaml"
|
|
|
|
INTERNAL_TMP_DIR=/tmp/che-operator-dev
|
|
BASH_ENV_FILE=$(INTERNAL_TMP_DIR)/bash.env
|
|
VSCODE_ENV_FILE=$(INTERNAL_TMP_DIR)/vscode.env
|
|
|
|
DEPLOYMENT_DIR=$(PROJECT_DIR)/deploy/deployment
|
|
|
|
ECLIPSE_CHE_NAMESPACE="eclipse-che"
|
|
ECLIPSE_CHE_PACKAGE_NAME="eclipse-che-preview-openshift"
|
|
|
|
CHECLUSTER_CR_PATH="$(PROJECT_DIR)/config/samples/org_v2_checluster.yaml"
|
|
CHECLUSTER_CRD_PATH="$(PROJECT_DIR)/config/crd/bases/org.eclipse.che_checlusters.yaml"
|
|
|
|
DEV_WORKSPACE_CONTROLLER_VERSION="v0.14.1"
|
|
DEV_HEADER_REWRITE_TRAEFIK_PLUGIN="main"
|
|
|
|
# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
|
|
ifeq (,$(shell go env GOBIN))
|
|
GOBIN=$(shell go env GOPATH)/bin
|
|
else
|
|
GOBIN=$(shell go 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.
|
|
.ONESHELL:
|
|
|
|
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%-25s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
|
|
|
|
##@ Development
|
|
|
|
update-dev-resources: SHELL := /bin/bash
|
|
update-dev-resources: validate-requirements ## Update all resources
|
|
# Update ubi8 image
|
|
ubiMinimal8Version=$$(skopeo --override-os linux inspect docker://registry.access.redhat.com/ubi8-minimal:latest | jq -r '.Labels.version')
|
|
ubiMinimal8Release=$$(skopeo --override-os linux inspect docker://registry.access.redhat.com/ubi8-minimal:latest | jq -r '.Labels.release')
|
|
UBI8_MINIMAL_IMAGE="registry.access.redhat.com/ubi8-minimal:$${ubiMinimal8Version}-$${ubiMinimal8Release}"
|
|
skopeo --override-os linux inspect docker://$${UBI8_MINIMAL_IMAGE} > /dev/null
|
|
echo "[INFO] UBI8 image $${UBI8_MINIMAL_IMAGE}"
|
|
|
|
# Dockerfile
|
|
sed -i 's|registry.access.redhat.com/ubi8-minimal:[^\s]* |'$${UBI8_MINIMAL_IMAGE}' |g' $(PROJECT_DIR)/Dockerfile
|
|
|
|
$(MAKE) update-rbac
|
|
$(MAKE) bundle CHANNEL=next
|
|
$(MAKE) gen-deployment
|
|
$(MAKE) update-helmcharts CHANNEL=next
|
|
$(MAKE) fmt
|
|
|
|
update-rbac: SHELL := /bin/bash
|
|
update-rbac:
|
|
CLUSTER_ROLES=(
|
|
https://raw.githubusercontent.com/devfile/devworkspace-operator/${DEV_WORKSPACE_CONTROLLER_VERSION}/deploy/deployment/openshift/objects/devworkspace-controller-view-workspaces.ClusterRole.yaml
|
|
https://raw.githubusercontent.com/devfile/devworkspace-operator/${DEV_WORKSPACE_CONTROLLER_VERSION}/deploy/deployment/openshift/objects/devworkspace-controller-edit-workspaces.ClusterRole.yaml
|
|
https://raw.githubusercontent.com/devfile/devworkspace-operator/${DEV_WORKSPACE_CONTROLLER_VERSION}/deploy/deployment/openshift/objects/devworkspace-controller-leader-election-role.Role.yaml
|
|
https://raw.githubusercontent.com/devfile/devworkspace-operator/${DEV_WORKSPACE_CONTROLLER_VERSION}/deploy/deployment/openshift/objects/devworkspace-controller-proxy-role.ClusterRole.yaml
|
|
https://raw.githubusercontent.com/devfile/devworkspace-operator/${DEV_WORKSPACE_CONTROLLER_VERSION}/deploy/deployment/openshift/objects/devworkspace-controller-role.ClusterRole.yaml
|
|
https://raw.githubusercontent.com/devfile/devworkspace-operator/${DEV_WORKSPACE_CONTROLLER_VERSION}/deploy/deployment/openshift/objects/devworkspace-controller-metrics-reader.ClusterRole.yaml
|
|
)
|
|
|
|
# Updates cluster_role.yaml based on DW roles
|
|
## Removes old cluster roles
|
|
cat config/rbac/cluster_role.yaml | sed '/CHE-OPERATOR ROLES ONLY: END/q0' > config/rbac/cluster_role.yaml.tmp
|
|
mv config/rbac/cluster_role.yaml.tmp config/rbac/cluster_role.yaml
|
|
|
|
# Copy new cluster roles
|
|
for roles in "$${CLUSTER_ROLES[@]}"; do
|
|
echo " # "$$(basename $$roles) >> config/rbac/cluster_role.yaml
|
|
|
|
CONTENT=$$(curl -sL $$roles | sed '1,/rules:/d')
|
|
while IFS= read -r line; do
|
|
echo " $$line" >> config/rbac/cluster_role.yaml
|
|
done <<< "$$CONTENT"
|
|
done
|
|
|
|
ROLES=(
|
|
# currently, there are no other roles we need to incorporate
|
|
)
|
|
|
|
# Updates role.yaml
|
|
## Removes old roles
|
|
cat config/rbac/role.yaml | sed '/CHE-OPERATOR ROLES ONLY: END/q0' > config/rbac/role.yaml.tmp
|
|
mv config/rbac/role.yaml.tmp config/rbac/role.yaml
|
|
|
|
## Copy new roles
|
|
for roles in "$${ROLES[@]}"; do
|
|
echo "# "$$(basename $$roles) >> config/rbac/role.yaml
|
|
|
|
CONTENT=$$(curl -sL $$roles | sed '1,/rules:/d')
|
|
while IFS= read -r line; do
|
|
echo "$$line" >> config/rbac/role.yaml
|
|
done <<< "$$CONTENT"
|
|
done
|
|
|
|
echo "[INFO] Updated config/rbac/role.yaml"
|
|
echo "[INFO] Updated config/rbac/cluster_role.yam"
|
|
|
|
update-helmcharts: SHELL := /bin/bash
|
|
update-helmcharts: ## Update Helm Charts
|
|
[[ -z "$(CHANNEL)" ]] && { echo [ERROR] CHANNEL not defined; exit 1; }
|
|
|
|
HELM_DIR=$(PROJECT_DIR)/helmcharts/$(CHANNEL)
|
|
HELMCHARTS_TEMPLATES=$${HELM_DIR}/templates
|
|
HELMCHARTS_CRDS=$${HELM_DIR}/crds
|
|
|
|
rm -rf $${HELMCHARTS_TEMPLATES} $${HELMCHARTS_CRDS}
|
|
mkdir -p $${HELMCHARTS_TEMPLATES} $${HELMCHARTS_CRDS}
|
|
|
|
rsync -a --exclude='checlusters.org.eclipse.che.CustomResourceDefinition.yaml' $(DEPLOYMENT_DIR)/kubernetes/objects/ $${HELMCHARTS_TEMPLATES}
|
|
cp $(DEPLOYMENT_DIR)/kubernetes/org_v2_checluster.yaml $${HELMCHARTS_TEMPLATES}
|
|
cp $(DEPLOYMENT_DIR)/kubernetes/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml $${HELMCHARTS_CRDS}
|
|
|
|
# Remove namespace since its creation is mentioned is README.md
|
|
rm $${HELMCHARTS_TEMPLATES}/eclipse-che.Namespace.yaml
|
|
|
|
if [ $(CHANNEL) == "stable" ]; then
|
|
chartYaml=$${HELM_DIR}/Chart.yaml
|
|
|
|
CRDS_SAMPLES_FILES=(
|
|
$${HELMCHARTS_TEMPLATES}/org_v2_checluster.yaml
|
|
)
|
|
|
|
CRDS_SAMPLES=""
|
|
for CRD_SAMPLE in "$${CRDS_SAMPLES_FILES[@]}"; do
|
|
CRD_SAMPLE=$$(cat $${CRD_SAMPLE} | yq -rY ". | (.metadata.namespace = \"$(ECLIPSE_CHE_NAMESPACE)\") | [.]")
|
|
CRDS_SAMPLES=$${CRDS_SAMPLES}$${CRD_SAMPLE}$$'\n'
|
|
done
|
|
|
|
yq -rYi --arg examples "$${CRDS_SAMPLES}" ".annotations.\"artifacthub.io/crdsExamples\" = \$$examples" $${chartYaml}
|
|
rm -rf $${HELMCHARTS_TEMPLATES}/org_v2_checluster.yaml
|
|
else
|
|
yq -riY '.spec.networking = null' $${HELMCHARTS_TEMPLATES}/org_v2_checluster.yaml
|
|
yq -riY '.spec.networking.tlsSecretName = "che-tls"' $${HELMCHARTS_TEMPLATES}/org_v2_checluster.yaml
|
|
yq -riY '.spec.networking.domain = "{{ .Values.networking.domain }}"' $${HELMCHARTS_TEMPLATES}/org_v2_checluster.yaml
|
|
yq -riY '.spec.networking.auth.oAuthSecret = "{{ .Values.networking.auth.oAuthSecret }}"' $${HELMCHARTS_TEMPLATES}/org_v2_checluster.yaml
|
|
yq -riY '.spec.networking.auth.oAuthClientName = "{{ .Values.networking.auth.oAuthClientName }}"' $${HELMCHARTS_TEMPLATES}/org_v2_checluster.yaml
|
|
yq -riY '.spec.networking.auth.identityProviderURL = "{{ .Values.networking.auth.identityProviderURL }}"' $${HELMCHARTS_TEMPLATES}/org_v2_checluster.yaml
|
|
fi
|
|
|
|
echo "[INFO] HelmCharts updated $${HELM_DIR}"
|
|
|
|
gen-deployment: SHELL := /bin/bash
|
|
gen-deployment: manifests download-kustomize _kustomize-operator-image ## Generate Eclipse Che k8s deployment resources
|
|
rm -rf $(DEPLOYMENT_DIR)
|
|
for TARGET_PLATFORM in kubernetes openshift; do
|
|
PLATFORM_DIR=$(DEPLOYMENT_DIR)/$${TARGET_PLATFORM}
|
|
OBJECTS_DIR=$${PLATFORM_DIR}/objects
|
|
|
|
mkdir -p $${OBJECTS_DIR}
|
|
|
|
COMBINED_FILENAME=$${PLATFORM_DIR}/combined.yaml
|
|
$(KUSTOMIZE) build config/$${TARGET_PLATFORM} | cat > $${COMBINED_FILENAME} -
|
|
|
|
# Split the giant files output by kustomize per-object
|
|
csplit -s -f "temp" --suppress-matched "$${COMBINED_FILENAME}" '/^---$$/' '{*}'
|
|
for file in temp??; do
|
|
name_kind=$$(yq -r '"\(.metadata.name).\(.kind)"' "$${file}")
|
|
mv "$${file}" "$${OBJECTS_DIR}/$${name_kind}.yaml"
|
|
done
|
|
cp $(PROJECT_DIR)/config/samples/org_v2_checluster.yaml $${PLATFORM_DIR}
|
|
|
|
echo "[INFO] Deployments resources generated into $${PLATFORM_DIR}"
|
|
done
|
|
|
|
gen-chectl-tmpl: SHELL := /bin/bash
|
|
gen-chectl-tmpl: ## Generate Eclipse Che k8s deployment resources used by chectl
|
|
[[ -z "$(TARGET)" ]] && { echo [ERROR] TARGET not defined; exit 1; }
|
|
[[ -z "$(SOURCE)" ]] && src=$(PROJECT_DIR) || src=$(SOURCE)
|
|
|
|
dst=$(TARGET)/che-operator && rm -rf $${dst}
|
|
|
|
if [[ -d "$${src}/deploy/deployment" ]]; then
|
|
# CheCluster API v2
|
|
src="$${src}/deploy/deployment"
|
|
|
|
for TARGET_PLATFORM in kubernetes openshift; do
|
|
mkdir -p "$${dst}/$${TARGET_PLATFORM}/crds"
|
|
|
|
cp $${src}/$${TARGET_PLATFORM}/objects/che-operator.Deployment.yaml $${dst}/$${TARGET_PLATFORM}/operator.yaml
|
|
|
|
cp $${src}/$${TARGET_PLATFORM}/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml $${dst}/$${TARGET_PLATFORM}/crds/org.eclipse.che_checlusters.yaml
|
|
cp $${src}/$${TARGET_PLATFORM}/org_v2_checluster.yaml $${dst}/$${TARGET_PLATFORM}/crds/org_checluster_cr.yaml
|
|
|
|
cp $${src}/$${TARGET_PLATFORM}/objects/che-operator.ServiceAccount.yaml $${dst}/$${TARGET_PLATFORM}/service_account.yaml
|
|
cp $${src}/$${TARGET_PLATFORM}/objects/che-operator.ClusterRoleBinding.yaml $${dst}/$${TARGET_PLATFORM}/cluster_rolebinding.yaml
|
|
cp $${src}/$${TARGET_PLATFORM}/objects/che-operator.ClusterRole.yaml $${dst}/$${TARGET_PLATFORM}/cluster_role.yaml
|
|
cp $${src}/$${TARGET_PLATFORM}/objects/che-operator.RoleBinding.yaml $${dst}/$${TARGET_PLATFORM}/role_binding.yaml
|
|
cp $${src}/$${TARGET_PLATFORM}/objects/che-operator.Role.yaml $${dst}/$${TARGET_PLATFORM}/role.yaml
|
|
|
|
cp $${src}/$${TARGET_PLATFORM}/objects/che-operator-service.Service.yaml $${dst}/$${TARGET_PLATFORM}/webhook-service.yaml
|
|
|
|
if [[ $${TARGET_PLATFORM} == "kubernetes" ]]; then
|
|
cp $${src}/$${TARGET_PLATFORM}/objects/che-operator-serving-cert.Certificate.yaml $${dst}/$${TARGET_PLATFORM}/serving-cert.yaml
|
|
cp $${src}/$${TARGET_PLATFORM}/objects/che-operator-selfsigned-issuer.Issuer.yaml $${dst}/$${TARGET_PLATFORM}/selfsigned-issuer.yaml
|
|
fi
|
|
done
|
|
else
|
|
# CheCluster API v1
|
|
mkdir -p $${dst}/crds
|
|
|
|
cp -f $${src}/config/manager/manager.yaml $${dst}/operator.yaml
|
|
|
|
cp -f $${src}/config/crd/bases/org_v1_che_crd.yaml $${dst}/crds
|
|
cp -f $${src}/config/samples/org.eclipse.che_v1_checluster.yaml $${dst}/crds/org_v1_che_cr.yaml
|
|
|
|
cp -f $${src}/config/rbac/role.yaml $${dst}
|
|
cp -f $${src}/config/rbac/role_binding.yaml $${dst}
|
|
cp -f $${src}/config/rbac/cluster_role.yaml $${dst}
|
|
cp -f $${src}/config/rbac/cluster_rolebinding.yaml $${dst}
|
|
cp -f $${src}/config/rbac/service_account.yaml $${dst}
|
|
fi
|
|
|
|
echo "[INFO] Generated chectl templates into $${dst}"
|
|
|
|
build: generate ## Build Eclipse Che operator binary
|
|
go build -o bin/manager main.go
|
|
|
|
run: SHELL := /bin/bash
|
|
run: generate manifests download-kustomize genenerate-env download-devworkspace-resources ## Run Eclipse Che operator
|
|
echo "[INFO] Running on $(PLATFORM)"
|
|
[[ $(PLATFORM) == "kubernetes" ]] && $(MAKE) install-certmgr
|
|
|
|
$(KUSTOMIZE) build config/$(PLATFORM) | $(K8S_CLI) apply -f -
|
|
$(MAKE) wait-pod-running COMPONENT=che-operator NAMESPACE=$(ECLIPSE_CHE_NAMESPACE)
|
|
|
|
$(K8S_CLI) scale deploy che-operator -n $(ECLIPSE_CHE_NAMESPACE) --replicas=0
|
|
$(MAKE) store_tls_cert
|
|
$(MAKE) create-checluster-cr
|
|
|
|
source $(BASH_ENV_FILE)
|
|
|
|
go run ./main.go
|
|
|
|
debug: SHELL := /bin/bash
|
|
debug: generate manifests download-kustomize genenerate-env download-devworkspace-resources ## Run and debug Eclipse Che operator
|
|
echo "[INFO] Running on $(PLATFORM)"
|
|
[[ $(PLATFORM) == "kubernetes" ]] && $(MAKE) install-certmgr
|
|
|
|
$(KUSTOMIZE) build config/$(PLATFORM) | $(K8S_CLI) apply -f -
|
|
$(MAKE) wait-pod-running COMPONENT=che-operator NAMESPACE=$(ECLIPSE_CHE_NAMESPACE)
|
|
|
|
$(K8S_CLI) scale deploy che-operator -n $(ECLIPSE_CHE_NAMESPACE) --replicas=0
|
|
$(MAKE) store_tls_cert
|
|
$(MAKE) create-checluster-cr
|
|
|
|
source $(BASH_ENV_FILE)
|
|
|
|
# dlv has an issue with 'Ctrl-C' termination, that's why we're doing trick with detach.
|
|
dlv debug --listen=:2345 --headless=true --api-version=2 ./main.go -- &
|
|
DLV_PID=$!
|
|
wait $${DLV_PID}
|
|
|
|
docker-build: ## Build Eclipse Che operator image
|
|
if [ "$(SKIP_TESTS)" = true ]; then
|
|
${IMAGE_TOOL} build -t ${IMG} --build-arg SKIP_TESTS=true .
|
|
else
|
|
${IMAGE_TOOL} build -t ${IMG} .
|
|
fi
|
|
|
|
docker-push: ## Push Eclipse Che operator image to a registry
|
|
${IMAGE_TOOL} push ${IMG}
|
|
|
|
manifests: download-controller-gen download-addlicense ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
|
|
$(CONTROLLER_GEN) crd:crdVersions=v1 rbac:roleName=manager-role paths="./..." output:crd:artifacts:config=config/crd/bases
|
|
|
|
# remove yaml delimitier, which makes OLM catalog source image broken.
|
|
sed -i '/---/d' "$(CHECLUSTER_CRD_PATH)"
|
|
|
|
$(MAKE) license $$(find ./config/crd -not -path "./vendor/*" -name "*.yaml")
|
|
|
|
generate: download-controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
|
|
$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
|
|
|
|
fmt: download-addlicense ## Run go fmt against code.
|
|
ifneq ($(shell command -v goimports 2> /dev/null),)
|
|
find . -not -path "./vendor/*" -name "*.go" -exec goimports -w {} \;
|
|
else
|
|
@echo "WARN: goimports is not installed -- formatting using go fmt instead."
|
|
@echo " Please install goimports to ensure file imports are consistent."
|
|
go fmt -x ./...
|
|
endif
|
|
|
|
FILES_TO_CHECK_LICENSE=$$(find . \
|
|
-not -path "./mocks/*" \
|
|
-not -path "./vendor/*" \
|
|
-not -path "./testbin/*" \
|
|
-not -path "./bundle/stable/*" \
|
|
-not -path "./config/manager/controller_manager_config.yaml" \
|
|
\( -name '*.sh' -o -name "*.go" -o -name "*.yaml" -o -name "*.yml" \))
|
|
|
|
$(MAKE) license $${FILES_TO_CHECK_LICENSE}
|
|
|
|
vet: ## Run go vet against code.
|
|
go vet ./...
|
|
|
|
ENVTEST_ASSETS_DIR=$(shell pwd)/testbin
|
|
test: download-devworkspace-resources ## Run tests.
|
|
export MOCK_API=true; go test -mod=vendor ./... -coverprofile cover.out
|
|
|
|
##@ Development utilities
|
|
|
|
license: ## Add license to the files
|
|
FILES=$$(echo $(filter-out $@,$(MAKECMDGOALS)))
|
|
$(ADD_LICENSE) -f hack/license-header.txt $${FILES}
|
|
|
|
genenerate-env: ## Generates environment files to use by bash and vscode
|
|
mkdir -p $(INTERNAL_TMP_DIR)
|
|
cat $(CONFIG_MANAGER) \
|
|
| yq -r \
|
|
'.spec.template.spec.containers[]
|
|
| select(.name=="che-operator")
|
|
| .env[]
|
|
| select(has("value"))
|
|
| "export \(.name)=\(.value)"' \
|
|
> $(BASH_ENV_FILE)
|
|
echo "export WATCH_NAMESPACE=$(ECLIPSE_CHE_NAMESPACE)" >> $(BASH_ENV_FILE)
|
|
echo "[INFO] Created $(BASH_ENV_FILE)"
|
|
|
|
cat $(CONFIG_MANAGER) \
|
|
| yq -r \
|
|
'.spec.template.spec.containers[]
|
|
| select(.name=="che-operator")
|
|
| .env[]
|
|
| select(has("value"))
|
|
| "\(.name)=\(.value)"' \
|
|
> $(VSCODE_ENV_FILE)
|
|
echo "WATCH_NAMESPACE=$(ECLIPSE_CHE_NAMESPACE)" >> $(VSCODE_ENV_FILE)
|
|
echo "[INFO] Created $(VSCODE_ENV_FILE)"
|
|
|
|
cat $(BASH_ENV_FILE)
|
|
|
|
install-certmgr: SHELL := /bin/bash
|
|
install-certmgr: ## Install Cert Manager v1.7.1
|
|
oc apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.7.1/cert-manager.yaml
|
|
$(MAKE) wait-pod-running COMPONENT=controller NAMESPACE=cert-manager
|
|
$(MAKE) wait-pod-running COMPONENT=cainjector NAMESPACE=cert-manager
|
|
$(MAKE) wait-pod-running COMPONENT=webhook NAMESPACE=cert-manager
|
|
|
|
download-devworkspace-resources: ## Downloads Dev Workspace resources
|
|
DEVWORKSPACE_RESOURCES=/tmp/devworkspace-operator/templates
|
|
GATEWAY_RESOURCES=/tmp/header-rewrite-traefik-plugin
|
|
|
|
rm -rf /tmp/devworkspace-operator.zip /tmp/devfile-devworkspace-operator-* $${DEVWORKSPACE_RESOURCES}
|
|
mkdir -p $${DEVWORKSPACE_RESOURCES}
|
|
curl -sL https://api.github.com/repos/devfile/devworkspace-operator/zipball/${DEV_WORKSPACE_CONTROLLER_VERSION} > /tmp/devworkspace-operator.zip
|
|
unzip -q /tmp/devworkspace-operator.zip '*/deploy/deployment/*' -d /tmp
|
|
cp -rf /tmp/devfile-devworkspace-operator*/deploy/* $${DEVWORKSPACE_RESOURCES}
|
|
|
|
echo "[INFO] DevWorkspace resources downloaded into $${DEVWORKSPACE_RESOURCES}"
|
|
|
|
rm -rf /tmp/asset-header-rewrite-traefik-plugin.zip /tmp/*-header-rewrite-traefik-plugin-*/ $${GATEWAY_RESOURCES}
|
|
mkdir -p $${GATEWAY_RESOURCES}
|
|
curl -sL https://api.github.com/repos/che-incubator/header-rewrite-traefik-plugin/zipball/${DEV_HEADER_REWRITE_TRAEFIK_PLUGIN} > /tmp/asset-header-rewrite-traefik-plugin.zip
|
|
unzip -q /tmp/asset-header-rewrite-traefik-plugin.zip -d /tmp
|
|
mv /tmp/*-header-rewrite-traefik-plugin-*/headerRewrite.go /tmp/*-header-rewrite-traefik-plugin-*/.traefik.yml $${GATEWAY_RESOURCES}
|
|
|
|
echo "[INFO] Gateway resources downloaded into $${GATEWAY_RESOURCES}"
|
|
|
|
setup-checluster: create-namespace create-checluster-crd create-checluster-cr ## Setup CheCluster (creates namespace, CRD and CheCluster CR)
|
|
|
|
create-namespace: ## Creates eclipse-che namespace
|
|
$(K8S_CLI) create namespace ${ECLIPSE_CHE_NAMESPACE} || true
|
|
|
|
create-checluster-crd: SHELL := /bin/bash
|
|
create-checluster-crd: ## Creates CheCluster Custom Resource Definition
|
|
if [[ $(PLATFORM) == "kubernetes" ]]; then
|
|
$(MAKE) install-certmgr
|
|
$(K8S_CLI) apply -f $(DEPLOYMENT_DIR)/$(PLATFORM)/objects/che-operator-selfsigned-issuer.Issuer.yaml
|
|
$(K8S_CLI) apply -f $(DEPLOYMENT_DIR)/$(PLATFORM)/objects/che-operator-serving-cert.Certificate.yaml
|
|
fi
|
|
$(K8S_CLI) apply -f $(DEPLOYMENT_DIR)/$(PLATFORM)/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml
|
|
|
|
create-checluster-cr: SHELL := /bin/bash
|
|
create-checluster-cr: ## Creates CheCluster Custom Resource V2
|
|
if [[ "$$($(K8S_CLI) get checluster eclipse-che -n $(ECLIPSE_CHE_NAMESPACE) || false )" ]]; then
|
|
echo "[INFO] CheCluster already exists."
|
|
else
|
|
CHECLUSTER_CR_2_APPLY=/tmp/checluster_cr.yaml
|
|
cp $(CHECLUSTER_CR_PATH) $${CHECLUSTER_CR_2_APPLY}
|
|
|
|
# Update networking.domain field with an actual value
|
|
if [[ $(PLATFORM) == "kubernetes" ]]; then
|
|
# kubectl does not have `whoami` command
|
|
CLUSTER_API_URL=$$(oc whoami --show-server=true) || true;
|
|
CLUSTER_DOMAIN=$$(echo $${CLUSTER_API_URL} | sed -E 's/https:\/\/(.*):.*/\1/g')
|
|
yq -riY '.spec.networking.domain = "'$${CLUSTER_DOMAIN}'.nip.io"' $${CHECLUSTER_CR_2_APPLY}
|
|
fi
|
|
$(K8S_CLI) apply -f $${CHECLUSTER_CR_2_APPLY} -n $(ECLIPSE_CHE_NAMESPACE)
|
|
fi
|
|
|
|
wait-pod-running: SHELL := /bin/bash
|
|
wait-pod-running: ## Wait until pod is up and running
|
|
[[ -z "$(COMPONENT)" ]] && { echo [ERROR] COMPONENT not defined; exit 1; }
|
|
[[ -z "$(NAMESPACE)" ]] && { echo [ERROR] NAMESPACE not defined; exit 1; }
|
|
|
|
while [ $$(oc get pod -l app.kubernetes.io/component=$(COMPONENT) -n $(NAMESPACE) -o go-template='{{len .items}}') -eq 0 ]; do
|
|
sleep 10s
|
|
done
|
|
oc wait --for=condition=ready pod -l app.kubernetes.io/component=$(COMPONENT) -n $(NAMESPACE) --timeout=120s
|
|
|
|
store_tls_cert: ## Store `che-operator-webhook-server-cert` secret locally
|
|
mkdir -p /tmp/k8s-webhook-server/serving-certs/
|
|
$(K8S_CLI) get secret che-operator-webhook-server-cert -n $(ECLIPSE_CHE_NAMESPACE) -o json | jq -r '.data["tls.crt"]' | base64 -d > /tmp/k8s-webhook-server/serving-certs/tls.crt
|
|
$(K8S_CLI) get secret che-operator-webhook-server-cert -n $(ECLIPSE_CHE_NAMESPACE) -o json | jq -r '.data["tls.key"]' | base64 -d > /tmp/k8s-webhook-server/serving-certs/tls.key
|
|
|
|
##@ Deployment
|
|
install: SHELL := /bin/bash
|
|
install: manifests download-kustomize _kustomize-operator-image ## Install Eclipse Che
|
|
echo "[INFO] Running on $(PLATFORM)"
|
|
[[ $(PLATFORM) == "kubernetes" ]] && $(MAKE) install-certmgr
|
|
|
|
$(KUSTOMIZE) build config/$(PLATFORM) | $(K8S_CLI) apply -f -
|
|
$(MAKE) wait-pod-running COMPONENT=che-operator NAMESPACE=${ECLIPSE_CHE_NAMESPACE}
|
|
$(MAKE) create-checluster-cr
|
|
|
|
# Printing logs
|
|
echo "[INFO] Waiting for Eclipse Che"
|
|
oc logs $$(oc get pods -o json -n ${ECLIPSE_CHE_NAMESPACE} | jq -r '.items[] | select(.metadata.name | test("che-operator-")).metadata.name') -n ${ECLIPSE_CHE_NAMESPACE} --all-containers -f
|
|
|
|
uninstall: ## Uninstall Eclipse Che
|
|
$(K8S_CLI) patch checluster eclipse-che -n ${ECLIPSE_CHE_NAMESPACE} --type json -p='[{"op": "remove", "path": "/metadata/finalizers"}]'
|
|
$(K8S_CLI) delete checluster eclipse-che -n ${ECLIPSE_CHE_NAMESPACE}
|
|
$(KUSTOMIZE) build config/$(PLATFORM) | $(K8S_CLI) delete -f -
|
|
|
|
.PHONY: bundle
|
|
bundle: SHELL := /bin/bash
|
|
bundle: generate manifests download-kustomize download-operator-sdk ## Generate OLM bundle
|
|
echo "[INFO] Updating OperatorHub bundle"
|
|
|
|
[[ -z "$(CHANNEL)" ]] && { echo [ERROR] CHANNEL not defined; exit 1; }
|
|
[[ "$(INCREMENT_BUNDLE_VERSION)" == false ]] || $(MAKE) _increment-bundle-version
|
|
|
|
BUNDLE_PATH=$$($(MAKE) bundle-path)
|
|
CSV_PATH=$$($(MAKE) csv-path)
|
|
NEXT_BUNDLE_VERSION=$$($(MAKE) bundle-version)
|
|
NEXT_BUNDLE_CREATION_DATE=$$(yq -r ".metadata.annotations.createdAt" "$${CSV_PATH}")
|
|
|
|
# Build default clusterserviceversion file
|
|
$(OPERATOR_SDK) generate kustomize manifests
|
|
|
|
$(KUSTOMIZE) build config/openshift/olm | \
|
|
$(OPERATOR_SDK) generate bundle \
|
|
--quiet \
|
|
--overwrite \
|
|
--version $${NEXT_BUNDLE_VERSION} \
|
|
--package $(ECLIPSE_CHE_PACKAGE_NAME) \
|
|
--output-dir $${BUNDLE_PATH} \
|
|
--channels $(CHANNEL) \
|
|
--default-channel $(CHANNEL)
|
|
|
|
# Remove service from the bundle since OLM create that itself
|
|
rm $${BUNDLE_PATH}/manifests/che-operator-service_v1_service.yaml
|
|
|
|
# Rename clusterserviceversion file
|
|
mv $${BUNDLE_PATH}/manifests/$(ECLIPSE_CHE_PACKAGE_NAME).clusterserviceversion.yaml $${CSV_PATH}
|
|
|
|
# Rollback creation date if version is not incremented
|
|
if [[ "$(INCREMENT_BUNDLE_VERSION)" == false ]]; then
|
|
sed -i "s/createdAt:.*$$/createdAt: \"$${NEXT_BUNDLE_CREATION_DATE}\"/" "$${CSV_PATH}"
|
|
fi
|
|
|
|
# Copy bundle.Dockerfile to the bundle dir
|
|
# Update paths (since it is created in the root of the project) and labels
|
|
mv bundle.Dockerfile $${BUNDLE_PATH}
|
|
sed -i 's|$(PROJECT_DIR)/bundle/$(CHANNEL)/eclipse-che-preview-openshift/||' $${BUNDLE_PATH}/bundle.Dockerfile
|
|
printf "\nLABEL com.redhat.openshift.versions=\"v4.8\"" >> $${BUNDLE_PATH}/bundle.Dockerfile
|
|
|
|
# Update annotations.yaml correspondingly to bundle.Dockerfile
|
|
printf "\n com.redhat.openshift.versions: \"v4.8\"" >> $${BUNDLE_PATH}/metadata/annotations.yaml
|
|
|
|
# Base cluster service version file has got correctly sorted CRDs.
|
|
# They are sorted with help of annotation markers in the api type files ("api/v1" folder).
|
|
# Example such annotation: +operator-sdk:csv:customresourcedefinitions:order=0
|
|
# Copy this sorted CRDs to the bundle clusterserviceversion file.
|
|
CRDS_OWNED=$$(yq '.spec.customresourcedefinitions.owned' "$(PROJECT_DIR)/config/manifests/bases/che-operator.clusterserviceversion.yaml")
|
|
yq -riSY ".spec.customresourcedefinitions.owned = $${CRDS_OWNED}" "$${CSV_PATH}"
|
|
|
|
# Kustomize won't set default values
|
|
# Update deployment explicitly
|
|
yq -riSY '(.spec.install.spec.deployments[0].spec.template.spec."hostIPC") = false' "$${CSV_PATH}"
|
|
yq -riSY '(.spec.install.spec.deployments[0].spec.template.spec."hostNetwork") = false' "$${CSV_PATH}"
|
|
yq -riSY '(.spec.install.spec.deployments[0].spec.template.spec."hostPID") = false' "$${CSV_PATH}"
|
|
yq -riSY '(.spec.install.spec.deployments[0].spec.template.spec.containers[0].securityContext."allowPrivilegeEscalation") = false' "$${CSV_PATH}"
|
|
yq -riSY '(.spec.install.spec.deployments[0].spec.template.spec.containers[0].securityContext."runAsNonRoot") = true' "$${CSV_PATH}"
|
|
|
|
# Fix examples by removing some special characters
|
|
FIXED_ALM_EXAMPLES=$$(yq -r '.metadata.annotations["alm-examples"]' $${CSV_PATH} | sed -r 's/"/\\"/g')
|
|
yq -riY ".metadata.annotations[\"alm-examples\"] = \"$${FIXED_ALM_EXAMPLES}\"" $${CSV_PATH}
|
|
|
|
# Update image
|
|
yq -riY '.metadata.annotations.containerImage = "'$(IMG)'"' $${CSV_PATH}
|
|
yq -riY '.spec.install.spec.deployments[0].spec.template.spec.containers[0].image = "'$(IMG)'"' $${CSV_PATH}
|
|
|
|
# Format file
|
|
yq -riY "." "$${BUNDLE_PATH}/manifests/org.eclipse.che_checlusters.yaml"
|
|
|
|
$(MAKE) license $$(find $${BUNDLE_PATH} -name "*.yaml")
|
|
|
|
$(OPERATOR_SDK) bundle validate $${BUNDLE_PATH}
|
|
|
|
.PHONY: bundle-build
|
|
bundle-build: SHELL := /bin/bash
|
|
bundle-build: ## Build a bundle image
|
|
[[ -z "$(CHANNEL)" ]] && { echo [ERROR] CHANNEL not defined; exit 1; }
|
|
[[ -z "$(BUNDLE_IMG)" ]] && { echo [ERROR] BUNDLE_IMG not defined; exit 1; }
|
|
|
|
BUNDLE_DIR="$(PROJECT_DIR)/bundle/$(CHANNEL)/$(ECLIPSE_CHE_PACKAGE_NAME)"
|
|
pushd $${BUNDLE_DIR}
|
|
$(IMAGE_TOOL) build -f bundle.Dockerfile -t $(BUNDLE_IMG) .
|
|
popd
|
|
|
|
.PHONY: bundle-push
|
|
bundle-push: SHELL := /bin/bash
|
|
bundle-push: ## Push a bundle image
|
|
[[ -z "$(BUNDLE_IMG)" ]] && { echo [ERROR] BUNDLE_IMG not defined; exit 1; }
|
|
$(MAKE) docker-push IMG=$(BUNDLE_IMG)
|
|
|
|
# Build a catalog image by adding bundle images to an empty catalog using the operator package manager tool, 'opm'.
|
|
# This recipe invokes 'opm' in 'semver' bundle add mode. For more information on add modes, see:
|
|
# https://github.com/operator-framework/community-operators/blob/7f1438c/docs/packaging-operator.md#updating-your-existing-operator
|
|
.PHONY: catalog-build
|
|
catalog-build: SHELL := /bin/bash
|
|
catalog-build: download-opm ## Build a catalog image
|
|
[[ -z "$(BUNDLE_IMG)" ]] && { echo [ERROR] BUNDLE_IMG not defined; exit 1; }
|
|
[[ -z "$(CATALOG_IMG)" ]] && { echo [ERROR] CATALOG_IMG not defined; exit 1; }
|
|
|
|
$(OPM) index add \
|
|
--build-tool $(IMAGE_TOOL) \
|
|
--bundles $(BUNDLE_IMG) \
|
|
--tag $(CATALOG_IMG) \
|
|
--pull-tool $(IMAGE_TOOL) \
|
|
--binary-image=quay.io/operator-framework/upstream-opm-builder:v1.15.2 \
|
|
--mode semver $(FROM_INDEX_OPT)
|
|
|
|
.PHONY: catalog-push
|
|
catalog-push: SHELL := /bin/bash
|
|
catalog-push: ## Push a catalog image
|
|
[[ -z "$(CATALOG_IMG)" ]] && { echo [ERROR] CATALOG_IMG not defined; exit 1; }
|
|
$(MAKE) docker-push IMG=$(CATALOG_IMG)
|
|
|
|
##@ Utilities
|
|
|
|
bundle-path: SHELL := /bin/bash
|
|
bundle-path: ## Prints path to a bundle directory for a given channel
|
|
[[ -z "$(CHANNEL)" ]] && { echo [ERROR] CHANNEL not defined; exit 1; }
|
|
echo "$(PROJECT_DIR)/bundle/$(CHANNEL)/$(ECLIPSE_CHE_PACKAGE_NAME)"
|
|
|
|
csv-path: SHELL := /bin/bash
|
|
csv-path: ## Prints path to a clusterserviceversion file for a given channel
|
|
[[ -z "$(CHANNEL)" ]] && { echo [ERROR] CHANNEL not defined; exit 1; }
|
|
BUNDLE_PATH=$$($(MAKE) bundle-path)
|
|
echo "$${BUNDLE_PATH}/manifests/che-operator.clusterserviceversion.yaml"
|
|
|
|
bundle-version: SHELL := /bin/bash
|
|
bundle-version: ## Prints a bundle version for a given channel
|
|
[[ -z "$(CHANNEL)" ]] && { echo [ERROR] CHANNEL not defined; exit 1; }
|
|
CSV_PATH=$$($(MAKE) csv-path)
|
|
echo $$(yq -r ".spec.version" "$${CSV_PATH}")
|
|
|
|
OPM ?= $(shell pwd)/bin/opm
|
|
download-opm: ## Download opm tool
|
|
command -v $(OPM) >/dev/null 2>&1 && exit
|
|
|
|
OS=$(shell go env GOOS)
|
|
ARCH=$(shell go env GOARCH)
|
|
OPM_VERSION=$$(yq -r '.opm' $(PROJECT_DIR)/REQUIREMENTS)
|
|
|
|
echo "[INFO] Downloading opm version: $${OPM_VERSION}"
|
|
|
|
mkdir -p $$(dirname "$(OPM)")
|
|
curl -sL https://github.com/operator-framework/operator-registry/releases/download/$${OPM_VERSION}/$${OS}-$${ARCH}-opm > $(OPM)
|
|
chmod +x $(OPM)
|
|
|
|
CONTROLLER_GEN = $(shell pwd)/bin/controller-gen
|
|
download-controller-gen: ## Download controller-gen tool
|
|
$(call go-get-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen@v0.4.1)
|
|
|
|
KUSTOMIZE = $(shell pwd)/bin/kustomize
|
|
download-kustomize: ## Download kustomize tool
|
|
$(call go-get-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v3@v3.8.7)
|
|
|
|
ADD_LICENSE = $(shell pwd)/bin/addlicense
|
|
download-addlicense: ## Download addlicense tool
|
|
$(call go-get-tool,$(ADD_LICENSE),github.com/google/addlicense@99ebc9c9db7bceb8623073e894533b978d7b7c8a)
|
|
|
|
OPERATOR_SDK ?= $(shell pwd)/bin/operator-sdk
|
|
download-operator-sdk: SHELL := /bin/bash
|
|
download-operator-sdk: ## Downloads operator sdk tool
|
|
command -v $(OPERATOR_SDK) >/dev/null 2>&1 && exit
|
|
|
|
OS=$(shell go env GOOS)
|
|
ARCH=$(shell go env GOARCH)
|
|
OPERATOR_SDK_VERSION=$$(yq -r '."operator-sdk"' $(PROJECT_DIR)/REQUIREMENTS)
|
|
|
|
[[ -z "$(DEST)" ]] && dest=$(OPERATOR_SDK) || dest=$(DEST)/$(OPERATOR_SDK)
|
|
echo "[INFO] Downloading operator-sdk version $$OPERATOR_SDK_VERSION into $${dest}"
|
|
|
|
mkdir -p $$(dirname "$${dest}")
|
|
curl -sL https://github.com/operator-framework/operator-sdk/releases/download/$${OPERATOR_SDK_VERSION}/operator-sdk_$${OS}_$${ARCH} > $${dest}
|
|
chmod +x $${dest}
|
|
|
|
validate-requirements: SHELL := /bin/bash
|
|
validate-requirements: ## Check if all required packages are installed
|
|
command -v yq >/dev/null 2>&1 || { echo "[ERROR] yq is not installed. See https://github.com/kislyuk/yq"; exit 1; }
|
|
command -v skopeo >/dev/null 2>&1 || { echo "[ERROR] skopeo is not installed."; exit 1; }
|
|
|
|
# Set a new operator image for kustomize
|
|
_kustomize-operator-image:
|
|
cd config/manager
|
|
$(KUSTOMIZE) edit set image quay.io/eclipse/che-operator:next=$(IMG)
|
|
cd ../..
|
|
|
|
# Set a new version for the next channel
|
|
_increment-bundle-version: SHELL := /bin/bash
|
|
_increment-bundle-version:
|
|
echo "[INFO] Increment bundle version for the next channel"
|
|
|
|
STABLE_BUNDLE_VERSION=$$($(MAKE) bundle-version CHANNEL=stable)
|
|
echo "[INFO] Current stable version: $${STABLE_BUNDLE_VERSION}"
|
|
|
|
# Parse stable bundle version
|
|
STABLE_BUNDLE_MAJOR_AND_MINOR_VERSION=$${STABLE_BUNDLE_VERSION%.*}
|
|
STABLE_BUNDLE_MINOR_VERSION=$${STABLE_BUNDLE_MAJOR_AND_MINOR_VERSION#*.}
|
|
STABLE_BUNDLE_MAJOR_VERSION=$${STABLE_BUNDLE_MAJOR_AND_MINOR_VERSION%.*}
|
|
|
|
NEXT_BUNDLE_VERSION=$$($(MAKE) bundle-version CHANNEL=next)
|
|
echo "[INFO] Current next version: $${NEXT_BUNDLE_VERSION}"
|
|
|
|
# Parse next bundle version
|
|
NEXT_BUNDLE_VERSION_STIPPED_NEXT="$${NEXT_BUNDLE_VERSION%.next*}"
|
|
NEXT_BUNDLE_VERSION_INCRIMENT_PART="$${NEXT_BUNDLE_VERSION_STIPPED_NEXT#*-}"
|
|
|
|
# Set a new next bundle version
|
|
NEW_NEXT_BUNDLE_VERSION="$${STABLE_BUNDLE_MAJOR_VERSION}.$$(($$STABLE_BUNDLE_MINOR_VERSION+1)).0-$$(($$NEXT_BUNDLE_VERSION_INCRIMENT_PART+1)).next"
|
|
|
|
# Update csv
|
|
NEXT_CSV_PATH=$$($(MAKE) csv-path CHANNEL=next)
|
|
yq -riY "(.spec.version) = \"$${NEW_NEXT_BUNDLE_VERSION}\" | (.metadata.name) = \"$(ECLIPSE_CHE_PACKAGE_NAME).v$${NEW_NEXT_BUNDLE_VERSION}\"" $${NEXT_CSV_PATH}
|
|
|
|
echo "[INFO] New next version: $${NEW_NEXT_BUNDLE_VERSION}"
|