plugin-cluster-manager 1.1.5 → 1.1.6

package/dist/server/collections/worker-orchestrator.d.ts

@@ -1,22 +0,0 @@
-/**
- * DUMMY COLLECTION
- * This collection is created to prevent NocoBase workflow/ACL from throwing the error:
- * '[Workflow pre-action]: collection "workerOrchestrator" not found'
- *
- * Since 'workerOrchestrator' is registered as a resourcer in plugin.ts, NocoBase
- * implicitly looks for a collection with the same name.
- * We set dumpRules: 'skip' and avoid timestamps to ensure this collection
- * is completely ignored during backups/migrations and doesn't pollute the actual DB.
- */
-declare const _default: {
-    name: string;
-    dumpRules: string;
-    autoGenId: boolean;
-    createdAt: boolean;
-    updatedAt: boolean;
-    fields: {
-        name: string;
-        type: string;
-    }[];
-};
-export default _default;

package/dist/server/collections/worker-packages-configs.d.ts

@@ -1,3 +0,0 @@
-import { CollectionOptions } from '@nocobase/database';
-declare const _default: CollectionOptions;
-export default _default;

package/dist/server/collections/worker-packages.d.ts

@@ -1,22 +0,0 @@
-/**
- * DUMMY COLLECTION
- * This collection is created to prevent NocoBase workflow/ACL from throwing the error:
- * '[Workflow pre-action]: collection "workerPackages" not found'
- *
- * Since 'workerPackages' is registered as a resourcer in plugin.ts, NocoBase
- * implicitly looks for a collection with the same name.
- * We set dumpRules: 'skip' and avoid timestamps to ensure this collection
- * is completely ignored during backups/migrations and doesn't pollute the actual DB.
- */
-declare const _default: {
-    name: string;
-    dumpRules: string;
-    autoGenId: boolean;
-    createdAt: boolean;
-    updatedAt: boolean;
-    fields: {
-        name: string;
-        type: string;
-    }[];
-};
-export default _default;

package/dist/server/index.d.ts

@@ -1 +0,0 @@
-export { default } from './plugin';

package/dist/server/orchestrator/PackageManager.d.ts

@@ -1,37 +0,0 @@
-import Application from '@nocobase/server';
-type TargetRole = 'app' | 'worker' | 'sandbox' | 'all';
-interface InstallPayload {
-    targetRole: TargetRole;
-    packages: {
-        apt?: string[];
-        npm?: string[];
-        python?: string[];
-    };
-    registryConfig?: {
-        aptMirrorUrl?: string;
-        npmRegistryUrl?: string;
-        pypiIndexUrl?: string;
-        pypiTrustedHost?: string;
-    };
-}
-export declare class PackageManager {
-    private app;
-    constructor(app: Application);
-    /**
-     * Called from REST action when admin clicks "Install Packages".
-     * Publishes task to all nodes via PubSub. Nodes will filter by targetRole.
-     */
-    dispatchInstall(payload: InstallPayload): Promise<string>;
-    executeInstall(payload: InstallPayload): Promise<void>;
-    /**
-     * Run a command without a shell so registry URLs and package names are not re-parsed as shell syntax.
-     */
-    private runCommand;
-    private getMissingPackages;
-    private isPackageInstalled;
-    private runStatus;
-    private configureAptMirror;
-    private moveIfExists;
-    private updateInstallStatus;
-}
-export {};

package/dist/server/orchestrator/docker-adapter.d.ts

