@catladder/pipeline 1.53.0 → 1.55.0

package/src/deploy/cloudRun/index.ts

@@ -1,12 +1,37 @@
 import type { DeployTypeDefinition } from "..";
-import { createDeployJob } from "./deployJob";
+import { getSecretVarName } from "../../context";
+import { createGoogleCloudRunDeployJobs } from "./deployJob";
 
 export const GCLOUD_DEPLOY_CREDENTIALS_KEY = "GCLOUD_DEPLOY_credentialsKey";
 
 export const GCLOUD_RUN_CANONICAL_HOST_SUFFIX =
   "GCLOUD_RUN_canonicalHostSuffix";
+
 export const GCLOUD_RUN_DEPLOY_TYPE: DeployTypeDefinition<"google-cloudrun"> = {
-  jobs: createDeployJob,
+  jobs: createGoogleCloudRunDeployJobs,
   defaults: () => ({}),
   additionalSecretKeys: () => [GCLOUD_DEPLOY_CREDENTIALS_KEY],
+  getAdditionalEnvVars: ({ fullName, env, componentName, deployConfig }) => {
+    const HOST_CANONICAL =
+      fullName.toLowerCase() +
+      "-" +
+      process.env[
+        getSecretVarName(env, componentName, GCLOUD_RUN_CANONICAL_HOST_SUFFIX)
+      ];
+
+    const jobTriggers =
+      deployConfig && deployConfig.jobs
+        ? Object.fromEntries(
+            Object.entries(deployConfig.jobs).map(([name, job]) => [
+              "CLOUD_RUN_JOB_TRIGGER_URL_" + name,
+              `https://${deployConfig.region}-run.googleapis.com/apis/run.googleapis.com/v1/namespaces/${deployConfig.projectId}/jobs/${name}:run`,
+            ])
+          )
+        : {};
+
+    return {
+      HOST_CANONICAL,
+      ...jobTriggers,
+    };
+  },
 };

package/src/deploy/custom/index.ts

@@ -5,4 +5,5 @@ export const CUSTOM_DEPLOY_TYPE: DeployTypeDefinition<"custom"> = {
   jobs: createCustomDeployJobs,
   defaults: () => ({}),
   additionalSecretKeys: () => [],
+  getAdditionalEnvVars: () => ({}),
 };

package/src/deploy/dockerTag/index.ts

@@ -5,4 +5,5 @@ export const DOCKER_TAG_DEPLOY_TYPE: DeployTypeDefinition<"dockerTag"> = {
   jobs: createDockerTagDeployJobs,
   defaults: () => ({}),
   additionalSecretKeys: () => [],
+  getAdditionalEnvVars: () => ({}),
 };

package/src/deploy/index.ts

@@ -1,4 +1,5 @@
-import type { Context } from "../types/context";
+import type { Config, EnvType } from "../types";
+import type { CommitInfo, Context } from "../types/context";
 import type { CatladderJob } from "../types/jobs";
 import { GCLOUD_RUN_DEPLOY_TYPE } from "./cloudRun";
 import { CUSTOM_DEPLOY_TYPE } from "./custom";
@@ -9,10 +10,27 @@ export * from "./kubernetes";
 export * from "./types";
 export * from "./utils";
 
+export type EnvVarContext<D extends DeployConfigType> = {
+  deployConfig: false | DeployConfigGeneric<D>;
+  commitInfo?: CommitInfo;
+  env: string;
+  envType: EnvType;
+  componentName: string;
+  fullName: string;
+
+  /**
+   * the full catladder config
+   */
+  fullConfig: Config;
+};
+
 export type DeployTypeDefinition<T extends DeployConfigType> = {
   jobs: (context: Context) => CatladderJob[];
   defaults: () => Partial<DeployConfigGeneric<T>>;
-  additionalSecretKeys: (config: DeployConfigGeneric<T>) => string[];
+  additionalSecretKeys: (envVarContext: EnvVarContext<T>) => string[];
+  getAdditionalEnvVars: (
+    envVarContext: EnvVarContext<T>
+  ) => Record<string, string | undefined | null>;
 };
 export * from "./cloudSql";
 export * from "./cloudRun";
