@kapeta/local-cluster-service 0.34.1 → 0.35.0

package/dist/esm/src/proxy/types/rest.js

@@ -14,6 +14,7 @@ const path_1 = __importDefault(require("path"));
 const pathTemplateParser_1 = require("../../utils/pathTemplateParser");
 const networkManager_1 = require("../../networkManager");
 const socketManager_1 = require("../../socketManager");
+const qs_1 = require("qs");
 function getRestMethodId(restResource, httpMethod, httpPath) {
     return lodash_1.default.findKey(restResource.spec.methods, (method) => {
         let methodType = method.method ? method.method.toUpperCase() : 'GET';
@@ -77,7 +78,7 @@ function proxyRestRequest(req, res, opts) {
         providerPath = '/' + providerPath;
     }
     if (!lodash_1.default.isEmpty(req.query)) {
-        providerPath += '?' + new URLSearchParams(req.query).toString();
+        providerPath += '?' + (0, qs_1.stringify)(req.query, { arrayFormat: 'repeat' });
     }
     const requestHeaders = lodash_1.default.clone(req.headers);
     delete requestHeaders['content-length'];

package/dist/esm/src/proxy/types/web.js

@@ -12,6 +12,7 @@ const request_1 = __importDefault(require("request"));
 const lodash_1 = __importDefault(require("lodash"));
 const networkManager_1 = require("../../networkManager");
 const socketManager_1 = require("../../socketManager");
+const qs_1 = require("qs");
 function proxyHttpRequest(req, res, opts) {
     const requestHeaders = lodash_1.default.clone(req.headers);
     delete requestHeaders['content-length'];
@@ -26,7 +27,7 @@ function proxyHttpRequest(req, res, opts) {
         path = path.replace(sourceBasePath, targetBasePath);
     }
     if (!lodash_1.default.isEmpty(req.query)) {
-        path += '?' + new URLSearchParams(req.query).toString();
+        path += '?' + (0, qs_1.stringify)(req.query, { arrayFormat: 'repeat' });
     }
     console.log('Proxy request to provider: %s => %s%s [http]', opts.consumerPath, opts.address, path);
     const reqOpts = {

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

@@ -9,6 +9,7 @@ export declare const HTTP_PORTS: string[];
 declare class ServiceManager {
     private _systems;
     constructor();
+    getLocalHost(environmentType?: EnvironmentType): string;
     _forLocal(port: string | number, path?: string, environmentType?: EnvironmentType): string;
     _ensureSystem(systemId: string): any;
     _ensureService(systemId: string, serviceId: string): any;

package/dist/esm/src/serviceManager.js

@@ -31,22 +31,22 @@ class ServiceManager {
             });
         });
     }
-    _forLocal(port, path, environmentType) {
-        if (!path) {
-            path = '';
-        }
-        let host;
+    getLocalHost(environmentType) {
         if (environmentType === 'docker') {
             //We're inside a docker container, so we can use this special host name to access the host machine
-            host = 'host.docker.internal';
+            return 'host.docker.internal';
         }
-        else {
-            host = clusterService_1.clusterService.getClusterServiceHost();
+        return clusterService_1.clusterService.getClusterServiceHost();
+    }
+    _forLocal(port, path, environmentType) {
+        if (!path) {
+            path = '';
         }
+        const hostname = this.getLocalHost(environmentType);
         if (path.startsWith('/')) {
             path = path.substring(1);
         }
-        return `http://${host}:${port}/${path}`;
+        return `http://${hostname}:${port}/${path}`;
     }
     _ensureSystem(systemId) {
         systemId = (0, nodejs_utils_1.normalizeKapetaUri)(systemId);

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

@@ -56,6 +56,30 @@ export type ProcessInfo = {
     pid?: number | string | null;
     portType?: string;
 };
+export interface Health {
+    cmd: string;
+    interval?: number;
+    timeout?: number;
+    retries?: number;
+}
+export type PortInfo = {
+    port: number;
+    type: 'tcp' | 'udp';
+} | number | string;
+export type LocalImageOptions<Credentials = AnyMap, Options = AnyMap> = {
+    image: string;
+    ports: {
+        [key: string]: PortInfo;
+    };
+    credentials?: Credentials;
+    options?: Options;
+    cmd?: string;
+    env?: AnyMap;
+    health?: Health;
+    mounts?: {
+        [key: string]: string;
+    };
+};
 export type InstanceInfo = {
     systemId: string;
     instanceId: string;
@@ -73,6 +97,21 @@ export type InstanceInfo = {
     portType?: string;
 };
 export type ProxyRequestHandler = (req: StringBodyRequest, res: express.Response, info: ProxyRequestInfo) => void;
+export interface OperatorInstancePort {
+    protocol: string;
+    port: number;
+}
+export interface OperatorInstanceInfo {
+    hostname: string;
+    ports: {
+        [portType: string]: OperatorInstancePort;
+    };
+    path?: string;
+    query?: string;
+    hash?: string;
+    options?: AnyMap;
+    credentials?: AnyMap;
+}
 export interface OperatorInfo {
     host: string;
     port: string;

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

@@ -288,7 +288,8 @@ class BlockInstanceRunner {
         if (!spec?.local?.image) {
             throw new Error(`Provider did not have local image: ${providerRef}`);
         }
-        const dockerImage = spec?.local?.image;
+        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();
@@ -298,11 +299,13 @@ class BlockInstanceRunner {
         const PortBindings = {};
         let HealthCheck = undefined;
         let Mounts = [];
-        const localPorts = spec.local.ports;
+        const localPorts = local.ports ?? {};
+        const labels = {};
         const promises = Object.entries(localPorts).map(async ([portType, value]) => {
-            const dockerPort = `${value.port}/${value.type}`;
+            const portInfo = (0, utils_1.toPortInfo)(value);
+            const dockerPort = `${portInfo.port}/${portInfo.type}`;
             ExposedPorts[dockerPort] = {};
-            addonEnv[`KAPETA_LOCAL_SERVER_PORT_${portType.toUpperCase()}`] = value.port;
+            addonEnv[`KAPETA_LOCAL_SERVER_PORT_${portType.toUpperCase()}`] = `${portInfo.port}`;
             const publicPort = await serviceManager_1.serviceManager.ensureServicePort(this._systemId, blockInstance.id, portType);
             PortBindings[dockerPort] = [
                 {
@@ -310,19 +313,19 @@ class BlockInstanceRunner {
                     HostPort: `${publicPort}`,
                 },
             ];
+            labels[containerManager_1.CONTAINER_LABEL_PORT_PREFIX + publicPort] = portType;
         });
         await Promise.all(promises);
-        if (spec.local?.env) {
-            Object.entries(spec.local.env).forEach(([key, value]) => {
+        if (local.env) {
+            Object.entries(local.env).forEach(([key, value]) => {
                 addonEnv[key] = value;
             });
         }
-        if (spec.local?.mounts) {
-            const mounts = await containerManager_1.containerManager.createMounts(this._systemId, blockUri.id, spec.local.mounts);
-            Mounts = containerManager_1.containerManager.toDockerMounts(mounts);
+        if (local.mounts) {
+            Mounts = await containerManager_1.containerManager.createVolumes(this._systemId, blockUri.id, local.mounts);
         }
-        if (spec.local?.health) {
-            HealthCheck = containerManager_1.containerManager.toDockerHealth(spec.local?.health);
+        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();
@@ -342,6 +345,7 @@ class BlockInstanceRunner {
                 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, '_'),
@@ -356,7 +360,7 @@ class BlockInstanceRunner {
                 }).map(([key, value]) => `${key}=${value}`),
             ],
         });
-        const portTypes = spec.local.ports ? Object.keys(spec.local.ports) : [];
+        const portTypes = local.ports ? Object.keys(local.ports) : [];
         if (portTypes.length > 0) {
             out.portType = portTypes[0];
         }

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

@@ -3,8 +3,12 @@
  * SPDX-License-Identifier: BUSL-1.1
  */
 import { EntityList } from '@kapeta/schemas';
-import { AnyMap } from '../types';
+import { AnyMap, PortInfo } from '../types';
 export declare function getBlockInstanceContainerName(systemId: string, instanceId: string): string;
+export declare function toPortInfo(port: PortInfo): {
+    port: number;
+    type: string;
+};
 export declare function getRemoteUrl(id: string, defautValue: string): any;
 export declare function readYML(path: string): any;
 export declare function isWindows(): boolean;

package/dist/esm/src/utils/utils.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.getResolvedConfiguration = exports.getBindHost = exports.isLinux = exports.isMac = exports.isWindows = exports.readYML = exports.getRemoteUrl = exports.getBlockInstanceContainerName = void 0;
+exports.getResolvedConfiguration = exports.getBindHost = exports.isLinux = exports.isMac = exports.isWindows = exports.readYML = exports.getRemoteUrl = exports.toPortInfo = exports.getBlockInstanceContainerName = void 0;
 const node_fs_1 = __importDefault(require("node:fs"));
 const yaml_1 = __importDefault(require("yaml"));
 const md5_1 = __importDefault(require("md5"));
@@ -17,6 +17,16 @@ function getBlockInstanceContainerName(systemId, instanceId) {
     return `kapeta-block-instance-${(0, md5_1.default)(systemId + instanceId)}`;
 }
 exports.getBlockInstanceContainerName = getBlockInstanceContainerName;
+function toPortInfo(port) {
+    if (typeof port === 'number' || typeof port === 'string') {
+        return { port: parseInt(`${port}`), type: 'tcp' };
+    }
+    if (!port.type) {
+        port.type = 'tcp';
+    }
+    return port;
+}
+exports.toPortInfo = toPortInfo;
 function getRemoteUrl(id, defautValue) {
     const remoteConfig = local_cluster_config_1.default.getClusterConfig().remote;
     return remoteConfig?.[id] ?? defautValue;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kapeta/local-cluster-service",
-    "version": "0.34.1",
+    "version": "0.35.0",
     "description": "Manages configuration, ports and service discovery for locally running Kapeta systems",
     "type": "commonjs",
     "exports": {
@@ -48,18 +48,18 @@
     "homepage": "https://github.com/kapetacom/local-cluster-service#readme",
     "dependencies": {
         "@kapeta/codegen": "^1.2.1",
-        "@kapeta/local-cluster-config": ">= 0.3.0 <2",
+        "@kapeta/kaplang-core": "^1.9.3",
+        "@kapeta/local-cluster-config": ">= 0.3.2 <2",
         "@kapeta/nodejs-api-client": ">=0.1.3 <2",
         "@kapeta/nodejs-process": "<2",
         "@kapeta/nodejs-registry-utils": ">=0.9.4 <2",
         "@kapeta/nodejs-utils": "<2",
-        "@kapeta/sdk-config": "^2.0.0",
-        "@kapeta/web-microfrontend": "^1",
-        "@kapeta/kaplang-core": "^1.9",
         "@kapeta/schemas": "^2.0.0",
+        "@kapeta/sdk-config": "^2.0.0",
         "@kapeta/ui-web-components": "^3.0.1",
         "@kapeta/ui-web-plan-editor": "^2.0.0",
         "@kapeta/ui-web-types": "^1.2.0",
+        "@kapeta/web-microfrontend": "^1",
         "@sentry/node": "^7.94.1",
         "@types/dockerode": "^3.3.19",
         "@types/stream-json": "^1.7.3",
@@ -75,6 +75,7 @@
         "md5": "2.2.1",
         "node-cache": "^5.1.2",
         "node-uuid": "^1.4.8",
+        "qs": "^6.11.2",
         "request": "2.88.2",
         "request-promise": "4.2.6",
         "socket.io": "^4.5.2",

package/src/config/routes.ts

@@ -181,4 +181,19 @@ router.get('/consumes/:resourceName/:type', (req: KapetaRequest, res) => {
     );
 });
 
+/**
+ * Used by services to information about a block operator
+ *
+ * If the remote service is not already running it will be started
+ */
+router.get('/operator/:instanceId', async (req: KapetaRequest, res) => {
+    const operatorInfo = await instanceManager.getInstanceOperator(
+        req.kapeta!.systemId,
+        req.params.instanceId,
+        req.kapeta!.environment
+    );
+
+    res.send(operatorInfo);
+});
+
 export default router;

package/src/containerManager.ts

@@ -14,7 +14,7 @@ import ClusterConfiguration from '@kapeta/local-cluster-config';
 import uuid from 'node-uuid';
 import md5 from 'md5';
 import { getBlockInstanceContainerName } from './utils/utils';
-import { InstanceInfo, LogEntry, LogSource } from './types';
+import { Health, InstanceInfo, LogEntry, LogSource } from './types';
 import { KapetaAPI } from '@kapeta/nodejs-api-client';
 import { taskManager, Task } from './taskManager';
 import { EventEmitter } from 'node:events';
@@ -76,13 +76,6 @@ interface JSONMessage<T = string> {
     aux?: any;
 }
 
-interface Health {
-    cmd: string;
-    interval?: number;
-    timeout?: number;
-    retries?: number;
-}
-
 export const CONTAINER_LABEL_PORT_PREFIX = 'kapeta_port-';
 const NANO_SECOND = 1000000;
 const HEALTH_CHECK_INTERVAL = 3000;
@@ -255,7 +248,7 @@ class ContainerManager {
 
     async createVolumes(
         systemId: string,
-        kind: string,
+        serviceId: string,
         mountOpts: StringMap | null | undefined
     ): Promise<DockerMounts[]> {
         const Mounts: DockerMounts[] = [];
@@ -263,7 +256,7 @@ class ContainerManager {
         if (mountOpts) {
             const mountOptList = Object.entries(mountOpts);
             for (const [mountName, containerPath] of mountOptList) {
-                const volumeName = `${systemId}_${kind}_${mountName}`.replace(/[^a-z0-9]/gi, '_');
+                const volumeName = `${systemId}_${serviceId}_${mountName}`.replace(/[^a-z0-9]/gi, '_');
 
                 Mounts.push({
                     Target: containerPath,
@@ -273,7 +266,7 @@ class ContainerManager {
                     Consistency: 'consistent',
                     Labels: {
                         [COMPOSE_LABEL_PROJECT]: systemId.replace(/[^a-z0-9]/gi, '_'),
-                        [COMPOSE_LABEL_SERVICE]: kind.replace(/[^a-z0-9]/gi, '_'),
+                        [COMPOSE_LABEL_SERVICE]: serviceId.replace(/[^a-z0-9]/gi, '_'),
                     },
                 });
             }
@@ -997,7 +990,7 @@ export class ContainerInfo {
                 return;
             }
 
-            const hostPort = name.substr(CONTAINER_LABEL_PORT_PREFIX.length);
+            const hostPort = name.substring(CONTAINER_LABEL_PORT_PREFIX.length);
 
             portTypes[hostPort] = portType;
         });

package/src/instanceManager.ts

@@ -18,7 +18,19 @@ import {
     HEALTH_CHECK_TIMEOUT,
 } from './containerManager';
 import { configManager } from './configManager';
-import { DesiredInstanceStatus, InstanceInfo, InstanceOwner, InstanceStatus, InstanceType, LogEntry } from './types';
+import {
+    DesiredInstanceStatus,
+    EnvironmentType,
+    InstanceInfo,
+    InstanceOwner,
+    InstanceStatus,
+    InstanceType,
+    LocalImageOptions,
+    LogEntry,
+    OperatorInfo,
+    OperatorInstanceInfo,
+    OperatorInstancePort,
+} from './types';
 import { BlockDefinitionSpec, BlockInstance, Plan } from '@kapeta/schemas';
 import { getBlockInstanceContainerName, getResolvedConfiguration } from './utils/utils';
 import { KIND_OPERATOR, operatorManager } from './operatorManager';
@@ -414,6 +426,62 @@ export class InstanceManager {
         );
     }
 
+    public async getInstanceOperator(
+        systemId: string,
+        instanceId: string,
+        environment?: EnvironmentType
+    ): Promise<OperatorInstanceInfo> {
+        const blockInstance = await assetManager.getBlockInstance(systemId, instanceId);
+        if (!blockInstance) {
+            throw new Error(`Instance not found: ${systemId}/${instanceId}`);
+        }
+        const blockRef = normalizeKapetaUri(blockInstance.block.ref);
+        const block = await assetManager.getAsset(blockRef, true);
+        if (!block) {
+            throw new Error(`Block not found: ${blockRef}`);
+        }
+
+        const operatorDefinition = await definitionsManager.getDefinition(block.kind);
+
+        if (!operatorDefinition?.definition.spec.local) {
+            throw new Error(`Operator block has no local definition: ${blockRef}`);
+        }
+
+        const localConfig = operatorDefinition.definition.spec.local as LocalImageOptions;
+
+        let instance = await this.start(systemId, instanceId);
+        if (instance instanceof Task) {
+            instance = await instance.wait();
+        }
+
+        const container = await containerManager.get(instance.pid as string);
+        if (!container) {
+            throw new Error(`Container not found: ${instance.pid}`);
+        }
+
+        const portInfo = await container.getPorts();
+        if (!portInfo) {
+            throw new Error(`No ports found for instance: ${instanceId}`);
+        }
+
+        const hostname = serviceManager.getLocalHost(environment);
+        const ports: { [key: string]: OperatorInstancePort } = {};
+
+        Object.entries(portInfo).forEach(([key, value]) => {
+            ports[key] = {
+                protocol: value.protocol,
+                port: parseInt(value.hostPort),
+            };
+        });
+
+        return {
+            hostname,
+            ports,
+            credentials: localConfig.credentials,
+            options: localConfig.options,
+        };
+    }
+
     public async start(systemId: string, instanceId: string): Promise<InstanceInfo | Task<InstanceInfo>> {
         return this.exclusive(systemId, instanceId, async () => {
             systemId = normalizeKapetaUri(systemId);
@@ -427,7 +495,7 @@ export class InstanceManager {
 
             const existingInstance = this.getInstance(systemId, instanceId);
 
-            if (existingInstance) {
+            if (existingInstance && existingInstance.pid) {
                 if (existingInstance.status === InstanceStatus.READY) {
                     // Instance is already running
                     return existingInstance;
@@ -481,8 +549,8 @@ export class InstanceManager {
                         return Promise.resolve();
                     }
                     // Check if the operator has a local definition, if not we skip it since we can't start it
-                    if(!asset.definition.spec.local) {
-                        console.log('Skipping operator since it as no local definition: %s', consumer.kind)
+                    if (!asset.definition.spec.local) {
+                        console.log('Skipping operator since it as no local definition: %s', consumer.kind);
                         return Promise.resolve();
                     }
                     console.log('Ensuring resource: %s in %s', consumerUri.id, systemId);

package/src/operatorManager.ts

@@ -16,10 +16,10 @@ import {
     containerManager,
 } from './containerManager';
 import FSExtra from 'fs-extra';
-import { AnyMap, EnvironmentType, OperatorInfo, StringMap } from './types';
+import { AnyMap, EnvironmentType, LocalImageOptions, OperatorInfo, StringMap } from './types';
 import { BlockInstance, Resource } from '@kapeta/schemas';
 import { definitionsManager } from './definitionsManager';
-import { getBindHost } from './utils/utils';
+import { getBindHost, toPortInfo } from './utils/utils';
 import { parseKapetaUri, normalizeKapetaUri } from '@kapeta/nodejs-utils';
 import _ from 'lodash';
 import AsyncLock from 'async-lock';
@@ -34,7 +34,7 @@ class Operator {
         this._data = data;
     }
 
-    getLocalData() {
+    getLocalData(): LocalImageOptions {
         return this._data.definition.spec.local;
     }
 
@@ -187,16 +187,8 @@ class OperatorManager {
                 const portType = portTypes[i];
                 let containerPortInfo = operatorData.ports[portType];
                 const hostPort = await serviceManager.ensureServicePort(systemId, resourceType, portType);
-
-                if (typeof containerPortInfo === 'number' || typeof containerPortInfo === 'string') {
-                    containerPortInfo = { port: containerPortInfo, type: 'tcp' };
-                }
-
-                if (!containerPortInfo.type) {
-                    containerPortInfo.type = 'tcp';
-                }
-
-                const portId = containerPortInfo.port + '/' + containerPortInfo.type;
+                const portInfo = toPortInfo(containerPortInfo);
+                const portId = portInfo.port + '/' + portInfo.type;
 
                 ports[portId] = {
                     type: portType,

package/src/proxy/types/rest.ts

@@ -14,6 +14,7 @@ import { Request, Response } from 'express';
 import { ProxyRequestInfo, SimpleRequest, StringMap } from '../../types';
 import { StringBodyRequest } from '../../middleware/stringBody';
 import { Resource } from '@kapeta/schemas';
+import { stringify } from 'qs';
 
 export function getRestMethodId(restResource: Resource, httpMethod: string, httpPath: string) {
     return _.findKey(restResource.spec.methods, (method) => {
@@ -105,7 +106,7 @@ export function proxyRestRequest(req: StringBodyRequest, res: Response, opts: Pr
     }
 
     if (!_.isEmpty(req.query)) {
-        providerPath += '?' + new URLSearchParams(req.query as any).toString();
+        providerPath += '?' + stringify(req.query, { arrayFormat: 'repeat' });
     }
 
     const requestHeaders = _.clone(req.headers);

package/src/proxy/types/web.ts

@@ -7,9 +7,10 @@ import request from 'request';
 import _ from 'lodash';
 import { networkManager } from '../../networkManager';
 import { socketManager } from '../../socketManager';
-import { Request, Response } from 'express';
+import { Response } from 'express';
 import { ProxyRequestInfo, SimpleRequest, StringMap } from '../../types';
 import { StringBodyRequest } from '../../middleware/stringBody';
+import { stringify } from 'qs';
 
 export function proxyHttpRequest(req: StringBodyRequest, res: Response, opts: ProxyRequestInfo) {
     const requestHeaders = _.clone(req.headers);
@@ -28,7 +29,7 @@ export function proxyHttpRequest(req: StringBodyRequest, res: Response, opts: Pr
     }
 
     if (!_.isEmpty(req.query)) {
-        path += '?' + new URLSearchParams(req.query as any).toString();
+        path += '?' + stringify(req.query, { arrayFormat: 'repeat' });
     }
 
     console.log('Proxy request to provider: %s => %s%s [http]', opts.consumerPath, opts.address, path);

package/src/serviceManager.ts

@@ -34,22 +34,25 @@ class ServiceManager {
         });
     }
 
+    public getLocalHost(environmentType?: EnvironmentType) {
+        if (environmentType === 'docker') {
+            //We're inside a docker container, so we can use this special host name to access the host machine
+            return 'host.docker.internal';
+        }
+
+        return clusterService.getClusterServiceHost();
+    }
+
     _forLocal(port: string | number, path?: string, environmentType?: EnvironmentType) {
         if (!path) {
             path = '';
         }
-        let host;
-        if (environmentType === 'docker') {
-            //We're inside a docker container, so we can use this special host name to access the host machine
-            host = 'host.docker.internal';
-        } else {
-            host = clusterService.getClusterServiceHost();
-        }
+        const hostname = this.getLocalHost(environmentType);
 
         if (path.startsWith('/')) {
             path = path.substring(1);
         }
-        return `http://${host}:${port}/${path}`;
+        return `http://${hostname}:${port}/${path}`;
     }
 
     _ensureSystem(systemId: string) {

package/src/types.ts

@@ -61,6 +61,26 @@ export type ProcessInfo = {
     portType?: string;
 };
 
+export interface Health {
+    cmd: string;
+    interval?: number;
+    timeout?: number;
+    retries?: number;
+}
+
+export type PortInfo = { port: number; type: 'tcp' | 'udp' } | number | string;
+
+export type LocalImageOptions<Credentials = AnyMap, Options = AnyMap> = {
+    image: string;
+    ports: { [key: string]: PortInfo };
+    credentials?: Credentials;
+    options?: Options;
+    cmd?: string;
+    env?: AnyMap;
+    health?: Health;
+    mounts?: { [key: string]: string };
+};
+
 export type InstanceInfo = {
     systemId: string;
     instanceId: string;
@@ -86,6 +106,21 @@ interface ResourceRef {
 
 export type ProxyRequestHandler = (req: StringBodyRequest, res: express.Response, info: ProxyRequestInfo) => void;
 
+export interface OperatorInstancePort {
+    protocol: string;
+    port: number;
+}
+
+export interface OperatorInstanceInfo {
+    hostname: string;
+    ports: { [portType: string]: OperatorInstancePort };
+    path?: string;
+    query?: string;
+    hash?: string;
+    options?: AnyMap;
+    credentials?: AnyMap;
+}
+
 export interface OperatorInfo {
     host: string;
     port: string;