@catladder/pipeline 3.7.0 → 3.8.0

package/dist/constants.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.DOCKER_REGISTRY = exports.PIPELINE_IMAGE_TAG = void 0;
-exports.PIPELINE_IMAGE_TAG = "v3-7-0-83dd094e" || "latest";
+exports.PIPELINE_IMAGE_TAG = "v3-8-0-7a8419fc" || "latest";
 exports.DOCKER_REGISTRY = "git.panter.ch:5001/catladder/catladder" || "git.panter.ch:5001/catladder/catladder";

package/dist/deploy/cloudRun/createJobs/cloudRunServices.js

@@ -51,6 +51,7 @@ var getJobOrServiceArgs_1 = require("../utils/getJobOrServiceArgs");
 var getServiceName_1 = require("../utils/getServiceName");
 var common_1 = require("./common");
 var constants_1 = require("./constants");
+var healthCheck_1 = require("./healthCheck");
 var volumes_1 = require("./volumes");
 var getServiceDeployScript = function (context, service, nameSuffix) {
   var _a, _b, _c, _d, _e, _f;
@@ -60,7 +61,7 @@ var getServiceDeployScript = function (context, service, nameSuffix) {
   var command = service !== true ? (_a = service === null || service === void 0 ? void 0 : service.command) !== null && _a !== void 0 ? _a : context.build.type !== "disabled" ? context.build.config.startCommand : undefined : undefined;
   var commandArray = command ? Array.isArray(command) ? command : command.split(" ") : undefined;
   var fullServiceName = serviceName.concat(nameSuffix !== null && nameSuffix !== void 0 ? nameSuffix : "");
-  var argsString = createArgsString_1.createArgsString.apply(void 0, __spreadArray([__assign(__assign({
+  var argsString = createArgsString_1.createArgsString.apply(void 0, __spreadArray([__assign(__assign(__assign({
     // command as empty string resets it to default (uses the image's entrypoint)
     command: commandArray ? '"' + commandArray.join(",") + '"' : '""',
     args: (0, getJobOrServiceArgs_1.getCloudRunServiceOrJobArgsArg)(customConfig === null || customConfig === void 0 ? void 0 : customConfig.args)
@@ -87,7 +88,7 @@ var getServiceDeployScript = function (context, service, nameSuffix) {
     "execution-environment": customConfig === null || customConfig === void 0 ? void 0 : customConfig.executionEnvironment,
     gpu: customConfig === null || customConfig === void 0 ? void 0 : customConfig.gpu,
     "gpu-type": customConfig === null || customConfig === void 0 ? void 0 : customConfig.gpuType
-  })], __read((0, volumes_1.createVolumeConfig)(customConfig === null || customConfig === void 0 ? void 0 : customConfig.volumes, "service")), false));
+  }), (0, healthCheck_1.healthCheckCliArgs)(customConfig === null || customConfig === void 0 ? void 0 : customConfig.healthCheck))], __read((0, volumes_1.createVolumeConfig)(customConfig === null || customConfig === void 0 ? void 0 : customConfig.volumes, "service")), false));
   var version = requiresBeta(customConfig) ? "beta" : undefined;
   return "".concat((0, common_1.gcloudRunCmd)(version), " deploy ").concat(fullServiceName, " ").concat(argsString);
 };
@@ -110,5 +111,8 @@ var requiresBeta = function (config) {
   if (config.gpu && config.gpu > 0) {
     return true;
   }
+  if (config.healthCheck !== undefined) {
+    return true;
+  }
   return false;
 };

package/dist/deploy/cloudRun/createJobs/healthCheck.d.ts

@@ -0,0 +1,5 @@
+import { type DeployConfigCloudRunService } from "../../types";
+export declare function healthCheckCliArgs(healthCheck: DeployConfigCloudRunService["healthCheck"]): {
+  "startup-probe": string;
+  "liveness-probe": string;
+} | undefined;

package/dist/deploy/cloudRun/createJobs/healthCheck.js

@@ -0,0 +1,82 @@
+"use strict";
+
+var __read = this && this.__read || function (o, n) {
+  var m = typeof Symbol === "function" && o[Symbol.iterator];
+  if (!m) return o;
+  var i = m.call(o),
+    r,
+    ar = [],
+    e;
+  try {
+    while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+  } catch (error) {
+    e = {
+      error: error
+    };
+  } finally {
+    try {
+      if (r && !r.done && (m = i["return"])) m.call(i);
+    } finally {
+      if (e) throw e.error;
+    }
+  }
+  return ar;
+};
+var __spreadArray = this && this.__spreadArray || function (to, from, pack) {
+  if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+    if (ar || !(i in from)) {
+      if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+      ar[i] = from[i];
+    }
+  }
+  return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.healthCheckCliArgs = void 0;
+var types_1 = require("../../types");
+var PORT = 8080;
+function healthCheckCliArgs(healthCheck) {
+  var shouldNotSetHealthCheck = healthCheck === undefined;
+  if (shouldNotSetHealthCheck) {
+    return undefined;
+  }
+  var shouldUseDefaultProbe = healthCheck === true;
+  if (shouldUseDefaultProbe) {
+    return {
+      "startup-probe": toArgValue(probeToKeyValuePairs(types_1.defaultStartupProbe)),
+      "liveness-probe": toArgValue(probeToKeyValuePairs(types_1.defaultLivenessProbe))
+    };
+  }
+  return {
+    "startup-probe": toArgValue(probeToKeyValuePairs(healthCheck.startupProbe)),
+    "liveness-probe": healthCheck.livenessProbe ? toArgValue(probeToKeyValuePairs(healthCheck.livenessProbe)) : "" // NOTE: empty string ("") removes liveness probe
+  };
+}
+exports.healthCheckCliArgs = healthCheckCliArgs;
+function probeToKeyValuePairs(probe) {
+  var sharedArgs = Object.entries({
+    initialDelaySeconds: probe.initialDelaySeconds,
+    timeoutSeconds: probe.timeoutSeconds,
+    periodSeconds: probe.periodSeconds,
+    failureThreshold: probe.failureThreshold
+  });
+  switch (probe.type) {
+    case "tcp":
+      return __spreadArray(__spreadArray([], __read(sharedArgs), false), [["tcpSocket.port", PORT]], false);
+    case "http1":
+      return __spreadArray(__spreadArray([], __read(sharedArgs), false), [["httpGet.port", PORT], ["httpGet.path", probe.path]], false);
+    default:
+      probe;
+      return [];
+  }
+}
+function toArgValue(keyValues) {
+  return keyValues.map(function (_a) {
+    var _b = __read(_a, 2),
+      key = _b[0],
+      value = _b[1];
+    return "".concat(key, "=").concat(value);
+  }).join(",");
+}

package/dist/deploy/types/googleCloudRun.d.ts

@@ -136,7 +136,77 @@ export type DeployConfigCloudRunService = {
    * args to pass to the command
    */
   args?: string[];
+  /**
+   * Configuration of the health check.
+   *
+   * When set to `true`, startup and liveness probes will be
+   * configured to `defaultStartupProbe` and `defaultLivenessProbe`.
+   *
+   * When not set, default Cloud Run's health check
+   * configuration is used (startup TCP probe and no liveness probe).
+   */
+  healthCheck?: true | {
+    /**
+     * Startup probe configuration.
+     */
+    startupProbe: DeployConfigCloudRunProbe;
+    /**
+     * Liveness probe configuration.
+     * `false` disables the liveness probe.
+     */
+    livenessProbe: false | DeployConfigCloudRunProbe;
+  };
 } & DeployConfigCloudRunWithVolumes & DeployConfigCloudRunNetworkConfig;
+export declare const defaultStartupProbe: DeployConfigCloudRunProbe;
+export declare const defaultLivenessProbe: DeployConfigCloudRunProbe;
+export type DeployConfigCloudRunProbe = DeployConfigCloudRunHttp1Probe | DeployConfigCloudRunTcpProbe;
+export type DeployConfigCloudRunProbeShared = {
+  /**
+   * The period in seconds at which to perform the probe.
+   * For example 2 to perform the probe every 2 seconds.
+   * Specify a value **from 1 second to 240** seconds.
+   */
+  periodSeconds: number;
+  /**
+   * The number of seconds to wait after the container has started before performing the first probe.
+   * Specify a value **from 0 seconds to 240** seconds.
+   */
+  initialDelaySeconds: number;
+  /**
+   * The number of seconds to wait until the probe times out.
+   * This value cannot exceed the value specified for `period`.
+   * Specify a value **from 1 to 240**.
+   */
+  timeoutSeconds: number;
+  /**
+   * The number of times to retry the probe before shutting down the container.
+   */
+  failureThreshold: number;
+};
+export type DeployConfigCloudRunTcpProbe = DeployConfigCloudRunProbeShared & {
+  /**
+   * Cloud Run makes a TCP connection to open the TCP Socket on the specified port.
+   * If Cloud Run is unable to establish a connection, it indicates a failure.
+   */
+  type: "tcp";
+};
+export type DeployConfigCloudRunHttp1Probe = DeployConfigCloudRunProbeShared & {
+  /**
+   * **This will NOT work with http2 enabled services**
+   *
+   * Cloud Run makes an HTTP GET request to the service health check endpoint (for example, /ready).
+   * Any response between 200 and 400 is a success, everything else indicates failure.
+   *
+   * If a startup probe does not succeed within the specified time (failureThreshold * period), which cannot exceed 240 seconds, the container is shut down.
+   *
+   * If the HTTP startup probe succeeds within the specified time, and you have enabled liveness probe, the HTTP liveness probe is started.
+   */
+  type: "http1";
+  /**
+   * the route path to check for health status of the service starting with a `/`.
+   */
+  path: string;
+};
 export type DeployConfigCloudRunNetworkConfig = {
   network?: string;
   /**

package/dist/deploy/types/googleCloudRun.js

@@ -1,5 +1,30 @@
 "use strict";
 
+var __assign = this && this.__assign || function () {
+  __assign = Object.assign || function (t) {
+    for (var s, i = 1, n = arguments.length; i < n; i++) {
+      s = arguments[i];
+      for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+    }
+    return t;
+  };
+  return __assign.apply(this, arguments);
+};
 Object.defineProperty(exports, "__esModule", {
   value: true
+});
+exports.defaultLivenessProbe = exports.defaultStartupProbe = void 0;
+exports.defaultStartupProbe = {
+  type: "http1",
+  path: "/__health",
+  initialDelaySeconds: 5,
+  timeoutSeconds: 1,
+  periodSeconds: 30,
+  failureThreshold: 3
+};
+exports.defaultLivenessProbe = __assign(__assign({}, exports.defaultStartupProbe), {
+  initialDelaySeconds: 0,
+  timeoutSeconds: 10,
+  periodSeconds: 30,
+  failureThreshold: 3
 });