@kapeta/local-cluster-service 0.35.0 → 0.36.0

package/dist/esm/src/operatorManager.js

@@ -7,7 +7,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.operatorManager = exports.KIND_OPERATOR = void 0;
+exports.operatorManager = exports.KIND_BLOCK_OPERATOR = exports.KIND_RESOURCE_OPERATOR = void 0;
 const path_1 = __importDefault(require("path"));
 const md5_1 = __importDefault(require("md5"));
 const serviceManager_1 = require("./serviceManager");
@@ -20,7 +20,8 @@ const nodejs_utils_1 = require("@kapeta/nodejs-utils");
 const lodash_1 = __importDefault(require("lodash"));
 const async_lock_1 = __importDefault(require("async-lock"));
 const taskManager_1 = require("./taskManager");
-exports.KIND_OPERATOR = 'core/resource-type-operator';
+exports.KIND_RESOURCE_OPERATOR = 'core/resource-type-operator';
+exports.KIND_BLOCK_OPERATOR = 'core/block-type-operator';
 const KIND_PLAN = 'core/plan';
 class Operator {
     _data;
@@ -50,18 +51,18 @@ class OperatorManager {
     /**
      * Get operator definition for resource type
      */
-    async getOperator(resourceType, version) {
-        const operators = await definitionsManager_1.definitionsManager.getDefinitions(exports.KIND_OPERATOR);
+    async getOperator(fullName, version) {
+        const operators = await definitionsManager_1.definitionsManager.getDefinitions([exports.KIND_RESOURCE_OPERATOR, exports.KIND_BLOCK_OPERATOR]);
         const operator = operators.find((operator) => operator.definition &&
             operator.definition.metadata &&
             operator.definition.metadata.name &&
-            operator.definition.metadata.name.toLowerCase() === resourceType.toLowerCase() &&
+            operator.definition.metadata.name.toLowerCase() === fullName.toLowerCase() &&
             operator.version === version);
         if (!operator) {
-            throw new Error(`Unknown resource type: ${resourceType}:${version}`);
+            throw new Error(`Unknown operator type: ${fullName}:${version}`);
         }
         if (!operator.definition.spec || !operator.definition.spec.local) {
-            throw new Error(`Operator missing local definition: ${resourceType}:${version}`);
+            throw new Error(`Operator missing local definition: ${fullName}:${version}`);
         }
         return new Operator(operator);
     }
@@ -96,7 +97,7 @@ class OperatorManager {
         const kindUri = (0, nodejs_utils_1.parseKapetaUri)(blockResource.kind);
         const operator = await this.getOperator(resourceType, kindUri.version);
         const credentials = operator.getCredentials();
-        const container = await this.ensureResource(systemId, resourceType, kindUri.version);
+        const container = await this.ensureOperator(systemId, resourceType, kindUri.version);
         const portInfo = await container.getPort(portType);
         if (!portInfo) {
             throw new Error('Unknown resource port type : ' + resourceType + '#' + portType);
@@ -119,16 +120,15 @@ class OperatorManager {
     /**
      * Ensure we have a running operator of given type
      *
-     * @param {string} systemId
-     * @param {string} resourceType
-     * @param {string} version
-     * @return {Promise<ContainerInfo>}
+     * @param systemId the plan ref
+     * @param kind the full name - e.g. myhandle/rabbitmq
+     * @param version the version of the operator
      */
-    async ensureResource(systemId, resourceType, version) {
+    async ensureOperator(systemId, kind, version) {
         systemId = (0, nodejs_utils_1.normalizeKapetaUri)(systemId);
-        const key = `${systemId}#${resourceType}:${version}`;
+        const key = `${systemId}#${kind}:${version}`;
         return await this.operatorLock.acquire(key, async () => {
-            const operator = await this.getOperator(resourceType, version);
+            const operator = await this.getOperator(kind, version);
             const operatorData = operator.getLocalData();
             const portTypes = Object.keys(operatorData.ports);
             portTypes.sort();
@@ -136,7 +136,7 @@ class OperatorManager {
             for (let i = 0; i < portTypes.length; i++) {
                 const portType = portTypes[i];
                 let containerPortInfo = operatorData.ports[portType];
-                const hostPort = await serviceManager_1.serviceManager.ensureServicePort(systemId, resourceType, portType);
+                const hostPort = await serviceManager_1.serviceManager.ensureServicePort(systemId, kind, portType);
                 const portInfo = (0, utils_1.toPortInfo)(containerPortInfo);
                 const portId = portInfo.port + '/' + portInfo.type;
                 ports[portId] = {
@@ -144,7 +144,7 @@ class OperatorManager {
                     hostPort,
                 };
             }
-            const nameParts = [systemId, resourceType.toLowerCase(), version];
+            const nameParts = [systemId, kind.toLowerCase(), version];
             const containerName = `kapeta-resource-${(0, md5_1.default)(nameParts.join('_'))}`;
             const PortBindings = {};
             const Env = [];
@@ -152,7 +152,7 @@ class OperatorManager {
             const Labels = {
                 kapeta: 'true',
                 [containerManager_1.COMPOSE_LABEL_PROJECT]: systemUri.id.replace(/[^a-z0-9]/gi, '_'),
-                [containerManager_1.COMPOSE_LABEL_SERVICE]: [resourceType, version].join('_').replace(/[^a-z0-9]/gi, '_'),
+                [containerManager_1.COMPOSE_LABEL_SERVICE]: [kind, version].join('_').replace(/[^a-z0-9]/gi, '_'),
             };
             const operatorMetadata = operator.getDefinitionInfo().definition.metadata;
             const bindHost = (0, utils_1.getBindHost)();
@@ -167,7 +167,7 @@ class OperatorManager {
                 ];
                 Labels[containerManager_1.CONTAINER_LABEL_PORT_PREFIX + portInfo.hostPort] = portInfo.type;
             });
-            const Mounts = await containerManager_1.containerManager.createVolumes(systemId, resourceType, operatorData.mounts);
+            const Mounts = await containerManager_1.containerManager.createVolumes(systemId, kind, operatorData.mounts);
             lodash_1.default.forEach(operatorData.env, (value, name) => {
                 Env.push(name + '=' + value);
             });

package/dist/esm/src/types.d.ts

@@ -76,6 +76,7 @@ export type LocalImageOptions<Credentials = AnyMap, Options = AnyMap> = {
     cmd?: string;
     env?: AnyMap;
     health?: Health;
+    singleton?: boolean;
     mounts?: {
         [key: string]: string;
     };

package/dist/esm/src/utils/BlockInstanceRunner.d.ts

@@ -2,9 +2,7 @@
  * Copyright 2023 Kapeta Inc.
  * SPDX-License-Identifier: BUSL-1.1
  */
-import { DefinitionInfo } from '@kapeta/local-cluster-config';
-import { KapetaURI } from '@kapeta/nodejs-utils';
-import { AnyMap, BlockProcessParams, ProcessInfo, StringMap } from '../types';
+import { AnyMap, ProcessInfo } from '../types';
 export declare function resolvePortType(portType: string): string;
 export declare class BlockInstanceRunner {
     private readonly _systemId;
@@ -20,16 +18,7 @@ export declare class BlockInstanceRunner {
      */
     private _startLocalProcess;
     private _startDockerProcess;
-    /**
-     *
-     * @param blockInstance
-     * @param blockUri
-     * @param providerDefinition
-     * @param {{[key:string]:string}} env
-     * @return {Promise<ProcessDetails>}
-     * @private
-     */
-    _startOperatorProcess(blockInstance: BlockProcessParams, blockUri: KapetaURI, providerDefinition: DefinitionInfo, env: StringMap): Promise<ProcessInfo>;
+    private _startOperatorProcess;
     private getDockerPortBindings;
     private ensureContainer;
     private _handleContainer;

package/dist/esm/src/utils/BlockInstanceRunner.js

@@ -19,6 +19,7 @@ const clusterService_1 = require("../clusterService");
 const types_1 = require("../types");
 const definitionsManager_1 = require("../definitionsManager");
 const node_os_1 = __importDefault(require("node:os"));
+const taskManager_1 = require("../taskManager");
 const KIND_BLOCK_TYPE_OPERATOR = 'core/block-type-operator';
 const KAPETA_SYSTEM_ID = 'KAPETA_SYSTEM_ID';
 const KAPETA_BLOCK_REF = 'KAPETA_BLOCK_REF';
@@ -155,7 +156,7 @@ class BlockInstanceRunner {
         if (!dockerImage) {
             throw new Error(`Missing docker image information: ${JSON.stringify(localContainer)}`);
         }
-        const containerName = (0, utils_1.getBlockInstanceContainerName)(this._systemId, blockInstance.id);
+        const containerName = await (0, utils_1.getBlockInstanceContainerName)(this._systemId, blockInstance.id, targetKindUri.id);
         const startCmd = localContainer.handlers?.onCreate ? localContainer.handlers.onCreate : '';
         const dockerOpts = localContainer.options ?? {};
         const homeDir = localContainer.userHome ? localContainer.userHome : '/root';
@@ -241,7 +242,7 @@ class BlockInstanceRunner {
             throw new Error(`Block type not found: ${kindUri.id}`);
         }
         const { PortBindings, ExposedPorts, addonEnv } = await this.getDockerPortBindings(blockInstance, assetVersion, providerVersion);
-        const containerName = (0, utils_1.getBlockInstanceContainerName)(this._systemId, blockInstance.id);
+        const containerName = await (0, utils_1.getBlockInstanceContainerName)(this._systemId, blockInstance.id, kindUri.id);
         // For windows we need to default to root
         const innerHome = process.platform === 'win32' ? '/root/.kapeta' : local_cluster_config_1.default.getKapetaBasedir();
         const systemUri = (0, nodejs_utils_1.parseKapetaUri)(this._systemId);
@@ -268,15 +269,6 @@ class BlockInstanceRunner {
             },
         });
     }
-    /**
-     *
-     * @param blockInstance
-     * @param blockUri
-     * @param providerDefinition
-     * @param {{[key:string]:string}} env
-     * @return {Promise<ProcessDetails>}
-     * @private
-     */
     async _startOperatorProcess(blockInstance, blockUri, providerDefinition, env) {
         const { assetFile } = local_cluster_config_1.default.getRepositoryAssetInfoPath(blockUri.handle, blockUri.name, blockUri.version);
         const kapetaYmlPath = assetFile;
@@ -290,81 +282,97 @@ class BlockInstanceRunner {
         }
         const local = spec.local;
         const dockerImage = local.image;
-        //We only want 1 operator per operator type - across all local systems
-        const containerName = (0, utils_1.getBlockInstanceContainerName)(this._systemId, blockInstance.id);
-        const logs = new LogData_1.LogData();
-        const bindHost = (0, utils_1.getBindHost)();
-        const ExposedPorts = {};
-        const addonEnv = {};
-        const PortBindings = {};
-        let HealthCheck = undefined;
-        let Mounts = [];
-        const localPorts = local.ports ?? {};
-        const labels = {};
-        const promises = Object.entries(localPorts).map(async ([portType, value]) => {
-            const portInfo = (0, utils_1.toPortInfo)(value);
-            const dockerPort = `${portInfo.port}/${portInfo.type}`;
-            ExposedPorts[dockerPort] = {};
-            addonEnv[`KAPETA_LOCAL_SERVER_PORT_${portType.toUpperCase()}`] = `${portInfo.port}`;
-            const publicPort = await serviceManager_1.serviceManager.ensureServicePort(this._systemId, blockInstance.id, portType);
-            PortBindings[dockerPort] = [
-                {
-                    HostIp: bindHost,
-                    HostPort: `${publicPort}`,
-                },
-            ];
-            labels[containerManager_1.CONTAINER_LABEL_PORT_PREFIX + publicPort] = portType;
-        });
-        await Promise.all(promises);
-        if (local.env) {
-            Object.entries(local.env).forEach(([key, value]) => {
-                addonEnv[key] = value;
-            });
-        }
-        if (local.mounts) {
-            Mounts = await containerManager_1.containerManager.createVolumes(this._systemId, blockUri.id, local.mounts);
-        }
-        if (local.health) {
-            HealthCheck = containerManager_1.containerManager.toDockerHealth(local.health);
+        const operatorUri = local.singleton ? (0, nodejs_utils_1.parseKapetaUri)(providerRef) : blockUri;
+        const operatorId = local.singleton ? providerRef : blockInstance.id;
+        const operatorRef = local.singleton ? providerRef : blockInstance.ref;
+        if (local.singleton && env) {
+            env[KAPETA_BLOCK_REF] = operatorRef;
+            env[KAPETA_INSTANCE_ID] = operatorId;
         }
-        // For windows we need to default to root
-        const innerHome = process.platform === 'win32' ? '/root/.kapeta' : local_cluster_config_1.default.getKapetaBasedir();
-        const systemUri = (0, nodejs_utils_1.parseKapetaUri)(this._systemId);
-        logs.addLog(`Creating new container for block: ${containerName}`);
-        const out = await this.ensureContainer({
-            Image: dockerImage,
-            name: containerName,
-            ExposedPorts,
-            HealthCheck,
-            HostConfig: {
-                Binds: [
+        const containerName = await (0, utils_1.getBlockInstanceContainerName)(this._systemId, blockInstance.id, providerRef);
+        const task = taskManager_1.taskManager.add(`container:start:${containerName}`, async () => {
+            const logs = new LogData_1.LogData();
+            const bindHost = (0, utils_1.getBindHost)();
+            const ExposedPorts = {};
+            const addonEnv = {};
+            const PortBindings = {};
+            let HealthCheck = undefined;
+            let Mounts = [];
+            const localPorts = local.ports ?? {};
+            const labels = {};
+            const promises = Object.entries(localPorts).map(async ([portType, value]) => {
+                const portInfo = (0, utils_1.toPortInfo)(value);
+                const dockerPort = `${portInfo.port}/${portInfo.type}`;
+                ExposedPorts[dockerPort] = {};
+                addonEnv[`KAPETA_LOCAL_SERVER_PORT_${portType.toUpperCase()}`] = `${portInfo.port}`;
+                const publicPort = await serviceManager_1.serviceManager.ensureServicePort(this._systemId, operatorId, portType);
+                PortBindings[dockerPort] = [
+                    {
+                        HostIp: bindHost,
+                        HostPort: `${publicPort}`,
+                    },
+                ];
+                labels[containerManager_1.CONTAINER_LABEL_PORT_PREFIX + publicPort] = portType;
+            });
+            await Promise.all(promises);
+            if (local.env) {
+                Object.entries(local.env).forEach(([key, value]) => {
+                    addonEnv[key] = value;
+                });
+            }
+            if (local.mounts) {
+                Mounts = await containerManager_1.containerManager.createVolumes(this._systemId, operatorUri.id, local.mounts);
+            }
+            if (local.health) {
+                HealthCheck = containerManager_1.containerManager.toDockerHealth(local.health);
+            }
+            // For windows we need to default to root
+            const innerHome = process.platform === 'win32' ? '/root/.kapeta' : local_cluster_config_1.default.getKapetaBasedir();
+            const Binds = local.singleton
+                ? [`${(0, containerManager_1.toLocalBindVolume)(local_cluster_config_1.default.getKapetaBasedir())}:${innerHome}`]
+                : [
                     `${(0, containerManager_1.toLocalBindVolume)(kapetaYmlPath)}:/kapeta.yml:ro`,
                     `${(0, containerManager_1.toLocalBindVolume)(local_cluster_config_1.default.getKapetaBasedir())}:${innerHome}`,
+                ];
+            const systemUri = (0, nodejs_utils_1.parseKapetaUri)(this._systemId);
+            console.log(`Ensuring container for operator block: ${containerName} [singleton: ${!!local.singleton}]`);
+            logs.addLog(`Ensuring container for operator block: ${containerName}`);
+            const out = await this.ensureContainer({
+                Image: dockerImage,
+                name: containerName,
+                ExposedPorts,
+                HealthCheck,
+                HostConfig: {
+                    Binds,
+                    PortBindings,
+                    Mounts,
+                },
+                Labels: {
+                    ...labels,
+                    instance: operatorId,
+                    [containerManager_1.COMPOSE_LABEL_PROJECT]: systemUri.id.replace(/[^a-z0-9]/gi, '_'),
+                    [containerManager_1.COMPOSE_LABEL_SERVICE]: operatorUri.id.replace(/[^a-z0-9]/gi, '_'),
+                },
+                Env: [
+                    `KAPETA_INSTANCE_NAME=${operatorRef}`,
+                    `KAPETA_LOCAL_CLUSTER_PORT=${clusterService_1.clusterService.getClusterServicePort()}`,
+                    ...DOCKER_ENV_VARS,
+                    ...Object.entries({
+                        ...env,
+                        ...addonEnv,
+                    }).map(([key, value]) => `${key}=${value}`),
                 ],
-                PortBindings,
-                Mounts,
-            },
-            Labels: {
-                ...labels,
-                instance: blockInstance.id,
-                [containerManager_1.COMPOSE_LABEL_PROJECT]: systemUri.id.replace(/[^a-z0-9]/gi, '_'),
-                [containerManager_1.COMPOSE_LABEL_SERVICE]: blockUri.id.replace(/[^a-z0-9]/gi, '_'),
-            },
-            Env: [
-                `KAPETA_INSTANCE_NAME=${blockInstance.ref}`,
-                `KAPETA_LOCAL_CLUSTER_PORT=${clusterService_1.clusterService.getClusterServicePort()}`,
-                ...DOCKER_ENV_VARS,
-                ...Object.entries({
-                    ...env,
-                    ...addonEnv,
-                }).map(([key, value]) => `${key}=${value}`),
-            ],
+            });
+            const portTypes = local.ports ? Object.keys(local.ports) : [];
+            if (portTypes.length > 0) {
+                out.portType = portTypes[0];
+            }
+            return out;
+        }, {
+            name: `Starting container for ${providerRef}`,
+            systemId: this._systemId,
         });
-        const portTypes = local.ports ? Object.keys(local.ports) : [];
-        if (portTypes.length > 0) {
-            out.portType = portTypes[0];
-        }
-        return out;
+        return task.wait();
     }
     async getDockerPortBindings(blockInstance, assetVersion, providerVersion) {
         const bindHost = (0, utils_1.getBindHost)();

package/dist/esm/src/utils/utils.d.ts

@@ -4,7 +4,7 @@
  */
 import { EntityList } from '@kapeta/schemas';
 import { AnyMap, PortInfo } from '../types';
-export declare function getBlockInstanceContainerName(systemId: string, instanceId: string): string;
+export declare function getBlockInstanceContainerName(systemId: string, instanceId: string, blockType?: string): Promise<string>;
 export declare function toPortInfo(port: PortInfo): {
     port: number;
     type: string;

package/dist/esm/src/utils/utils.js

@@ -13,7 +13,30 @@ const yaml_1 = __importDefault(require("yaml"));
 const md5_1 = __importDefault(require("md5"));
 const lodash_1 = __importDefault(require("lodash"));
 const local_cluster_config_1 = __importDefault(require("@kapeta/local-cluster-config"));
-function getBlockInstanceContainerName(systemId, instanceId) {
+const definitionsManager_1 = require("../definitionsManager");
+const nodejs_utils_1 = require("@kapeta/nodejs-utils");
+const operatorManager_1 = require("../operatorManager");
+const assetManager_1 = require("../assetManager");
+async function getBlockInstanceContainerName(systemId, instanceId, blockType) {
+    if (!blockType) {
+        const instance = await assetManager_1.assetManager.getBlockInstance(systemId, instanceId);
+        if (!instance) {
+            throw new Error(`Instance ${instanceId} not found in plan ${systemId}`);
+        }
+        const block = await assetManager_1.assetManager.getAsset(instance.block.ref);
+        if (!block) {
+            throw new Error(`Block ${instance.block.ref} not found`);
+        }
+        blockType = block.data.kind;
+    }
+    const typeDefinition = await definitionsManager_1.definitionsManager.getDefinition(blockType);
+    if (!typeDefinition) {
+        throw new Error(`Block type ${blockType} not found`);
+    }
+    if ((0, nodejs_utils_1.parseKapetaUri)(typeDefinition.definition.kind).fullName === operatorManager_1.KIND_BLOCK_OPERATOR &&
+        typeDefinition.definition.spec?.local?.singleton) {
+        return `kapeta-instance-operator-${(0, md5_1.default)(systemId + blockType)}`;
+    }
     return `kapeta-block-instance-${(0, md5_1.default)(systemId + instanceId)}`;
 }
 exports.getBlockInstanceContainerName = getBlockInstanceContainerName;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kapeta/local-cluster-service",
-    "version": "0.35.0",
+    "version": "0.36.0",
     "description": "Manages configuration, ports and service discovery for locally running Kapeta systems",
     "type": "commonjs",
     "exports": {

package/src/containerManager.ts

@@ -694,7 +694,7 @@ class ContainerManager {
     }
 
     async getLogs(instance: InstanceInfo): Promise<LogEntry[]> {
-        const containerName = getBlockInstanceContainerName(instance.systemId, instance.instanceId);
+        const containerName = await getBlockInstanceContainerName(instance.systemId, instance.instanceId);
         const containerInfo = await this.getContainerByName(containerName);
         if (!containerInfo) {
             return [
@@ -711,7 +711,7 @@ class ContainerManager {
     }
 
     async stopLogListening(systemId: string, instanceId: string) {
-        const containerName = getBlockInstanceContainerName(systemId, instanceId);
+        const containerName = await getBlockInstanceContainerName(systemId, instanceId);
         if (this.logStreams[containerName]) {
             if (this.logStreams[containerName]?.timer) {
                 clearTimeout(this.logStreams[containerName].timer);
@@ -729,7 +729,7 @@ class ContainerManager {
     }
 
     async ensureLogListening(systemId: string, instanceId: string, handler: (log: LogEntry) => void) {
-        const containerName = getBlockInstanceContainerName(systemId, instanceId);
+        const containerName = await getBlockInstanceContainerName(systemId, instanceId);
         try {
             if (this.logStreams[containerName]?.stream) {
                 // Already listening - will shut itself down