Create job to delete individual previews

Signed-off-by: ArthurSens <[email protected]>

Author: ArthurSens

.werft/platform-delete-preview-environment.ts

@@ -0,0 +1,99 @@
+import { Werft } from "./util/werft";
+import * as Tracing from "./observability/tracing";
+import { HarvesterPreviewEnvironment, PreviewEnvironment } from "./util/preview";
+import { SpanStatusCode } from "@opentelemetry/api";
+import { exec } from "./util/shell";
+import { CORE_DEV_KUBECONFIG_PATH, HARVESTER_KUBECONFIG_PATH } from "./jobs/build/const";
+import * as fs from "fs";
+
+// Will be set once tracing has been initialized
+let werft: Werft;
+
+const context: any = JSON.parse(fs.readFileSync("context.json").toString());
+const annotations = context.Annotations || {};
+const previewName = annotations["preview"] || "";
+// for testing purposes
+// if set to 'true' it shows only previews that would be deleted
+const DRY_RUN = annotations["dry-run"] || false;
+
+const SLICES = {
+    VALIDATE_CONFIGURATION: "Validating configuration",
+    CONFIGURE_ACCESS: "Configuring access to relevant resources",
+    INSTALL_HARVESTER_KUBECONFIG: "Install Harvester kubeconfig",
+    DELETING_PREVIEW: `Deleting preview environment: ${previewName}`,
+};
+
+Tracing.initialize()
+    .then(() => {
+        werft = new Werft("delete-preview-environment-cron");
+    })
+    .then(() => deletePreviewEnvironment())
+    .catch((err) => {
+        werft.rootSpan.setStatus({
+            code: SpanStatusCode.ERROR,
+            message: err,
+        });
+        console.error("Werft job failed with an error", err);
+        // Explicitly not using process.exit as we need to flush tracing, see tracing.js
+        process.exitCode = 1;
+    })
+    .finally(() => {
+        werft.phase("Flushing telemetry", "Flushing telemetry before stopping job");
+        werft.endAllSpans();
+    });
+
+async function deletePreviewEnvironment() {
+    // Fail early if no preview was passed through annotations.
+    werft.log(SLICES.VALIDATE_CONFIGURATION, "Validating annotations");
+    if (previewName == "") {
+        werft.fail(
+            SLICES.VALIDATE_CONFIGURATION,
+            "A preview name is required. Please inform the preview name with '-a preview=<name of the preview>'.",
+        );
+    }
+    werft.done(SLICES.VALIDATE_CONFIGURATION);
+
+    werft.phase("Configure access");
+    try {
+        const GCLOUD_SERVICE_ACCOUNT_PATH = "/mnt/secrets/gcp-sa/service-account.json";
+        exec(`gcloud auth activate-service-account --key-file "${GCLOUD_SERVICE_ACCOUNT_PATH}"`, {
+            slice: SLICES.CONFIGURE_ACCESS,
+        });
+        exec(
+            `KUBECONFIG=${CORE_DEV_KUBECONFIG_PATH} gcloud container clusters get-credentials core-dev --zone europe-west1-b --project gitpod-core-dev`,
+            { slice: SLICES.CONFIGURE_ACCESS },
+        );
+        werft.done(SLICES.CONFIGURE_ACCESS);
+    } catch (err) {
+        werft.fail(SLICES.CONFIGURE_ACCESS, err);
+    }
+
+    werft.phase("Install Harvester kubeconfig");
+    try {
+        exec(`cp /mnt/secrets/harvester-kubeconfig/harvester-kubeconfig.yml ${HARVESTER_KUBECONFIG_PATH}`, {
+            slice: SLICES.INSTALL_HARVESTER_KUBECONFIG,
+        });
+        werft.done(SLICES.INSTALL_HARVESTER_KUBECONFIG);
+    } catch (err) {
+        werft.fail(SLICES.INSTALL_HARVESTER_KUBECONFIG, err);
+    }
+
+    const preview = new HarvesterPreviewEnvironment(werft, previewName);
+    if (DRY_RUN) {
+        werft.log(SLICES.DELETING_PREVIEW, `Would have deleted preview ${preview.name}`);
+    } else {
+        removePreviewEnvironment(preview);
+    }
+}
+
+async function removePreviewEnvironment(previewEnvironment: PreviewEnvironment) {
+    werft.log(SLICES.DELETING_PREVIEW, `Starting deletion of all resources related to ${previewEnvironment.name}`);
+    try {
+        // We're running these promises sequentially to make it easier to read the log output.
+        await previewEnvironment.removeDNSRecords(SLICES.DELETING_PREVIEW);
+        await previewEnvironment.delete();
+        werft.done(SLICES.DELETING_PREVIEW);
+    } catch (e) {
+        werft.failSlice(SLICES.DELETING_PREVIEW, e);
+    }
+}

.werft/platform-delete-preview-environment.yaml

@@ -0,0 +1,65 @@
+pod:
+  serviceAccount: werft
+  affinity:
+    nodeAffinity:
+      requiredDuringSchedulingIgnoredDuringExecution:
+        nodeSelectorTerms:
+          - matchExpressions:
+              - key: dev/workload
+                operator: In
+                values:
+                  - "builds"
+  volumes:
+    - name: gcp-sa
+      secret:
+        secretName: gcp-sa-gitpod-dev-deployer
+    - name: harvester-kubeconfig
+      secret:
+        secretName: harvester-kubeconfig
+    - name: harvester-k3s-dockerhub-pull-account
+      secret:
+        secretName: harvester-k3s-dockerhub-pull-account
+    - name: harvester-vm-ssh-keys
+      secret:
+        secretName: harvester-vm-ssh-keys
+  containers:
+    - name: build
+      image: eu.gcr.io/gitpod-core-dev/dev/dev-environment:pd-dev-image-gcloud.2
+      workingDir: /workspace
+      imagePullPolicy: IfNotPresent
+      volumeMounts:
+        - name: gcp-sa
+          mountPath: /mnt/secrets/gcp-sa
+          readOnly: true
+        - name: harvester-kubeconfig
+          mountPath: /mnt/secrets/harvester-kubeconfig
+        - name: harvester-vm-ssh-keys
+          mountPath: /mnt/secrets/harvester-vm-ssh-keys
+        - name: harvester-k3s-dockerhub-pull-account
+          mountPath: /mnt/secrets/harvester-k3s-dockerhub-pull-account
+      env:
+        - name: HONEYCOMB_DATASET
+          value: "werft"
+        - name: HONEYCOMB_API_KEY
+          valueFrom:
+            secretKeyRef:
+              name: honeycomb-api-key
+              key: apikey
+      command:
+        - bash
+        - -c
+        - |
+          sleep 1
+          set -Eeuo pipefail
+
+          sudo chown -R gitpod:gitpod /workspace
+          mkdir /workspace/.ssh
+          cp /mnt/secrets/harvester-vm-ssh-keys/id_rsa /workspace/.ssh/id_rsa_harvester_vm
+          cp /mnt/secrets/harvester-vm-ssh-keys/id_rsa.pub /workspace/.ssh/id_rsa_harvester_vm.pub
+          sudo chmod 600 /workspace/.ssh/id_rsa_harvester_vm
+          sudo chmod 644 /workspace/.ssh/id_rsa_harvester_vm.pub
+
+          (cd .werft && yarn install && mv node_modules ..) | werft log slice prep
+          printf '{{ toJson . }}' > context.json
+
+          npx ts-node .werft/platform-delete-preview-environment.ts