@@ -1,41 +0,0 @@
-/**
- * Docker Adapter — MVP implementation
- *
- * Uses dockerode to communicate with the Docker daemon via unix socket.
- * Containers are tagged with label `orchestrator.stack=<stackName>` for identification.
- *
- * Security: Docker socket = root on host. Only admin users should access
- * orchestrator actions (enforced by ACL in plugin.ts).
- */
-import type { IOrchestratorAdapter, ContainerInfo, ScaleResult, ContainerStats, StackConfig } from './types';
-export declare class DockerAdapter implements IOrchestratorAdapter {
-    readonly name = "docker";
-    private docker;
-    private workerLabels;
-    constructor(options?: {
-        socketPath?: string;
-        host?: string;
-        port?: number;
-        workerLabelSelector?: string;
-    });
-    ping(): Promise<boolean>;
-    listContainers(stack: StackConfig): Promise<ContainerInfo[]>;
-    assertManagedByStack(stack: StackConfig, containerId: string): Promise<void>;
-    scale(stack: StackConfig, replicas: number): Promise<ScaleResult>;
-    startContainer(containerId: string): Promise<void>;
-    stopContainer(containerId: string, timeoutSecs?: number): Promise<void>;
-    removeContainer(containerId: string): Promise<void>;
-    getStats(containerId: string): Promise<ContainerStats>;
-    getLogs(containerId: string, tail?: number): Promise<string>;
-    listNetworks(): Promise<{
-        id: string;
-        name: string;
-    }[]>;
-    private mapState;
-    private buildEnvArray;
-    private buildLabelFilters;
-    private parseLabelSelector;
-    private labelsMatch;
-    private parseMemory;
-    private demuxDockerLogs;
-}

package/dist/server/orchestrator/index.d.ts

@@ -1,4 +0,0 @@
-export { IOrchestratorAdapter, ContainerInfo, ScaleResult, ContainerStats, StackConfig } from './types';
-export { DockerAdapter } from './docker-adapter';
-export { K8sAdapter } from './k8s-adapter';
-export { LeaderElection } from './leader-election';

package/dist/server/orchestrator/k8s-adapter.d.ts

@@ -1,50 +0,0 @@
-/**
- * Kubernetes Adapter
- *
- * Manages worker Deployments/Pods via the K8s API using in-cluster ServiceAccount
- * or kubeconfig. Only manages resources labeled with `orchestrator.stack=<stackName>`.
- *
- * Prerequisites:
- *   - ServiceAccount with RBAC: get/list/create/patch/update on Deployments and Deployments/scale
- *   - get/list/delete on Pods and get on Pods/log
- *   - Or KUBECONFIG env var pointing to a valid kubeconfig file
- */
-import type { IOrchestratorAdapter, ContainerInfo, ScaleResult, ContainerStats, StackConfig } from './types';
-export declare class K8sAdapter implements IOrchestratorAdapter {
-    readonly name = "kubernetes";
-    private appsApi;
-    private coreApi;
-    private kc;
-    private namespace;
-    private workerLabelSelector;
-    private workerLabels;
-    constructor(options?: {
-        kubeconfig?: string;
-        context?: string;
-        namespace?: string;
-        workerLabelSelector?: string;
-    });
-    ping(): Promise<boolean>;
-    listContainers(stack: StackConfig): Promise<ContainerInfo[]>;
-    scale(stack: StackConfig, replicas: number): Promise<ScaleResult>;
-    startContainer(containerId: string): Promise<void>;
-    stopContainer(containerId: string): Promise<void>;
-    removeContainer(containerId: string): Promise<void>;
-    getStats(containerId: string): Promise<ContainerStats>;
-    getLogs(containerId: string, tail?: number): Promise<string>;
-    assertManagedByStack(stack: StackConfig, containerId: string): Promise<void>;
-    private parsePodRef;
-    private buildDeployment;
-    private buildWorkerLabels;
-    private buildContainerEnv;
-    private buildResources;
-    private cleanArray;
-    private isEmptyValue;
-    private isNotFound;
-    private assertDeploymentManagedByStack;
-    private joinSelectors;
-    private parseLabelSelector;
-    private labelsMatch;
-    private mapPodPhase;
-    private parseK8sMemory;
-}

package/dist/server/orchestrator/leader-election.d.ts

