@catladder/pipeline 1.34.0 → 1.36.0

package/src/deploy/kubernetes/deployJob.ts

@@ -1,20 +1,16 @@
 import { dump } from "js-yaml";
 import { merge } from "lodash";
-import { DeployConfigKubernetesValues } from "..";
 import { getSecretVarNameForContext } from "../..";
 import { getRunnerImage } from "../../runner";
 import { Context } from "../../types/context";
 import { CatladderJob } from "../../types/jobs";
-import { mergeWithMergingArrays } from "../../utils";
 import {
   getBaseDeploymentJob,
   getBaseDeploymentStopJob,
   getBaseRollbackJob,
 } from "../base";
 import { isOfDeployType } from "../types";
-import { createCloudsqlBaseConfig } from "./cloudsql";
-import { createMongodbBaseConfig } from "./mongodb";
-import { processSecretsAsFiles } from "./processSecretsAsFiles";
+import { createKubeValues } from "./kubeValues";
 
 export const createKubernetesDeployJobs = (
   context: Context
@@ -28,71 +24,7 @@ export const createKubernetesDeployJobs = (
     throw new Error("deploy config is not kubernetes");
   }
 
-  const allEnvVars = context.environment.envVars;
-  /**
-   * separate by secrets and public.
-   * we evalulate the actual values later, but want to store the secrets in kubernetes secrets
-   */
-  const env = Object.entries(allEnvVars).reduce<{
-    secret: Record<string, string>;
-    public: Record<string, string>;
-  }>(
-    (acc, [key, value]) => {
-      if (String(value)?.startsWith("$CL_")) {
-        acc.secret = {
-          ...acc.secret,
-          [key]: value,
-        };
-        return acc;
-      }
-      acc.public = {
-        ...acc.public,
-        [key]: value,
-      };
-      return acc;
-    },
-    {
-      secret: {},
-      public: {},
-    }
-  );
-
-  const defaultAppConfig: DeployConfigKubernetesValues["application"] = {
-    host: context.environment.host,
-    command: context.componentConfig.build.startCommand,
-    livenessProbe: {
-      httpGet: {
-        path: deployConfig.values?.application?.healthRoute ?? "__health",
-      },
-    },
-    readinessProbe: {
-      httpGet: {
-        path: deployConfig.values?.application?.healthRoute ?? "__health",
-      },
-    },
-    startupProbe: {
-      httpGet: {
-        path: deployConfig.values?.application?.healthRoute ?? "__health",
-      },
-    },
-  };
-
-  const defaultKubeValues = {
-    application: defaultAppConfig,
-
-    env: env,
-    ...(deployConfig.values?.cloudsql?.enabled
-      ? createCloudsqlBaseConfig(context)
-      : {}),
-    ...(deployConfig.values?.mongodb?.enabled
-      ? createMongodbBaseConfig(context)
-      : {}),
-  };
-
-  const kubeValues = processSecretsAsFiles(
-    mergeWithMergingArrays(defaultKubeValues, deployConfig.values)
-  );
-
+  const kubeValues = createKubeValues(context);
   const kubernetesEnvironment = {
     namespace: context.environment.envVars.KUBE_NAMESPACE,
   };

package/src/deploy/kubernetes/index.ts

@@ -1 +1,9 @@
-export * from "./deployJob";
+import { DeployTypeDefinition } from "..";
+import { additionalKubernetesSecretKeys } from "./additionalSecretKeys";
+import { createKubernetesDeployJobs } from "./deployJob";
+
+export const KUBERNETES_DEPLOY_TYPE: DeployTypeDefinition<"kubernetes"> = {
+  jobs: createKubernetesDeployJobs,
+  defaults: () => ({}),
+  additionalSecretKeys: additionalKubernetesSecretKeys,
+};

package/src/deploy/kubernetes/kubeEnv.ts

@@ -0,0 +1,48 @@
+import { Context } from "../../types";
+import { isOfDeployType } from "../types";
+
+const shouldGoIntoSecrets = (key: string, value: string) => {
+  if (String(value)?.includes("$CL_")) {
+    return true;
+  }
+  return false;
+};
+
+/**
+ * separate by secrets and public.
+ * we evalulate the actual values later, but want to store the secrets in kubernetes secrets
+ */
+export const createKubeEnv = (context: Context) => {
+  if (!isOfDeployType(context.componentConfig.deploy, "kubernetes")) {
+    // should not happen
+    throw new Error("deploy config is not kubernetes");
+  }
+
+  const allEnvVars = context.environment.envVars;
+
+  const env = Object.entries(allEnvVars).reduce<{
+    secret: Record<string, string>;
+    public: Record<string, string>;
+  }>(
+    (acc, [key, value]) => {
+      if (shouldGoIntoSecrets(key, value)) {
+        acc.secret = {
+          ...acc.secret,
+          [key]: value,
+        };
+        return acc;
+      }
+      acc.public = {
+        ...acc.public,
+        [key]: value,
+      };
+      return acc;
+    },
+    {
+      secret: {},
+      public: {},
+    }
+  );
+
+  return env;
+};

package/src/deploy/kubernetes/kubeValues.ts

@@ -0,0 +1,60 @@
+import { merge } from "lodash";
+import { DeployConfigKubernetesValues } from "..";
+import { Context } from "../../types/context";
+import { mergeWithMergingArrays } from "../../utils";
+import { isOfDeployType } from "../types";
+import { createCloudsqlBaseConfig } from "./cloudsql";
+import { createKubeEnv } from "./kubeEnv";
+import { createMongodbBaseConfig } from "./mongodb";
+import { processSecretsAsFiles } from "./processSecretsAsFiles";
+
+export const createKubeValues = (context: Context) => {
+  const deployConfig = context.componentConfig.deploy;
+  if (deployConfig === false) {
+    return [];
+  }
+  if (!isOfDeployType(deployConfig, "kubernetes")) {
+    // should not happen
+    throw new Error("deploy config is not kubernetes");
+  }
+
+  const env = createKubeEnv(context);
+  const defaultAppConfig: DeployConfigKubernetesValues["application"] = {
+    host: context.environment.host,
+    command: context.componentConfig.build.startCommand,
+    livenessProbe: {
+      httpGet: {
+        path: deployConfig.values?.application?.healthRoute ?? "__health",
+      },
+    },
+    readinessProbe: {
+      httpGet: {
+        path: deployConfig.values?.application?.healthRoute ?? "__health",
+      },
+    },
+    startupProbe: {
+      httpGet: {
+        path: deployConfig.values?.application?.healthRoute ?? "__health",
+      },
+    },
+  };
+
+  const defaultKubeValues = merge(
+    {
+      application: defaultAppConfig,
+      env: env,
+    },
+    deployConfig.values?.cloudsql?.enabled
+      ? createCloudsqlBaseConfig(context)
+      : {},
+    deployConfig.values?.mongodb?.enabled
+      ? createMongodbBaseConfig(context)
+      : {}
+  );
+
+  const kubeValues = processSecretsAsFiles(
+    mergeWithMergingArrays(defaultKubeValues, deployConfig.values)
+  );
+
+  return kubeValues;
+};

package/src/deploy/kubernetes/mongodb.ts

@@ -1,17 +1,113 @@
-import { Context } from "../..";
+import { range } from "lodash";
+import { Context, getSecretVarNameForContext, isOfDeployType } from "../..";
 
+const getCredentialString = (context: Context) =>
+  `root:$${getSecretVarNameForContext(context, "MONGODB_ROOT_PASSWORD")}@`;
+const getMongodbHost = (context: Context, name: string) => {
+  const namespace = context.environment.envVars.KUBE_NAMESPACE;
+  return `${name}.${namespace}.svc.cluster.local:27017`;
+};
+
+const getMongodbStandaloneHost = (context: Context) => {
+  const fullAppname = context.environment.envVars.KUBE_APP_NAME;
+  return getMongodbHost(context, `${fullAppname}-mongodb`);
+};
+
+const getMongodbReplicasetHost = (context: Context, index: number) => {
+  const fullAppname = context.environment.envVars.KUBE_APP_NAME;
+  return getMongodbHost(
+    context,
+    `${fullAppname}-mongodb-${index}.${fullAppname}-mongodb-headless`
+  );
+};
+const createMongodbUrl = (context: Context, dbName: string) => {
+  if (!isOfDeployType(context.componentConfig.deploy, "kubernetes")) {
+    throw new Error("can only createMongodbUrl on supported deploys");
+  }
+  const mongodbConfig = context.componentConfig.deploy.values?.mongodb;
+
+  let queryParams: string | undefined = undefined;
+
+  let hosts = "";
+  if (mongodbConfig?.architecture === "replicaset") {
+    hosts = range(0, mongodbConfig?.replicaCount ?? 2)
+      .map((i) => getMongodbReplicasetHost(context, i))
+      .join(",");
+
+    queryParams = "replicaSet=rs0&authSource=admin";
+  } else {
+    hosts = getMongodbStandaloneHost(context);
+    queryParams = "authSource=admin";
+  }
+
+  return `mongodb://${getCredentialString(context)}${hosts}/${dbName}${
+    queryParams ? `?${queryParams}` : ""
+  }`;
+};
+const createMongoBackupDefaultConfig = (context: Context) => {
+  if (!isOfDeployType(context.componentConfig.deploy, "kubernetes")) {
+    throw new Error("can only create mongodb base config on supported deploys");
+  }
+  const mongodbConfig = context.componentConfig.deploy.values?.mongodb;
+  const fullAppName = context.environment.envVars.KUBE_APP_NAME;
+  const backupEnabled = true; //  ["prod", "stage"].includes(context.environment.envType)
+
+  let hostToBackup: string;
+  let pvcToBackup: string;
+
+  if (mongodbConfig?.architecture === "replicaset") {
+    // bit quirky, we need to specify the host and its volume
+    // on replicaset its probably best to not use the first one, whcih usually starts as master, so we take the second (last one would also be ok)
+    const backupHostIndex =
+      mongodbConfig?.architecture === "replicaset" &&
+      mongodbConfig.replicaCount &&
+      mongodbConfig.replicaCount > 1
+        ? 1
+        : 0;
+
+    hostToBackup = getMongodbReplicasetHost(context, backupHostIndex);
+    pvcToBackup = `datadir-${fullAppName}-mongodb-${backupHostIndex}`;
+  } else {
+    hostToBackup = getMongodbStandaloneHost(context);
+    pvcToBackup = `${fullAppName}-mongodb`;
+  }
+
+  return {
+    enabled: backupEnabled,
+    hostToBackup,
+    pvcToBackup,
+    image: "mrelite/kubectlmongoshell:v1.0",
+    schedule: "0 0 1 1 1",
+    volumeSnapshotClass: "snapshotclass",
+  };
+};
 export const createMongodbBaseConfig = (context: Context) => {
+  if (!isOfDeployType(context.componentConfig.deploy, "kubernetes")) {
+    throw new Error("can only create mongodb base config on supported deploys");
+  }
+  const mongodbConfig = context.componentConfig.deploy.values?.mongodb;
+
   return {
     mongodb: {
       enabled: true,
-      backup: {
-        enabled: ["prod", "stage"].includes(context.environment.envType),
+      auth: {
+        enabled: true,
+        rootPassword:
+          "$" + getSecretVarNameForContext(context, "MONGODB_ROOT_PASSWORD"),
+        replicaSetKey:
+          "$" + getSecretVarNameForContext(context, "MONGODB_REPLICASET_KEY"),
+      },
+      persistence: {
+        storageClass: "standard-rwo",
       },
+      backup: createMongoBackupDefaultConfig(context),
     },
-    "mongodb-replicaset": {
-      replicas: 1,
-      persistentVolume: {
-        storageClass: "standard",
+    env: {
+      secret: {
+        MONGO_URL: createMongodbUrl(context, mongodbConfig?.dbName ?? "app"),
+        ...(mongodbConfig?.architecture === "replicaset"
+          ? { MONGO_OPLOG_URL: createMongodbUrl(context, "local") } // oplog only works with replicasets
+          : {}),
       },
     },
   };

package/src/deploy/types.ts

@@ -110,6 +110,25 @@ export type KubernetesWorkerDef = {
   command?: string;
   resources?: KubernetesResourcesDef;
 };
+
+export type DeployConfigMongodbBase = {
+  enabled?: boolean;
+  dbName?: string;
+};
+
+export type DeployConfigMongodbStandalone = {
+  architecture: "standalone";
+};
+export type DeployConfigMongodbReplicaset = {
+  architecture: "replicaset";
+  /**
+   * defaults to 2
+   */
+  replicaCount?: number;
+};
+export type DeployConfigMongodb = DeployConfigMongodbBase &
+  (DeployConfigMongodbStandalone | DeployConfigMongodbReplicaset);
+
 export type DeployConfigKubernetesValues = AllowUnknownProps<{
   /**
    * enable cloudsql db. Currently you have to manually set it up
@@ -122,11 +141,9 @@ export type DeployConfigKubernetesValues = AllowUnknownProps<{
   };
   /**
    * enable mongodb. The mongodb is deployed using a helm chart.
-   * Consider using external services instead of this.
+   * See https://github.com/bitnami/charts/tree/master/bitnami/mongodb
    */
-  mongodb?: AllowUnknownProps<{
-    enabled: boolean;
-  }>;
+  mongodb?: DeployConfigMongodb;
   /**
    * enable mailhog. Mailhog is a virtual mail server that catches all outgoing mailsl and show them in a mailbox.
    * This is great for development as it prevents to accidentially send out real emails and helps with debugging outgoing mails.
@@ -142,7 +159,21 @@ export type DeployConfigKubernetesValues = AllowUnknownProps<{
    * post-install/upgrade jobs. These use the app image and have all env vars available.
    * Typically used for migrations and seeds
    */
-  jobs?: Record<string, AllowUnknownProps<{ command: string }>>;
+  jobs?: Record<
+    string,
+    AllowUnknownProps<{
+      /**
+       * the command to execute
+       */
+      command: string;
+      /**
+       * comma-separated list of helm hooks, see https://helm.sh/docs/topics/charts_hooks/
+       *
+       * defaults to pre-install,pre-upgrade
+       */
+      hook?: string;
+    }>
+  >;
   /**
    * cronjobs that run periodically. These use the app image have all env vars available.
    */
@@ -232,7 +263,13 @@ export type DeployConfigCustom = {
 
 export type DeployConfig = DeployConfigKubernetes | DeployConfigCustom;
 
-export const isOfDeployType = <T extends Array<DeployConfig["type"]>>(
+export type DeployConfigType = DeployConfig["type"];
+export type DeployConfigGeneric<T extends DeployConfigType> = Extract<
+  DeployConfig,
+  { type: T }
+>;
+
+export const isOfDeployType = <T extends Array<DeployConfigType>>(
   t: DeployConfig | false,
   ...types: T
 ): t is Extract<DeployConfig, { type: T[number] }> => {