Remove remote debugging

- This simplifies the dev scrips, the kind config and the helm chart
- Security is no longer conditional
- No one was using it anyway

Author: georgethebeatle

.github/dependabot.yml

@@ -14,51 +14,26 @@ updates:
   schedule:
     interval: "daily"
 
-- package-ecosystem: "docker"
-  directory: "/api/remote-debug"
-  schedule:
-    interval: "daily"
-
 - package-ecosystem: "docker"
   directory: "/controllers"
   schedule:
     interval: "daily"
 
-- package-ecosystem: "docker"
-  directory: "/controllers/remote-debug"
-  schedule:
-    interval: "daily"
-
 - package-ecosystem: "docker"
   directory: "/job-task-runner"
   schedule:
     interval: "daily"
 
-- package-ecosystem: "docker"
-  directory: "/job-task-runner/remote-debug"
-  schedule:
-    interval: "daily"
-
 - package-ecosystem: "docker"
   directory: "/kpack-image-builder"
   schedule:
     interval: "daily"
 
-- package-ecosystem: "docker"
-  directory: "/kpack-image-builder/remote-debug"
-  schedule:
-    interval: "daily"
-
 - package-ecosystem: "docker"
   directory: "/statefulset-runner"
   schedule:
     interval: "daily"
 
-- package-ecosystem: "docker"
-  directory: "/statefulset-runner/remote-debug"
-  schedule:
-    interval: "daily"
-
 - package-ecosystem: "github-actions"
   directory: "/"
   schedule:

HACKING.md

@@ -51,105 +51,6 @@ API endpoint: https://localhost
 Of these options, `cf-admin` is the user with permissions set up by default. Selecting the other user may allow you to login and
 successfully create resources, but you may notice that the user lacks the permissions to list those resources once created.
 