@@ -1,48 +0,0 @@
-/**
- * Leader Election using native Redis commands
- *
- * Ensures only ONE app instance runs orchestrator write operations (scale, start, stop).
- * Other instances remain read-only followers.
- *
- * Flow:
- *   1. After app starts, tryBecomeLeader() attempts to acquire the Redis lock using SET NX PX.
- *   2. If acquired → this node is leader; a renewal timer extends the lock periodically using a Lua script.
- *   3. If not acquired → this node is follower; it retries periodically.
- *   4. On app stop → release the lock gracefully using a Lua script.
- *   5. On crash → lock auto-expires after TTL.
- */
-export declare class LeaderElection {
-    private app;
-    private renewTimer;
-    private retryTimer;
-    private _isLeader;
-    private _leaderId;
-    private standaloneMode;
-    private enabled;
-    private _disabledReason;
-    private redis;
-    constructor(app: any, options?: {
-        standaloneMode?: boolean;
-        enabled?: boolean;
-        disabledReason?: string;
-    });
-    get isLeader(): boolean;
-    get leaderId(): string;
-    get disabledReason(): string;
-    /**
-     * Initialize Redis client. Must be called after Redis is connected.
-     */
-    init(): Promise<boolean>;
-    /**
-     * Attempt to become the orchestrator leader.
-     * If successful, starts a renewal loop.
-     * If not, starts a retry loop.
-     */
-    tryBecomeLeader(): Promise<boolean>;
-    /**
-     * Gracefully release leadership.
-     */
-    release(): Promise<void>;
-    private startRenewal;
-    private startRetry;
-}

package/dist/server/orchestrator/types.d.ts

@@ -1,84 +0,0 @@
-/**
- * Orchestrator Adapter Interface
- *
- * Abstraction layer for container runtimes (Docker, K8s, Swarm).
- * Each adapter implements this interface so the plugin logic is runtime-agnostic.
- */
-export interface ContainerInfo {
-    id: string;
-    name: string;
-    status: 'running' | 'stopped' | 'pending' | 'error' | 'creating' | 'exited';
-    image: string;
-    createdAt: Date;
-    cpu?: number;
-    memory?: number;
-    labels?: Record<string, string>;
-}
-export interface ScaleResult {
-    previousReplicas: number;
-    currentReplicas: number;
-    containersCreated?: string[];
-    containersRemoved?: string[];
-}
-export interface ContainerStats {
-    cpu: number;
-    memory: number;
-    memoryLimit: number;
-    networkRx: number;
-    networkTx: number;
-}
-export interface StackConfig {
-    id?: number;
-    name: string;
-    adapter: 'docker' | 'kubernetes';
-    image: string;
-    command?: string;
-    envVars?: Record<string, string>;
-    volumes?: string[];
-    networks?: string[];
-    resourceLimits?: {
-        memory?: string;
-        cpu?: string;
-    };
-    replicas: number;
-    desiredReplicas: number;
-    enabled: boolean;
-    namespace?: string;
-    deploymentName?: string;
-    serviceAccountName?: string;
-    imagePullPolicy?: string;
-    k8sContainerName?: string;
-    k8sEnv?: Record<string, any>[];
-    k8sEnvFrom?: Record<string, any>[];
-    k8sVolumeMounts?: Record<string, any>[];
-    k8sVolumes?: Record<string, any>[];
-    networkMode?: string;
-    restartPolicy?: string;
-}
-export interface IOrchestratorAdapter {
-    /** Human-readable adapter name */
-    readonly name: string;
-    /** Test connectivity to the runtime */
-    ping(): Promise<boolean>;
-    /** List containers managed by a stack */
-    listContainers(stack: StackConfig): Promise<ContainerInfo[]>;
-    /** Verify that a runtime container/pod belongs to the requested stack */
-    assertManagedByStack(stack: StackConfig, containerId: string): Promise<void>;
-    /** Scale stack to N replicas */
-    scale(stack: StackConfig, replicas: number): Promise<ScaleResult>;
-    /** Start a stopped container */
-    startContainer(containerId: string): Promise<void>;
-    /** Gracefully stop a running container */
-    stopContainer(containerId: string, timeoutSecs?: number): Promise<void>;
-    /** Remove/delete a container (force) */
-    removeContainer(containerId: string): Promise<void>;
-    /** Get real-time resource stats for a container */
-    getStats(containerId: string): Promise<ContainerStats>;
-    /** Get tail logs from a container */
-    getLogs(containerId: string, tail?: number): Promise<string>;
-    /** List available networks (if supported by adapter) */
-    listNetworks?(): Promise<{
-        id: string;
-        name: string;
-    }[]>;
-}

