@catladder/cli 0.0.0-next-e9e5af68 → 0.0.0-next-1c65899f

package/dist/pipeline/src/deploy/types/kubernetes.d.ts

@@ -1,323 +1,323 @@
 import type { AllowUnknownProps, DeployConfigBase } from "./base";
 export type DeployConfigKubernetesClusterGCloud = {
-  type: "gcloud";
-  /**
-   * gcoud name of the cluster
-   */
-  name: string;
-  /**
-   * google cloud project id
-   */
-  projectId: string;
-  /**
-   * region
-   */
-  region: string;
-  /**
-   * domain of the cluster, for canonical domains without custom host (e.g. review and dev apps)
-   */
-  domainCanonical?: string;
+    type: "gcloud";
+    /**
+     * gcoud name of the cluster
+     */
+    name: string;
+    /**
+     * google cloud project id
+     */
+    projectId: string;
+    /**
+     * region
+     */
+    region: string;
+    /**
+     * domain of the cluster, for canonical domains without custom host (e.g. review and dev apps)
+     */
+    domainCanonical?: string;
 };
 export type DeployConfigKubernetesCluster = DeployConfigKubernetesClusterGCloud;
 export type KubernetesAutoscaleMetricResourceTarget = {
-  type: "Utilization";
-  averageUtilization: number;
+    type: "Utilization";
+    averageUtilization: number;
 } | {
-  type: "AverageValue";
-  averageValue: number | string;
+    type: "AverageValue";
+    averageValue: number | string;
 };
 export type KubernetesAutoscaleMetric = {
-  type: "Resource";
-  resource: {
-    name: "cpu" | "memory";
-    target: KubernetesAutoscaleMetricResourceTarget;
-  };
+    type: "Resource";
+    resource: {
+        name: "cpu" | "memory";
+        target: KubernetesAutoscaleMetricResourceTarget;
+    };
 };
 export type KubernetesAutoscale = {
-  minReplicas: number;
-  maxReplicas: number;
-  /**
-   * declare a number of metrics (at least one). Usually you would use cpu as a metric
-   */
-  metrics: KubernetesAutoscaleMetric[];
+    minReplicas: number;
+    maxReplicas: number;
+    /**
+     * declare a number of metrics (at least one). Usually you would use cpu as a metric
+     */
+    metrics: KubernetesAutoscaleMetric[];
 };
 export type KubernetesResourcesDef = {
-  limits?: {
-    cpu?: string;
-    memory?: string;
-  };
-  requests?: {
-    cpu?: string;
-    memory?: string;
-  };
+    limits?: {
+        cpu?: string;
+        memory?: string;
+    };
+    requests?: {
+        cpu?: string;
+        memory?: string;
+    };
 };
 type KubernetesHealthDef = {
-  httpGet?: {
-    path?: string;
-    port?: number;
-    httpHeaders?: {
-      name: string;
-      value: string;
-    }[];
-    failureThreshold?: number;
-    timeoutSeconds?: number;
-    periodSeconds?: number;
-    successThreshold?: number;
-  };
+    httpGet?: {
+        path?: string;
+        port?: number;
+        httpHeaders?: {
+            name: string;
+            value: string;
+        }[];
+        failureThreshold?: number;
+        timeoutSeconds?: number;
+        periodSeconds?: number;
+        successThreshold?: number;
+    };
 };
 export type KubernetesUpdateStrategy = {
-  rollingUpdate: {
+    rollingUpdate: {
+        /**
+         * how many pods can be created additionally to the target number
+         * can be absolute number or percentage.
+         * defaults to 1 (kube default is 25%)
+         */
+        maxSurge: number | string;
+        /**
+         * how many pods are allowed to be unavailable
+         * can be absolute number or percentage
+         * defaults to 0 (kube default is 25%)
+         */
+        maxUnavailable: number | string;
+    };
+    type: "RollingUpdate";
+};
+export type KubernetesWorkerDef = {
+    enabled: boolean;
     /**
-     * how many pods can be created additionally to the target number
-     * can be absolute number or percentage.
-     * defaults to 1 (kube default is 25%)
+     * which command to run. defaults to `yarn start`
      */
-    maxSurge: number | string;
+    command?: string;
+    resources?: KubernetesResourcesDef;
+    service?: {
+        enabled?: boolean;
+    };
     /**
-     * how many pods are allowed to be unavailable
-     * can be absolute number or percentage
-     * defaults to 0 (kube default is 25%)
+     * if the same livenessProbe as the application should be used, defaults to `true`
      */
-    maxUnavailable: number | string;
-  };
-  type: "RollingUpdate";
-};
-export type KubernetesWorkerDef = {
-  enabled: boolean;
-  /**
-   * which command to run. defaults to `yarn start`
-   */
-  command?: string;
-  resources?: KubernetesResourcesDef;
-  service?: {
-    enabled?: boolean;
-  };
-  /**
-   * if the same livenessProbe as the application should be used, defaults to `true`
-   */
-  livenessProbe?: boolean;
+    livenessProbe?: boolean;
 };
 type KubernetesTolerationExists = {
-  operator: "Exists";
+    operator: "Exists";
 };
 type KubernetesTolerationEqual = {
-  operator: "Equal";
-  value: string;
+    operator: "Equal";
+    value: string;
 };
 export type KubernetesToleration = {
-  key: string;
-  effect: "NoSchedule" | "PreferNoSchedule" | "NoExecute";
+    key: string;
+    effect: "NoSchedule" | "PreferNoSchedule" | "NoExecute";
 } & (KubernetesTolerationEqual | KubernetesTolerationExists);
 export type DeployConfigMongodbBase = {
-  enabled?: boolean;
-  dbName?: string;
-  persistence?: {
+    enabled?: boolean;
+    dbName?: string;
+    persistence?: {
+        /**
+         * set premium-rwo for ssd
+         */
+        storageClass?: "standard-rwo" | "premium-rwo";
+        /**
+         * size of the volume, defaults to 8Gi
+         */
+        size?: string;
+    };
+    resources?: KubernetesResourcesDef;
+    tolerations?: KubernetesToleration[];
+};
+export type KubernetesRedirect = {
     /**
-     * set premium-rwo for ssd
+     * the domain to redirect from
      */
-    storageClass?: "standard-rwo" | "premium-rwo";
+    host: string;
     /**
-     * size of the volume, defaults to 8Gi
+     * optional path to redirect from, defaults to `/`
      */
-    size?: string;
-  };
-  resources?: KubernetesResourcesDef;
-  tolerations?: KubernetesToleration[];
-};
-export type KubernetesRedirect = {
-  /**
-   * the domain to redirect from
-   */
-  host: string;
-  /**
-   * optional path to redirect from, defaults to `/`
-   */
-  path?: string;
-  /**
-   * optional nginx config snippet, defaults to a 301 redirect to the environment host name name with the request path appended
-   *
-   * important: to get a literal `$` use `$$` to prevent variable expansion by gitlab
-   * see https://docs.gitlab.com/ee/ci/variables/#use-the--character-in-cicd-variables
-   */
-  rule?: string;
+    path?: string;
+    /**
+     * optional nginx config snippet, defaults to a 301 redirect to the environment host name name with the request path appended
+     *
+     * important: to get a literal `$` use `$$` to prevent variable expansion by gitlab
+     * see https://docs.gitlab.com/ee/ci/variables/#use-the--character-in-cicd-variables
+     */
+    rule?: string;
 };
 export type DeployConfigMongodbStandalone = {
-  architecture: "standalone";
+    architecture: "standalone";
 };
 export type DeployConfigMongodbReplicaset = {
-  architecture: "replicaset";
-  /**
-   * defaults to 2
-   */
-  replicaCount?: number;
+    architecture: "replicaset";
+    /**
+     * defaults to 2
+     */
+    replicaCount?: number;
 };
 export type DeployConfigMongodb = DeployConfigMongodbBase & (DeployConfigMongodbStandalone | DeployConfigMongodbReplicaset);
 export type DeployConfigKubernetesValuesCloudSQLUnmanaged = {
-  enabled: boolean;
-  instanceConnectionName: string;
-  /**
-   * the recommended type for the config.
-   *
-   * this mode is similar to cloudrun and declares fully-qualified db names including env.
-   *
-   * This makes it easier to share db instances across envs and dbs
-   */
-  type: "unmanaged";
-  /**
-   * the database username, defaults to "postgres"
-   */
-  dbUser?: string;
-  /**
-   * the prefix of the database, the full db name is this plus the environment slug prefix plus the componentName
-   *
-   * defaults to customerName-appName
-   */
-  dbNamePrefix?: string | false;
-  /**
-   * the base name of the db, defaults to the componentName
-   */
-  dbBaseName?: string;
-};
-export type DeployConfigKubernetesValuesCloudSQL = DeployConfigKubernetesValuesCloudSQLUnmanaged;
-export type DeployConfigKubernetesValues = AllowUnknownProps<{
-  /**
-   * enable cloudsql db. Currently you have to manually set it up
-   */
-  cloudsql?: DeployConfigKubernetesValuesCloudSQL;
-  /**
-   * enable mongodb. The mongodb is deployed using a helm chart.
-   * See https://github.com/bitnami/charts/tree/master/bitnami/mongodb
-   */
-  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.
-   *
-   * It will automaticaly inject a MAIL_URL env var.
-   *
-   * Turn it of for production.
-   */
-  mailhog?: {
     enabled: boolean;
-  };
-  /**
-   * post-install/upgrade jobs. These use the app image and have all env vars available.
-   * Typically used for migrations and seeds
-   */
-  jobs?: Record<string, false | AllowUnknownProps<{
+    instanceConnectionName: string;
     /**
-     * the command to execute
+     * the recommended type for the config.
+     *
+     * this mode is similar to cloudrun and declares fully-qualified db names including env.
+     *
+     * This makes it easier to share db instances across envs and dbs
      */
-    command: string;
+    type: "unmanaged";
     /**
-     * comma-separated list of helm hooks, see https://helm.sh/docs/topics/charts_hooks/
-     *
-     * defaults to post-install,post-upgrade
+     * the database username, defaults to "postgres"
      */
-    hook?: string;
-  }>>;
-  /**
-   * cronjobs that run periodically. These use the app image have all env vars available.
-   */
-  cronjobs?: Record<string, false | AllowUnknownProps<{
-    schedule: string;
-    command: string;
-    concurrencyPolicy?: "Forbid" | "Allow" | "Replace";
-    timeZone?: string;
-  }>>;
-  /**
-   * configuration for the application ("Deployment" in kubernetes)
-   */
-  application?: false | AllowUnknownProps<{
+    dbUser?: string;
     /**
-     * command to start, defaults to build's startCommand
+     * the prefix of the database, the full db name is this plus the environment slug prefix plus the componentName
+     *
+     * defaults to customerName-appName
      */
-    command?: string;
+    dbNamePrefix?: string | false;
     /**
-     * enable, disable app deployment, defaults to true
+     * the base name of the db, defaults to the componentName
      */
-    enabled?: boolean;
+    dbBaseName?: string;
+};
+export type DeployConfigKubernetesValuesCloudSQL = DeployConfigKubernetesValuesCloudSQLUnmanaged;
+export type DeployConfigKubernetesValues = AllowUnknownProps<{
     /**
-     * redirects
+     * enable cloudsql db. Currently you have to manually set it up
      */
-    redirects?: KubernetesRedirect[];
+    cloudsql?: DeployConfigKubernetesValuesCloudSQL;
     /**
-     * Host aliases
+     * enable mongodb. The mongodb is deployed using a helm chart.
+     * See https://github.com/bitnami/charts/tree/master/bitnami/mongodb
      */
-    hostAliases?: string[];
+    mongodb?: DeployConfigMongodb;
     /**
-     * how many pods will be started
+     * 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.
+     *
+     * It will automaticaly inject a MAIL_URL env var.
+     *
+     * Turn it of for production.
      */
-    replicas?: number;
+    mailhog?: {
+        enabled: boolean;
+    };
     /**
-     * autoscale the pods horizontally
+     * post-install/upgrade jobs. These use the app image and have all env vars available.
+     * Typically used for migrations and seeds
      */
-    autoscale?: KubernetesAutoscale;
+    jobs?: Record<string, false | AllowUnknownProps<{
+        /**
+         * the command to execute
+         */
+        command: string;
+        /**
+         * comma-separated list of helm hooks, see https://helm.sh/docs/topics/charts_hooks/
+         *
+         * defaults to post-install,post-upgrade
+         */
+        hook?: string;
+    }>>;
     /**
-     * the update strategy, see https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#rolling-update-deployment
+     * cronjobs that run periodically. These use the app image have all env vars available.
      */
-    updateStrategy?: KubernetesUpdateStrategy;
+    cronjobs?: Record<string, false | AllowUnknownProps<{
+        schedule: string;
+        command: string;
+        concurrencyPolicy?: "Forbid" | "Allow" | "Replace";
+        timeZone?: string;
+    }>>;
     /**
-     * kubernetes resources
+     * configuration for the application ("Deployment" in kubernetes)
      */
-    resources?: KubernetesResourcesDef;
-    healthRoute?: string;
-    startupProbe?: KubernetesHealthDef;
-    readinessProbe?: KubernetesHealthDef;
-    livenessProbe?: KubernetesHealthDef;
+    application?: false | AllowUnknownProps<{
+        /**
+         * command to start, defaults to build's startCommand
+         */
+        command?: string;
+        /**
+         * enable, disable app deployment, defaults to true
+         */
+        enabled?: boolean;
+        /**
+         * redirects
+         */
+        redirects?: KubernetesRedirect[];
+        /**
+         * Host aliases
+         */
+        hostAliases?: string[];
+        /**
+         * how many pods will be started
+         */
+        replicas?: number;
+        /**
+         * autoscale the pods horizontally
+         */
+        autoscale?: KubernetesAutoscale;
+        /**
+         * the update strategy, see https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#rolling-update-deployment
+         */
+        updateStrategy?: KubernetesUpdateStrategy;
+        /**
+         * kubernetes resources
+         */
+        resources?: KubernetesResourcesDef;
+        healthRoute?: string;
+        startupProbe?: KubernetesHealthDef;
+        readinessProbe?: KubernetesHealthDef;
+        livenessProbe?: KubernetesHealthDef;
+        /**
+         * specify a worker. A worker is a separate deployment that runs continously in the background.
+         * The worker pod can use the same entry point as the app or a different one (specify command).
+         * It has the same environment variables as the application and an additional IS_WORKER="true" variable
+         */
+        worker?: KubernetesWorkerDef;
+        /**
+         * kubernetes resources for jobs and cronjobs
+         */
+        jobDefaults?: {
+            resources: KubernetesResourcesDef;
+        };
+    }>;
     /**
-     * specify a worker. A worker is a separate deployment that runs continously in the background.
-     * The worker pod can use the same entry point as the app or a different one (specify command).
-     * It has the same environment variables as the application and an additional IS_WORKER="true" variable
+     * load secrets from other components.
+     * Use this only in cases where the secret is not known on pipeline-time
+     * and only if the component is also in the same cluster.
+     *
+     * a typical case is reusing mongo_url from other component
+     *
+     * also make sure that the other component deploys first
+     *
+     * in all other cases use normal env var handling
      */
-    worker?: KubernetesWorkerDef;
+    secretsFromOtherComponent?: {
+        [envVar: string]: string;
+    };
     /**
-     * kubernetes resources for jobs and cronjobs
+     * map another services internal endpoint into a env var.
      */
-    jobDefaults?: {
-      resources: KubernetesResourcesDef;
+    mapServiceUrlToEnv?: {
+        [envVar: string]: string;
     };
-  }>;
-  /**
-   * load secrets from other components.
-   * Use this only in cases where the secret is not known on pipeline-time
-   * and only if the component is also in the same cluster.
-   *
-   * a typical case is reusing mongo_url from other component
-   *
-   * also make sure that the other component deploys first
-   *
-   * in all other cases use normal env var handling
-   */
-  secretsFromOtherComponent?: {
-    [envVar: string]: string;
-  };
-  /**
-   * map another services internal endpoint into a env var.
-   */
-  mapServiceUrlToEnv?: {
-    [envVar: string]: string;
-  };
 }>;
 export type DeployConfigKubernetes = {
-  type: "kubernetes";
-  /**
-   * cluster config to use.
-   */
-  cluster: DeployConfigKubernetesCluster;
-  /**
-   * prints out debug info (helm --debug)
-   */
-  debug?: boolean;
-  additionalHelmArgs?: string[];
-  /**
-   * values to configure the app
-   */
-  values?: DeployConfigKubernetesValues;
-  /**
-   * Custom Helm chart location.
-   * Not recommended to use.
-   */
-  chartName?: string;
+    type: "kubernetes";
+    /**
+     * cluster config to use.
+     */
+    cluster: DeployConfigKubernetesCluster;
+    /**
+     * prints out debug info (helm --debug)
+     */
+    debug?: boolean;
+    additionalHelmArgs?: string[];
+    /**
+     * values to configure the app
+     */
+    values?: DeployConfigKubernetesValues;
+    /**
+     * Custom Helm chart location.
+     * Not recommended to use.
+     */
+    chartName?: string;
 } & DeployConfigBase;
-export {};
+export {};

package/dist/pipeline/src/deploy/types/kubernetes.js

@@ -1,5 +1,3 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=kubernetes.js.map

package/dist/pipeline/src/deploy/utils.d.ts

@@ -2,4 +2,4 @@ import type { Config, ComponentContext } from "../types";
 import type { DeployConfigKubernetesCluster } from "./types";
 export declare const getFullKubernetesClusterName: (cluster: DeployConfigKubernetesCluster) => string;
 export declare const getKubernetesNamespace: (config: Pick<Config, "customerName" | "appName">, env: string) => string;
-export declare const contextIsStoppable: (context: ComponentContext) => boolean;
+export declare const contextIsStoppable: (context: ComponentContext) => boolean;

package/dist/pipeline/src/deploy/utils.js

@@ -1,32 +1,30 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.contextIsStoppable = exports.getKubernetesNamespace = exports.getFullKubernetesClusterName = void 0;
 const types_1 = require("./types");
-const getFullKubernetesClusterName = cluster => {
-  if (cluster.type === "gcloud") {
-    return `gke_${cluster.projectId}_${cluster.region}_${cluster.name}`;
-  }
+const getFullKubernetesClusterName = (cluster) => {
+    if (cluster.type === "gcloud") {
+        return `gke_${cluster.projectId}_${cluster.region}_${cluster.name}`;
+    }
 };
 exports.getFullKubernetesClusterName = getFullKubernetesClusterName;
 const getKubernetesNamespace = (config, env) => {
-  return `${config.customerName}-${config.appName}-${env}`;
+    return `${config.customerName}-${config.appName}-${env}`;
 };
 exports.getKubernetesNamespace = getKubernetesNamespace;
-const contextIsStoppable = context => {
-  var _a;
-  const deployConfig = (_a = context.deploy) === null || _a === void 0 ? void 0 : _a.config;
-  if ((0, types_1.isOfDeployType)(deployConfig, "kubernetes")) {
-    return true;
-  }
-  if ((0, types_1.isOfDeployType)(deployConfig, "google-cloudrun")) {
-    return true;
-  }
-  if ((0, types_1.isOfDeployType)(deployConfig, "custom") && deployConfig.stopScript) {
-    return true;
-  }
-  return false;
+const contextIsStoppable = (context) => {
+    var _a;
+    const deployConfig = (_a = context.deploy) === null || _a === void 0 ? void 0 : _a.config;
+    if ((0, types_1.isOfDeployType)(deployConfig, "kubernetes")) {
+        return true;
+    }
+    if ((0, types_1.isOfDeployType)(deployConfig, "google-cloudrun")) {
+        return true;
+    }
+    if ((0, types_1.isOfDeployType)(deployConfig, "custom") && deployConfig.stopScript) {
+        return true;
+    }
+    return false;
 };
-exports.contextIsStoppable = contextIsStoppable;
+exports.contextIsStoppable = contextIsStoppable;
+//# sourceMappingURL=utils.js.map

package/dist/pipeline/src/globalScriptFunctions/index.d.ts

@@ -1,9 +1,9 @@
 declare class GlobalScriptFunction {
-  name: string;
-  script: string;
-  constructor(name: string, script: string);
-  toBashFunction(): string;
-  invoke(...args: string[]): string;
+    name: string;
+    script: string;
+    constructor(name: string, script: string);
+    toBashFunction(): string;
+    invoke(...args: string[]): string;
 }
 export declare const globalScriptFunctions: Map<string, GlobalScriptFunction>;
 /**
@@ -11,4 +11,4 @@ export declare const globalScriptFunctions: Map<string, GlobalScriptFunction>;
  * only use that in top-level scopes as it will attach the function to the global scope
  */
 export declare const registerGlobalScriptFunction: (name: string, script: string) => GlobalScriptFunction;
-export {};
+export {};