-## Deploying to `kind` for remote debugging with a locally deployed container registry
-
-This is the above method, but run with `dlv` for remote debugging.
-
-```
-./scripts/deploy-on-kind.sh <kind-cluster-name> --debug
-```
-
-To remote debug, connect with `dlv` on `localhost:30051` (`controllers`) or `localhost:30052` (`api`).
-
-A sample VSCode `launch.json` configuration is provided below:
-
-```
-{
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Attach to Debug Controllers on Kind",
-            "type": "go",
-            "debugAdapter": "dlv-dap",
-            "request": "attach",
-            "mode": "remote",
-            "substitutePath": [
-                {
-                    "from": "${workspaceFolder}",
-                    "to": "/workspace"
-                }
-            ],
-            "host": "localhost",
-            "port": 30051
-        },
-        {
-            "name": "Attach to Debug API on Kind",
-            "type": "go",
-            "debugAdapter": "dlv-dap",
-            "request": "attach",
-            "mode": "remote",
-            "substitutePath": [
-                {
-                    "from": "${workspaceFolder}",
-                    "to": "/workspace"
-                }
-            ],
-            "host": "localhost",
-            "port": 30052
-        },
-        {
-            "name": "Attach to Debug Job Task Runner on Kind",
-            "type": "go",
-            "debugAdapter": "dlv-dap",
-            "request": "attach",
-            "mode": "remote",
-            "substitutePath": [
-                {
-                    "from": "${workspaceFolder}",
-                    "to": "/workspace"
-                }
-            ],
-            "host": "localhost",
-            "port": 30053
-        },
-        {
-            "name": "Attach to Debug Kpack Image Builder on Kind",
-            "type": "go",
-            "debugAdapter": "dlv-dap",
-            "request": "attach",
-            "mode": "remote",
-            "substitutePath": [
-                {
-                    "from": "${workspaceFolder}",
-                    "to": "/workspace"
-                }
-            ],
-            "host": "localhost",
-            "port": 30054
-        },
-        {
-            "name": "Attach to Debug Statefulset Runner on Kind",
-            "type": "go",
-            "debugAdapter": "dlv-dap",
-            "request": "attach",
-            "mode": "remote",
-            "substitutePath": [
-                {
-                    "from": "${workspaceFolder}",
-                    "to": "/workspace"
-                }
-            ],
-            "host": "localhost",
-            "port": 30055
-        }
-    ]
-}
-
-```
-
-> **Note**
-> Images built for debugging are based on an Ubuntu container image, rather than distroless, so deploying with `--debug` is useful if you plan to `kubectl exec` into the running containers for any reason.
-
 ## Image tagging conventions
 
 We store Korifi container images on [DockerHub](https://hub.docker.com/u/cloudfoundry).

README.helm.md

@@ -78,7 +78,6 @@ Here are all the values that can be set for the chart:
   - `workloadsTLSSecret` (_String_): TLS secret used when setting up an app routes.
 - `crds`:
   - `include` (_Boolean_): Install CRDs as part of the Helm installation.
-- `debug` (_Boolean_): Enables remote debugging with [Delve](https://github.com/go-delve/delve).
 - `defaultAppDomainName` (_String_): Base domain name for application URLs.
 - `eksContainerRegistryRoleARN` (_String_): Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.
 - `experimental`: Experimental features. No guarantees are provided and breaking/backwards incompatible changes should be expected. These features are not recommended for use in production environments.

api/remote-debug/Dockerfile

@@ -26,18 +26,6 @@ spec:
         - name: INTERNAL_CERT_PATH
           value: /etc/korifi-tls-internal
         image: {{ .Values.api.image }}
-{{- if .Values.debug }}
-        command:
-        - "/dlv"
-        args:
-        - "--listen=:40000"
-        - "--headless=true"
-        - "--api-version=2"
-        - "exec"
-        - "/cfapi"
-        - "--continue"
-        - "--accept-multiclient"
-{{- end }}
         name: korifi-api
         ports:
         - containerPort: {{ .Values.api.apiServer.internalPort }}

controllers/remote-debug/Dockerfile

@@ -14,22 +14,3 @@ spec:
   selector:
     app: korifi-api
   type: ClusterIP
-
----
-{{- if .Values.debug }}
-apiVersion: v1
-kind: Service
-metadata:
-  name: api-debug-port
-  namespace: {{ .Release.Namespace }}
-spec:
-  ports:
-    - name: debug-30052
-      nodePort: 30052
-      port: 30052
-      protocol: TCP
-      targetPort: 40000
-  selector:
-    app: korifi-api
-  type: NodePort
-{{- end }}

helm/korifi/api/deployment.yaml

@@ -27,25 +27,9 @@ spec:
         - name: CONTROLLERSCONFIG
           value: /etc/korifi-controllers-config
         image: {{ .Values.controllers.image }}
-{{- if .Values.debug }}
-        command:
-        - "/dlv"
-        args:
-        - "--listen=:40000"
-        - "--headless=true"
-        - "--api-version=2"
-        - "exec"
-        - "/manager"
-        - "--continue"
-        - "--accept-multiclient"
-        - "--"
-        - "--health-probe-bind-address=:8081"
-        - "--leader-elect"
-{{- else }}
         args:
         - --health-probe-bind-address=:8081
         - --leader-elect
-{{- end }}
         livenessProbe:
           httpGet:
             path: /healthz

helm/korifi/api/service.yaml

@@ -9,22 +9,3 @@ spec:
     targetPort: 9443
   selector:
     app: korifi-controllers
-
-{{- if .Values.debug }}
----
-apiVersion: v1
-kind: Service
-metadata:
-  name: controller-manager-debug-port
-  namespace: {{ .Release.Namespace }}
-spec:
-  ports:
-    - name: debug-30051
-      nodePort: 30051
-      port: 30051
-      protocol: TCP
-      targetPort: 40000
-  selector:
-    app: korifi-controllers
-  type: NodePort
-{{- end }}

helm/korifi/controllers/deployment.yaml

@@ -23,27 +23,10 @@ spec:
       containers:
       - name: manager
         image: {{ .Values.jobTaskRunner.image }}
-{{- if .Values.debug }}
-        command:
-        - "/dlv"
-        args:
-        - "--listen=:40000"
-        - "--headless=true"
-        - "--api-version=2"
-        - "exec"
-        - "/manager"
-        - "--continue"
-        - "--accept-multiclient"
-        - "--"
-        - "--health-probe-bind-address=:8081"
-        - "--leader-elect"
-        - "--ttl={{ required "jobTTL is required" .Values.jobTaskRunner.jobTTL }}"
-{{- else }}
         args:
         - --health-probe-bind-address=:8081
         - --leader-elect
         - --ttl={{ required "jobTTL is required" .Values.jobTaskRunner.jobTTL }}
-{{- end }}
         livenessProbe:
           httpGet:
             path: /healthz