@kici-dev/orchestrator 0.19.0 → 0.20.1

package/dist/cli/commands/shared/container-agent-image-check.d.ts

@@ -0,0 +1,67 @@
+/**
+ * The container-scaler agent image check `kici-admin orchestrator upgrade`
+ * runs before it restarts the service.
+ *
+ * A container scaler spawns each agent from the image its label set names, not
+ * from the upgraded orchestrator. So an upgrade leaves container agents on the
+ * old release when a label set pins an older `kici-agent:<version>`, or names
+ * the moving `:latest` tag with the default `imagePullPolicy: IfNotPresent`: a
+ * host that already pulled `:latest` keeps that image. The check only warns:
+ * it never rewrites the operator's scaler config and never stops the upgrade.
+ */
+import { type ScalerConfig } from '../../../scaler/types.js';
+/** Why a container label set keeps spawning an old agent after the upgrade. */
+export declare enum AgentImageIssue {
+    /** `:latest` (or no tag) with `IfNotPresent`: the host keeps the image it pulled. */
+    MovingTag = "moving-tag",
+    /** A `kici-agent:<version>` older than the release the upgrade installs. */
+    OlderPin = "older-pin"
+}
+export interface AgentImageFinding {
+    issue: AgentImageIssue;
+    scaler: string;
+    labels: string[];
+    image: string;
+    message: string;
+}
+/** An image reference split into its repository, tag and digest. */
+export interface ImageRefParts {
+    repository: string;
+    tag: string | null;
+    digest: string | null;
+}
+/**
+ * Split `[registry/]path/name[:tag][@digest]`. A `:` before the last `/` is a
+ * registry port, not a tag.
+ */
+export declare function parseImageRef(image: string): ImageRefParts;
+export interface CheckAgentImagesArgs {
+    config: ScalerConfig;
+    /** The release the upgrade installs, or null when the caller does not know it. */
+    targetVersion: string | null;
+    /** The main scaler config file, for the remedy text. */
+    scalerConfigPath: string;
+    /** The `KICI_SCALER_CONFIG_DIR` directory, when one is set. */
+    scalerConfigDir?: string;
+}
+/**
+ * Every container-scaler label set whose agent image an upgrade to
+ * `targetVersion` leaves unchanged. An empty result means each agent image is
+ * pinned to the target (or newer), pulled on every spawn, or not a KiCI agent.
+ */
+export declare function checkContainerAgentImages(args: CheckAgentImagesArgs): AgentImageFinding[];
+export interface WarnAgentImagesArgs {
+    envFilePath: string;
+    workingDirectory: string;
+    /** The release the upgrade installs, or null when the caller does not know it. */
+    targetVersion: string | null;
+    warn: (line: string) => void;
+}
+/**
+ * Print one warning per container label set whose agent image the upgrade
+ * leaves unchanged. Never throws, and stays silent when the env file or the
+ * scaler config cannot be read: the bare-metal `binaryPath` check, which runs
+ * first on the same files, already reports that.
+ */
+export declare function warnAboutContainerAgentImages(args: WarnAgentImagesArgs): Promise<void>;
+//# sourceMappingURL=container-agent-image-check.d.ts.map