feature: Make targets for debugging services and operators

Adds a new Make target which triggers build in the underlying services
and operators which end up building the images without any code
optimizations and with Delve on them.

Once pushed and deployed to the local OpenShift cluster, it patches the
host operator, the member operator and the registration service to
launch them with the Delve executable, which allows debugging them on
port 50000 after port-forwarding to those pods.

SANDBOX-1561

Author: MikelAlejoBR

README.adoc

@@ -151,6 +151,14 @@ All e2e resources (host operator, member operator, registration-service, CRDs, e
 
 * `make dev-deploy-e2e-local` - deploys the same resources as `make test-e2e-local` in dev environment but doesn't run tests.
 
+* `make dev-deploy-e2e-local-debug` - deploys the same resources as `make test-e2e-local` in the local OpenShift
+instance, but builds the services and the operators without any code optimizations. It also ships Delve in the images,
+and launches those services with it, which leaves the debugger listening on port `50000`. Then, you can simply `oc
+port-forward ${POD} 50000:50000` and connect to them with your favorite IDE. The services that are built like that are:
+** The registration service.
+** The host operator controller manager.
+** The member operator controller manager.
+
 * `make dev-deploy-e2e` - deploys the same resources as `make test-e2e` in dev environment but doesn't run tests.
 
 * `make deploy-single-member-e2e-latest` - deploys the same resources (using the latest and greatest images of Toolchain operators) as `make test-e2e` but with only one member and doesn't run tests.

make/dev.mk

@@ -39,6 +39,36 @@ setup-dev-sso:
 .PHONY: dev-deploy-e2e-local
 dev-deploy-e2e-local: deploy-e2e-local-to-dev-namespaces print-reg-service-link
 
+# Builds the services' and operators' images with the debugger in it, so that
+# then an IDE can be connected to them. Since the targets down the line use
+# the default namespaces, we can use them to patch the required CRs in order
+# to launch the binaries with Delve.
+.ONESHELL:
+.PHONY: dev-deploy-e2e-local-debug
+dev-deploy-e2e-local-debug: export DEBUG_MODE=true
+dev-deploy-e2e-local-debug:
+	$(MAKE) dev-deploy-e2e-local
+
+	# Get the CSVs for the host and member operators, in order to be able to
+	# patch them.
+	HOST_CSV_NAME=$$(oc get --namespace "${DEFAULT_HOST_NS}" --output name ClusterServiceVersion)
+	MEMBER_CSV_NAME=$$(oc get --namespace ${DEFAULT_MEMBER_NS} --output name ClusterServiceVersion)
+
+	# Patch the host operator indicating which command the registration
+	# service should be run with. The command simply adds an environment
+	# variable to the operator which then makes sure that the registration
+	# service is run with Delve, in case the user wants to connect to it.
+	oc patch --namespace "${DEFAULT_HOST_NS}" "${HOST_CSV_NAME}" --type='json' --patch='[{"op": "add", "path": "/spec/install/spec/deployments/0/spec/template/spec/containers/1/env/-", "value": {"name": "REGISTRATION_SERVICE_COMMAND", "value": "[\"dlv\", \"--listen=:50000\", \"--headless\", \"--continue\", \"--api-version=2\", \"--accept-multiclient\", \"exec\", \"/usr/local/bin/registration-service\"]"}}]' || true
+
+	# Reduce the registration service's replicas to 1, in order to facilitate
+	# the port forwarding and debugging of the service.
+	oc patch --namespace "${DEFAULT_HOST_NS}" ToolchainConfig config --type='merge' --patch='{"spec":{"host":{"registrationService":{"replicas":1}}}}'
+
+	# Patch the host-operator and member-operator CSVs to make them run with
+	# Delve.
+	oc patch --namespace "${DEFAULT_HOST_NS}" "${HOST_CSV_NAME}" --type='json' --patch='[{"op": "replace", "path": "/spec/install/spec/deployments/0/spec/template/spec/containers/1/args", "value": []}, {"op": "replace", "path": "/spec/install/spec/deployments/0/spec/template/spec/containers/1/command", "value": ["dlv", "--listen=:50000", "--headless", "--continue", "--api-version=2", "--accept-multiclient", "exec", "/usr/local/bin/host-operator", "--", "--health-probe-bind-address=:8081", "--metrics-bind-address=127.0.0.1:8080", "--leader-elect"]}]'
+	oc patch --namespace "${DEFAULT_MEMBER_NS}" "${MEMBER_CSV_NAME}" --type='json' --patch='[{"op": "replace", "path": "/spec/install/spec/deployments/0/spec/template/spec/containers/0/args", "value": []}, {"op": "replace", "path": "/spec/install/spec/deployments/0/spec/template/spec/containers/0/command", "value": ["dlv", "--listen=:50000", "--headless", "--continue", "--api-version=2", "--accept-multiclient", "exec", "/usr/local/bin/member-operator", "--", "--health-probe-bind-address=:8081", "--metrics-bind-address=127.0.0.1:8080", "--leader-elect"]}]'
+
 .PHONY: dev-deploy-e2e-local-two-members
 dev-deploy-e2e-local-two-members: deploy-e2e-local-to-dev-namespaces-two-members print-reg-service-link
 

scripts/ci/manage-host-operator.sh

@@ -96,7 +96,7 @@ if [[ -n "${CI}${REG_REPO_PATH}${HOST_REPO_PATH}" ]] && [[ $(echo ${REPO_NAME} |
     set_tags
 
     if [[ ${PUBLISH_OPERATOR} == "true" ]]; then
-        push_image
+        push_image "${DEBUG_MODE}"
         REG_SERV_IMAGE_LOC=${IMAGE_LOC}
         REG_REPO_PATH=${REPOSITORY_PATH}
     fi
@@ -108,7 +108,7 @@ if [[ -n "${CI}${REG_REPO_PATH}${HOST_REPO_PATH}" ]] && [[ $(echo ${REPO_NAME} |
     set_tags
 
     if [[ ${PUBLISH_OPERATOR} == "true" ]]; then
-        push_image
+        push_image "${DEBUG_MODE}"
         OPERATOR_IMAGE_LOC=${IMAGE_LOC}
         make -C ${REPOSITORY_PATH} publish-current-bundle INDEX_IMAGE_TAG=${BUNDLE_AND_INDEX_TAG} BUNDLE_TAG=${BUNDLE_AND_INDEX_TAG} QUAY_NAMESPACE=${QUAY_NAMESPACE} OTHER_REPO_PATH=${REG_REPO_PATH} OTHER_REPO_IMAGE_LOC=${REG_SERV_IMAGE_LOC} IMAGE=${OPERATOR_IMAGE_LOC}
     fi

scripts/ci/manage-member-operator.sh

@@ -95,7 +95,7 @@ if [[ -n "${CI}${MEMBER_REPO_PATH}" ]] && [[ $(echo ${REPO_NAME} | sed 's/"//g')
     set_tags
 
     if [[ ${PUBLISH_OPERATOR} == "true" ]]; then
-        push_image
+        push_image "${DEBUG_MODE}"
 
         OPERATOR_IMAGE_LOC=${IMAGE_LOC}
         make -C ${REPOSITORY_PATH} publish-current-bundle INDEX_IMAGE_TAG=${BUNDLE_AND_INDEX_TAG} BUNDLE_TAG=${BUNDLE_AND_INDEX_TAG} QUAY_NAMESPACE=${QUAY_NAMESPACE} IMAGE=${OPERATOR_IMAGE_LOC}

scripts/ci/manage-operator.sh

@@ -45,11 +45,18 @@ set_tags() {
 }
 
 push_image() {
+    # When the "${DEBUG_MODE}" argument is passed, we instruct Make to push
+    # the "debug" images with Delve on them.
+    if [[ $1 == "true" ]]; then
+      DEBUG_MODE_SUFFIX="-debug"
+    else
+      DEBUG_MODE_SUFFIX=""
+    fi
+
     GIT_COMMIT_ID=$(git --git-dir=${REPOSITORY_PATH}/.git --work-tree=${REPOSITORY_PATH} rev-parse --short HEAD)
     IMAGE_LOC=quay.io/codeready-toolchain/${REPOSITORY_NAME}:${GIT_COMMIT_ID}
     if is_provided_or_paired; then
-        IMAGE_BUILDER=${IMAGE_BUILDER:-"podman"}
-        make -C ${REPOSITORY_PATH} ${IMAGE_BUILDER}-push QUAY_NAMESPACE=${QUAY_NAMESPACE} IMAGE_TAG=${TAGS}
+        make -C ${REPOSITORY_PATH} ${IMAGE_BUILDER}-push${DEBUG_MODE_SUFFIX} QUAY_NAMESPACE=${QUAY_NAMESPACE} IMAGE_TAG=${TAGS}
         IMAGE_LOC=quay.io/${QUAY_NAMESPACE}/${REPOSITORY_NAME}:${TAGS}
     fi
 }