@@ -23,6 +41,6 @@ export type DeployTypes = {
 export const DEPLOY_TYPES: DeployTypes = {
   kubernetes: KUBERNETES_DEPLOY_TYPE,
   custom: CUSTOM_DEPLOY_TYPE,
-  "google-cloudrun": GCLOUD_RUN_DEPLOY_TYPE,
   dockerTag: DOCKER_TAG_DEPLOY_TYPE,
+  "google-cloudrun": GCLOUD_RUN_DEPLOY_TYPE,
 };

package/src/deploy/kubernetes/additionalSecretKeys.ts

@@ -1,17 +1,20 @@
-import type { DeployConfigKubernetes } from "../types";
+import type { EnvVarContext } from "..";
 
-export const additionalKubernetesSecretKeys = (
-  config: DeployConfigKubernetes
-) => {
+export const additionalKubernetesSecretKeys = ({
+  deployConfig,
+}: EnvVarContext<"kubernetes">) => {
+  if (!deployConfig) {
+    return [];
+  }
   const keys = [];
-  if (config.values?.mongodb?.enabled) {
+  if (deployConfig.values?.mongodb?.enabled) {
     keys.push("MONGODB_ROOT_PASSWORD");
-    if (config.values.mongodb.architecture === "replicaset") {
+    if (deployConfig.values.mongodb.architecture === "replicaset") {
       keys.push("MONGODB_REPLICASET_KEY");
     }
   }
 
-  if (config.values?.cloudsql?.enabled) {
+  if (deployConfig.values?.cloudsql?.enabled) {
     keys.push("POSTGRESQL_PASSWORD");
     keys.push("cloudsqlProxyCredentials");
   }

package/src/deploy/kubernetes/index.ts

@@ -1,4 +1,6 @@
+import slugify from "slugify";
 import type { DeployTypeDefinition } from "..";
+import { getKubernetesNamespace } from "..";
 import { additionalKubernetesSecretKeys } from "./additionalSecretKeys";
 import { createKubernetesDeployJobs } from "./deployJob";
 
@@ -6,4 +8,35 @@ export const KUBERNETES_DEPLOY_TYPE: DeployTypeDefinition<"kubernetes"> = {
   jobs: createKubernetesDeployJobs,
   defaults: () => ({}),
   additionalSecretKeys: additionalKubernetesSecretKeys,
+  getAdditionalEnvVars: ({
+    componentName,
+    fullConfig,
+    deployConfig,
+    env,
+    envType,
+    commitInfo,
+  }) => {
+    const KUBE_APP_NAME_PREFIX =
+      envType === "review" && commitInfo ? `${commitInfo.reviewSlug}-` : "";
+    const KUBE_APP_NAME = `${KUBE_APP_NAME_PREFIX}${componentName}`;
+    const KUBE_NAMESPACE = getKubernetesNamespace(fullConfig, env);
+    const componentSlug = slugify(componentName);
+    const envInUrl =
+      envType === "review" && commitInfo
+        ? `${commitInfo.reviewSlug}.${env}`
+        : env;
+
+    const domainCanonical =
+      (deployConfig && deployConfig.cluster?.domainCanonical) || // for convenience, we allow clusters to define a canonical domain, because a cluster has a fixed ip and you will usually have a domain pointing to that cluster
+      fullConfig.domainCanonical ||
+      "panter.cloud";
+    const HOST_CANONICAL = `${componentSlug}.${envInUrl}.${fullConfig.appName}.${fullConfig.customerName}.${domainCanonical}`; // default for kubernetes and rest
+
+    return {
+      KUBE_NAMESPACE,
+      KUBE_APP_NAME,
+      KUBE_APP_NAME_PREFIX,
+      HOST_CANONICAL,
+    };
+  },
 };

package/src/deploy/types/googleCloudRun.ts

@@ -37,10 +37,27 @@ export type Gcloudregion =
   | "us-west3"
   | "us-west4";
 
+export type DeployConfigCloudRunService = {
+  /**
+   * command / entrypoint, fallsback to buildConfig.startcommand
+   */
+  command?: string;
+};
+
+export type DeployConfigCloudRunJob = {
+  /**
+   * command
+   */
+  command: string;
+
+  when: "manual" | "postDeploy";
+};
 export type DeployConfigCloudRun = {
   /**
    * EXPERIMENTAL cloud run deployment.
    *
+   * This will deploy a cloud run service.
+   *
    * Requires that cloud run is enabled on the project, as well as cloud run api and artifacts registry.
    */
   type: "google-cloudrun";
@@ -52,4 +69,13 @@ export type DeployConfigCloudRun = {
    * the region. Set to europe-west6 for switzerland
    */
   region: Gcloudregion;
+
+  /**
+   * whether to enable the service, defaults to true
+   */
+  service?: boolean | DeployConfigCloudRunService;
+
+  jobs?: {
+    [name: string]: DeployConfigCloudRunJob;
+  };
 } & DeployConfigBase;