@kapeta/local-cluster-service 0.7.2 → 0.7.4

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.7.4](https://github.com/kapetacom/local-cluster-service/compare/v0.7.3...v0.7.4) (2023-07-17)
+
+
+### Bug Fixes
+
+* Add host.docker.internal on Linux ([#43](https://github.com/kapetacom/local-cluster-service/issues/43)) ([f76eab1](https://github.com/kapetacom/local-cluster-service/commit/f76eab13059bc920026769303b49cf065d48f5ca))
+
+## [0.7.3](https://github.com/kapetacom/local-cluster-service/compare/v0.7.2...v0.7.3) (2023-07-17)
+
+
+### Bug Fixes
+
+* Handle windows paths ([45eedcb](https://github.com/kapetacom/local-cluster-service/commit/45eedcb4b95a1d403d88dd63d74fa98b2c949559))
+
 ## [0.7.2](https://github.com/kapetacom/local-cluster-service/compare/v0.7.1...v0.7.2) (2023-07-16)
 
 

package/dist/cjs/src/containerManager.d.ts

@@ -27,6 +27,7 @@ declare class ContainerManager {
     private _docker;
     private _alive;
     private _mountDir;
+    private _version;
     constructor();
     initialize(): Promise<void>;
     isAlive(): boolean;
@@ -85,5 +86,14 @@ export declare class ContainerInfo {
     getStatus(): Promise<any>;
     getPorts(): Promise<PortMap | false>;
 }
+export declare function getExtraHosts(dockerVersion: string): string[] | undefined;
+/**
+ * Ensure that the volume is in the correct format for the docker daemon on the host
+ *
+ * Windows: c:\path\to\volume -> /c/path/to/volume
+ * Linux: /path/to/volume -> /path/to/volume
+ * Mac: /path/to/volume -> /path/to/volume
+ */
+export declare function toLocalBindVolume(volume: string): string;
 export declare const containerManager: ContainerManager;
 export {};

package/dist/cjs/src/containerManager.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.containerManager = exports.ContainerInfo = void 0;
+exports.containerManager = exports.toLocalBindVolume = exports.getExtraHosts = exports.ContainerInfo = void 0;
 const path_1 = __importDefault(require("path"));
 const storageService_1 = require("./storageService");
 const os_1 = __importDefault(require("os"));
@@ -27,9 +27,11 @@ class ContainerManager {
     _docker;
     _alive;
     _mountDir;
+    _version;
     constructor() {
         this._docker = null;
         this._alive = false;
+        this._version = '';
         this._mountDir = path_1.default.join(storageService_1.storageService.getKapetaBasedir(), 'mounts');
         fs_extra_1.default.mkdirpSync(this._mountDir);
     }
@@ -58,7 +60,10 @@ class ContainerManager {
                 const client = new node_docker_api_1.Docker(opts);
                 await client.ping();
                 this._docker = client;
+                const versionInfo = await client.version();
+                this._version = versionInfo.Server?.Version;
                 this._alive = true;
+                console.log('Connected to docker daemon with version: %s', this._version);
                 return;
             }
             catch (err) {
@@ -143,7 +148,7 @@ class ContainerManager {
         lodash_1.default.forEach(mounts, (Source, Target) => {
             Mounts.push({
                 Target,
-                Source,
+                Source: toLocalBindVolume(Source),
                 Type: 'bind',
                 ReadOnly: false,
                 Consistency: 'consistent',
@@ -205,6 +210,16 @@ class ContainerManager {
         return new ContainerInfo(dockerContainer);
     }
     async startContainer(opts) {
+        const extraHosts = getExtraHosts(this._version);
+        if (extraHosts && extraHosts.length > 0) {
+            if (!opts.HostConfig) {
+                opts.HostConfig = {};
+            }
+            if (!opts.HostConfig.ExtraHosts) {
+                opts.HostConfig.ExtraHosts = [];
+            }
+            opts.HostConfig.ExtraHosts = opts.HostConfig.ExtraHosts.concat(extraHosts);
+        }
         const dockerContainer = await this.docker().container.create(opts);
         await dockerContainer.start();
         return dockerContainer;
@@ -362,4 +377,37 @@ class ContainerInfo {
     }
 }
 exports.ContainerInfo = ContainerInfo;
+function getExtraHosts(dockerVersion) {
+    if (process.platform !== 'darwin' && process.platform !== 'win32') {
+        const [major, minor] = dockerVersion.split('.');
+        if (parseInt(major) >= 20 && parseInt(minor) >= 10) {
+            // Docker 20.10+ on Linux supports adding host.docker.internal to point to host-gateway
+            return ['host.docker.internal:host-gateway'];
+        }
+        // Docker versions lower than 20.10 needs an actual IP address. We use the default network bridge which
+        // is always 172.17.0.1
+        return ['host.docker.internal:172.17.0.1'];
+    }
+    return undefined;
+}
+exports.getExtraHosts = getExtraHosts;
+/**
+ * Ensure that the volume is in the correct format for the docker daemon on the host
+ *
+ * Windows: c:\path\to\volume -> /c/path/to/volume
+ * Linux: /path/to/volume -> /path/to/volume
+ * Mac: /path/to/volume -> /path/to/volume
+ */
+function toLocalBindVolume(volume) {
+    if (process.platform === 'win32') {
+        //On Windows we need to convert c:\ to /c/
+        return volume
+            .replace(/^([a-z]):\\/i, (match, drive) => {
+            return '/' + drive.toLowerCase() + '/';
+        })
+            .replace(/\\(\S)/g, '/$1');
+    }
+    return volume;
+}
+exports.toLocalBindVolume = toLocalBindVolume;
 exports.containerManager = new ContainerManager();

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

@@ -18,7 +18,6 @@ const KIND_BLOCK_TYPE_OPERATOR = 'core/block-type-operator';
 const KAPETA_SYSTEM_ID = 'KAPETA_SYSTEM_ID';
 const KAPETA_BLOCK_REF = 'KAPETA_BLOCK_REF';
 const KAPETA_INSTANCE_ID = 'KAPETA_INSTANCE_ID';
-const KAPETA_LOCAL_CLUSTER_PORT = 'KAPETA_LOCAL_CLUSTER_PORT';
 /**
  * Needed when running local docker containers as part of plan
  * @type {string[]}
@@ -204,8 +203,8 @@ class BlockInstanceRunner {
             ],
             HostConfig: {
                 Binds: [
-                    `${local_cluster_config_1.default.getKapetaBasedir()}:${homeDir}/.kapeta`,
-                    `${baseDir}:${workingDir}`, //We mount
+                    `${(0, containerManager_1.toLocalBindVolume)(local_cluster_config_1.default.getKapetaBasedir())}:${homeDir}/.kapeta`,
+                    `${(0, containerManager_1.toLocalBindVolume)(baseDir)}:${workingDir}`, //We mount
                 ],
                 PortBindings,
             },
@@ -315,7 +314,9 @@ class BlockInstanceRunner {
                     ...Object.entries(env).map(([key, value]) => `${key}=${value}`),
                 ],
                 HostConfig: {
-                    Binds: [`${local_cluster_config_1.default.getKapetaBasedir()}:${local_cluster_config_1.default.getKapetaBasedir()}`],
+                    Binds: [
+                        `${(0, containerManager_1.toLocalBindVolume)(local_cluster_config_1.default.getKapetaBasedir())}:${local_cluster_config_1.default.getKapetaBasedir()}`,
+                    ],
                 },
             });
             try {
@@ -426,8 +427,8 @@ class BlockInstanceRunner {
                 HealthCheck,
                 HostConfig: {
                     Binds: [
-                        `${kapetaYmlPath}:/kapeta.yml:ro`,
-                        `${local_cluster_config_1.default.getKapetaBasedir()}:${local_cluster_config_1.default.getKapetaBasedir()}`,
+                        `${(0, containerManager_1.toLocalBindVolume)(kapetaYmlPath)}:/kapeta.yml:ro`,
+                        `${(0, containerManager_1.toLocalBindVolume)(local_cluster_config_1.default.getKapetaBasedir())}:${local_cluster_config_1.default.getKapetaBasedir()}`,
                     ],
                     PortBindings,
                     Mounts,

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

@@ -27,6 +27,7 @@ declare class ContainerManager {
     private _docker;
     private _alive;
     private _mountDir;
+    private _version;
     constructor();
     initialize(): Promise<void>;
     isAlive(): boolean;
@@ -85,5 +86,14 @@ export declare class ContainerInfo {
     getStatus(): Promise<any>;
     getPorts(): Promise<PortMap | false>;
 }
+export declare function getExtraHosts(dockerVersion: string): string[] | undefined;
+/**
+ * Ensure that the volume is in the correct format for the docker daemon on the host
+ *
+ * Windows: c:\path\to\volume -> /c/path/to/volume
+ * Linux: /path/to/volume -> /path/to/volume
+ * Mac: /path/to/volume -> /path/to/volume
+ */
+export declare function toLocalBindVolume(volume: string): string;
 export declare const containerManager: ContainerManager;
 export {};

package/dist/esm/src/containerManager.js

@@ -21,9 +21,11 @@ class ContainerManager {
     _docker;
     _alive;
     _mountDir;
+    _version;
     constructor() {
         this._docker = null;
         this._alive = false;
+        this._version = '';
         this._mountDir = Path.join(storageService.getKapetaBasedir(), 'mounts');
         FSExtra.mkdirpSync(this._mountDir);
     }
@@ -52,7 +54,10 @@ class ContainerManager {
                 const client = new Docker(opts);
                 await client.ping();
                 this._docker = client;
+                const versionInfo = await client.version();
+                this._version = versionInfo.Server?.Version;
                 this._alive = true;
+                console.log('Connected to docker daemon with version: %s', this._version);
                 return;
             }
             catch (err) {
@@ -137,7 +142,7 @@ class ContainerManager {
         _.forEach(mounts, (Source, Target) => {
             Mounts.push({
                 Target,
-                Source,
+                Source: toLocalBindVolume(Source),
                 Type: 'bind',
                 ReadOnly: false,
                 Consistency: 'consistent',
@@ -199,6 +204,16 @@ class ContainerManager {
         return new ContainerInfo(dockerContainer);
     }
     async startContainer(opts) {
+        const extraHosts = getExtraHosts(this._version);
+        if (extraHosts && extraHosts.length > 0) {
+            if (!opts.HostConfig) {
+                opts.HostConfig = {};
+            }
+            if (!opts.HostConfig.ExtraHosts) {
+                opts.HostConfig.ExtraHosts = [];
+            }
+            opts.HostConfig.ExtraHosts = opts.HostConfig.ExtraHosts.concat(extraHosts);
+        }
         const dockerContainer = await this.docker().container.create(opts);
         await dockerContainer.start();
         return dockerContainer;
@@ -355,4 +370,35 @@ export class ContainerInfo {
         return ports;
     }
 }
+export function getExtraHosts(dockerVersion) {
+    if (process.platform !== 'darwin' && process.platform !== 'win32') {
+        const [major, minor] = dockerVersion.split('.');
+        if (parseInt(major) >= 20 && parseInt(minor) >= 10) {
+            // Docker 20.10+ on Linux supports adding host.docker.internal to point to host-gateway
+            return ['host.docker.internal:host-gateway'];
+        }
+        // Docker versions lower than 20.10 needs an actual IP address. We use the default network bridge which
+        // is always 172.17.0.1
+        return ['host.docker.internal:172.17.0.1'];
+    }
+    return undefined;
+}
+/**
+ * Ensure that the volume is in the correct format for the docker daemon on the host
+ *
+ * Windows: c:\path\to\volume -> /c/path/to/volume
+ * Linux: /path/to/volume -> /path/to/volume
+ * Mac: /path/to/volume -> /path/to/volume
+ */
+export function toLocalBindVolume(volume) {
+    if (process.platform === 'win32') {
+        //On Windows we need to convert c:\ to /c/
+        return volume
+            .replace(/^([a-z]):\\/i, (match, drive) => {
+            return '/' + drive.toLowerCase() + '/';
+        })
+            .replace(/\\(\S)/g, '/$1');
+    }
+    return volume;
+}
 export const containerManager = new ContainerManager();

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

@@ -3,7 +3,7 @@ import ClusterConfig from '@kapeta/local-cluster-config';
 import { readYML } from './utils';
 import { parseKapetaUri } from '@kapeta/nodejs-utils';
 import { serviceManager } from '../serviceManager';
-import { containerManager } from '../containerManager';
+import { containerManager, toLocalBindVolume } from '../containerManager';
 import { LogData } from './LogData';
 import EventEmitter from 'events';
 import md5 from 'md5';
@@ -12,7 +12,6 @@ const KIND_BLOCK_TYPE_OPERATOR = 'core/block-type-operator';
 const KAPETA_SYSTEM_ID = 'KAPETA_SYSTEM_ID';
 const KAPETA_BLOCK_REF = 'KAPETA_BLOCK_REF';
 const KAPETA_INSTANCE_ID = 'KAPETA_INSTANCE_ID';
-const KAPETA_LOCAL_CLUSTER_PORT = 'KAPETA_LOCAL_CLUSTER_PORT';
 /**
  * Needed when running local docker containers as part of plan
  * @type {string[]}
@@ -198,8 +197,8 @@ export class BlockInstanceRunner {
             ],
             HostConfig: {
                 Binds: [
-                    `${ClusterConfig.getKapetaBasedir()}:${homeDir}/.kapeta`,
-                    `${baseDir}:${workingDir}`, //We mount
+                    `${toLocalBindVolume(ClusterConfig.getKapetaBasedir())}:${homeDir}/.kapeta`,
+                    `${toLocalBindVolume(baseDir)}:${workingDir}`, //We mount
                 ],
                 PortBindings,
             },
@@ -309,7 +308,9 @@ export class BlockInstanceRunner {
                     ...Object.entries(env).map(([key, value]) => `${key}=${value}`),
                 ],
                 HostConfig: {
-                    Binds: [`${ClusterConfig.getKapetaBasedir()}:${ClusterConfig.getKapetaBasedir()}`],
+                    Binds: [
+                        `${toLocalBindVolume(ClusterConfig.getKapetaBasedir())}:${ClusterConfig.getKapetaBasedir()}`,
+                    ],
                 },
             });
             try {
@@ -420,8 +421,8 @@ export class BlockInstanceRunner {
                 HealthCheck,
                 HostConfig: {
                     Binds: [
-                        `${kapetaYmlPath}:/kapeta.yml:ro`,
-                        `${ClusterConfig.getKapetaBasedir()}:${ClusterConfig.getKapetaBasedir()}`,
+                        `${toLocalBindVolume(kapetaYmlPath)}:/kapeta.yml:ro`,
+                        `${toLocalBindVolume(ClusterConfig.getKapetaBasedir())}:${ClusterConfig.getKapetaBasedir()}`,
                     ],
                     PortBindings,
                     Mounts,

package/package.json

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

package/src/containerManager.ts

@@ -51,10 +51,12 @@ class ContainerManager {
     private _docker: Docker | null;
     private _alive: boolean;
     private _mountDir: string;
+    private _version: string;
 
     constructor() {
         this._docker = null;
         this._alive = false;
+        this._version = '';
         this._mountDir = Path.join(storageService.getKapetaBasedir(), 'mounts');
         FSExtra.mkdirpSync(this._mountDir);
     }
@@ -85,7 +87,10 @@ class ContainerManager {
                 const client = new Docker(opts);
                 await client.ping();
                 this._docker = client;
+                const versionInfo: any = await client.version();
+                this._version = versionInfo.Server?.Version;
                 this._alive = true;
+                console.log('Connected to docker daemon with version: %s', this._version);
                 return;
             } catch (err) {
                 // silently ignore bad configs
@@ -189,7 +194,7 @@ class ContainerManager {
         _.forEach(mounts, (Source, Target) => {
             Mounts.push({
                 Target,
-                Source,
+                Source: toLocalBindVolume(Source),
                 Type: 'bind',
                 ReadOnly: false,
                 Consistency: 'consistent',
@@ -252,7 +257,6 @@ class ContainerManager {
             Hostname: name + '.kapeta',
             Labels,
             Cmd: opts.cmd,
-
             ExposedPorts,
             Env,
             HealthCheck,
@@ -270,6 +274,20 @@ class ContainerManager {
     }
 
     async startContainer(opts: any) {
+        const extraHosts = getExtraHosts(this._version);
+
+        if (extraHosts && extraHosts.length > 0) {
+            if (!opts.HostConfig) {
+                opts.HostConfig = {};
+            }
+
+            if (!opts.HostConfig.ExtraHosts) {
+                opts.HostConfig.ExtraHosts = [];
+            }
+
+            opts.HostConfig.ExtraHosts = opts.HostConfig.ExtraHosts.concat(extraHosts);
+        }
+
         const dockerContainer = await this.docker().container.create(opts);
         await dockerContainer.start();
         return dockerContainer;
@@ -463,4 +481,38 @@ export class ContainerInfo {
     }
 }
 
+export function getExtraHosts(dockerVersion: string): string[] | undefined {
+    if (process.platform !== 'darwin' && process.platform !== 'win32') {
+        const [major, minor] = dockerVersion.split('.');
+        if (parseInt(major) >= 20 && parseInt(minor) >= 10) {
+            // Docker 20.10+ on Linux supports adding host.docker.internal to point to host-gateway
+            return ['host.docker.internal:host-gateway'];
+        }
+        // Docker versions lower than 20.10 needs an actual IP address. We use the default network bridge which
+        // is always 172.17.0.1
+        return ['host.docker.internal:172.17.0.1'];
+    }
+
+    return undefined;
+}
+
+/**
+ * Ensure that the volume is in the correct format for the docker daemon on the host
+ *
+ * Windows: c:\path\to\volume -> /c/path/to/volume
+ * Linux: /path/to/volume -> /path/to/volume
+ * Mac: /path/to/volume -> /path/to/volume
+ */
+export function toLocalBindVolume(volume: string): string {
+    if (process.platform === 'win32') {
+        //On Windows we need to convert c:\ to /c/
+        return volume
+            .replace(/^([a-z]):\\/i, (match, drive) => {
+                return '/' + drive.toLowerCase() + '/';
+            })
+            .replace(/\\(\S)/g, '/$1');
+    }
+    return volume;
+}
+
 export const containerManager = new ContainerManager();

package/src/utils/BlockInstanceRunner.ts

@@ -3,7 +3,7 @@ import ClusterConfig, { DefinitionInfo } from '@kapeta/local-cluster-config';
 import { readYML } from './utils';
 import { KapetaURI, parseKapetaUri } from '@kapeta/nodejs-utils';
 import { serviceManager } from '../serviceManager';
-import { containerManager, DockerMounts } from '../containerManager';
+import { containerManager, DockerMounts, toLocalBindVolume } from '../containerManager';
 import { LogData } from './LogData';
 import EventEmitter from 'events';
 import md5 from 'md5';
@@ -15,7 +15,7 @@ const KIND_BLOCK_TYPE_OPERATOR = 'core/block-type-operator';
 const KAPETA_SYSTEM_ID = 'KAPETA_SYSTEM_ID';
 const KAPETA_BLOCK_REF = 'KAPETA_BLOCK_REF';
 const KAPETA_INSTANCE_ID = 'KAPETA_INSTANCE_ID';
-const KAPETA_LOCAL_CLUSTER_PORT = 'KAPETA_LOCAL_CLUSTER_PORT';
+
 /**
  * Needed when running local docker containers as part of plan
  * @type {string[]}
@@ -247,8 +247,8 @@ export class BlockInstanceRunner {
             ],
             HostConfig: {
                 Binds: [
-                    `${ClusterConfig.getKapetaBasedir()}:${homeDir}/.kapeta`,
-                    `${baseDir}:${workingDir}`, //We mount
+                    `${toLocalBindVolume(ClusterConfig.getKapetaBasedir())}:${homeDir}/.kapeta`,
+                    `${toLocalBindVolume(baseDir)}:${workingDir}`, //We mount
                 ],
                 PortBindings,
             },
@@ -362,6 +362,7 @@ export class BlockInstanceRunner {
             }
         } else {
             logs.addLog(`Creating new container for block: ${containerName}`);
+
             container = await containerManager.startContainer({
                 Image: dockerImage,
                 name: containerName,
@@ -374,7 +375,9 @@ export class BlockInstanceRunner {
                     ...Object.entries(env).map(([key, value]) => `${key}=${value}`),
                 ],
                 HostConfig: {
-                    Binds: [`${ClusterConfig.getKapetaBasedir()}:${ClusterConfig.getKapetaBasedir()}`],
+                    Binds: [
+                        `${toLocalBindVolume(ClusterConfig.getKapetaBasedir())}:${ClusterConfig.getKapetaBasedir()}`,
+                    ],
                 },
             });
 
@@ -508,8 +511,8 @@ export class BlockInstanceRunner {
                 HealthCheck,
                 HostConfig: {
                     Binds: [
-                        `${kapetaYmlPath}:/kapeta.yml:ro`,
-                        `${ClusterConfig.getKapetaBasedir()}:${ClusterConfig.getKapetaBasedir()}`,
+                        `${toLocalBindVolume(kapetaYmlPath)}:/kapeta.yml:ro`,
+                        `${toLocalBindVolume(ClusterConfig.getKapetaBasedir())}:${ClusterConfig.getKapetaBasedir()}`,
                     ],
                     PortBindings,
                     Mounts,