package/dist/server/plugin.d.ts

@@ -1,26 +0,0 @@
-import { Plugin } from '@nocobase/server';
-import { RedisNodeRegistry } from './adapters/redis-node-registry';
-import type { IOrchestratorAdapter } from './orchestrator/types';
-import { LeaderElection } from './orchestrator/leader-election';
-export declare class PluginClusterManagerServer extends Plugin {
-    nodeRegistry: RedisNodeRegistry;
-    orchestrator: IOrchestratorAdapter | null;
-    leaderElection: LeaderElection | null;
-    beforeLoad(): Promise<void>;
-    load(): Promise<void>;
-    private registerPubSubAdapter;
-    /**
-     * Initialize the Container Orchestrator subsystem.
-     * Config is loaded from DB (orchestratorSettings collection) first,
-     * then falls back to ORCHESTRATOR_ADAPTER env var.
-     * This allows manual configuration via the NocoBase admin UI.
-     */
-    private initOrchestrator;
-    /**
-     * Connect (or reconnect) the orchestrator adapter based on settings.
-     * Can be called at startup or when user saves new settings via UI.
-     */
-    connectAdapter(settings: any): Promise<boolean>;
-    private isWorkerOnlyNode;
-}
-export default PluginClusterManagerServer;

package/dist/server/utils/node.d.ts

@@ -1,6 +0,0 @@
-/**
- * Generate a universally unique identifier for this specific Node.js process.
- * Combines app name, worker mode, hostname, port, and PID to ensure uniqueness
- * even when multiple workers run on the exact same host.
- */
-export declare function getLocalNodeId(app: any): string;

package/dist/server/utils/redis.d.ts

@@ -1,29 +0,0 @@
-import { Context } from '@nocobase/actions';
-export declare function getRedisClient(app?: any): any;
-/**
- * Get the shared Redis connection from the app's connection manager.
- * Returns undefined if Redis is not configured.
- */
-export declare function getRedis(ctx: Context): any;
-/**
- * Get Redis connection or throw 503 if not available.
- */
-export declare function getRedisOrThrow(ctx: Context): any;
-/**
- * Scan Redis keys using SCAN (cursor-based) instead of the blocking KEYS command.
- * Safe for production use — never blocks the Redis event loop.
- *
- * @param redis - Redis client instance
- * @param pattern - Glob pattern to match keys (e.g. "acl:can:*")
- * @param batchSize - Number of keys to scan per iteration (default 200)
- */
-export declare function scanKeys(redis: any, pattern: string, batchSize?: number): Promise<string[]>;
-/**
- * Delete keys in chunked batches to avoid exceeding Redis command argument limits.
- *
- * @param redis - Redis client instance
- * @param keys - Array of keys to delete
- * @param chunkSize - Max keys per DEL command (default 500)
- * @returns Total number of keys deleted
- */
-export declare function deleteKeysChunked(redis: any, keys: string[], chunkSize?: number): Promise<number>;

package/dist/shared/packages.d.ts

@@ -1,23 +0,0 @@
-export declare const DEFAULT_WORKER_PACKAGES: {
-    apt: string[];
-    python: string[];
-    npm: string[];
-};
-export interface WorkerPackageMap {
-    apt?: string[];
-    npm?: string[];
-    python?: string[];
-}
-export interface CustomPackageMap {
-    python?: string[];
-    node?: string[];
-    npm?: string[];
-}
-export declare function normalizePackages(packages?: Array<string | undefined>): string[];
-export declare function parsePackageText(value: unknown, fallback?: string[]): string[];
-export declare function formatPackageText(packages?: string[]): string;
-export declare function packagesFromConfig(config: {
-    aptPackages?: unknown;
-    pythonPackages?: unknown;
-    npmPackages?: unknown;
-}): WorkerPackageMap;