kourou 0.26.1 → 0.26.2

package/README.md

@@ -27,7 +27,7 @@ $ npm install -g kourou
 $ kourou COMMAND
 running command...
 $ kourou (-v|--version|version)
-kourou/0.26.1 darwin-arm64 node-v18.17.1
+kourou/0.26.2 darwin-arm64 node-v18.17.1
 $ kourou --help [COMMAND]
 USAGE
   $ kourou COMMAND

package/lib/commands/app/doctor.js

@@ -7,6 +7,7 @@ const kuzzle_1 = require("../../support/kuzzle");
 const elasticsearch_1 = require("@elastic/elasticsearch");
 const execute_1 = require("../../support/execute");
 const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
+const checkPrerequisites_1 = require("../../support/docker/checkPrerequisites");
 class AppDoctor extends common_1.Kommand {
     constructor() {
         super(...arguments);
@@ -169,21 +170,11 @@ class AppDoctor extends common_1.Kommand {
             suggestions.push(`Install missing libraries: sudo apt-get install ${notInstalled.join(" ")}`);
         }
         this.log("Docker checks");
-        try {
-            const docov = await (0, execute_1.execute)("docker-compose", "-v");
-            const matches = docov.stdout.match(/[^0-9.]*([0-9.]*).*/);
-            if (matches === null || matches.length === 0) {
-                this.logKo("Docker Version cannot be found");
-            }
-            else {
-                this.logOk(`Docker Compose Version: ${matches[1]}`);
-            }
-        }
-        catch (error) {
-            this.logKo("Docker Compose cannot be found");
-            suggestions.push("Install Docker Compose with 'npm run install:docker'");
+        const result = await (0, checkPrerequisites_1.checkPrerequisites)(this);
+        if (!result) {
+            suggestions.push("Install Docker and the Compose plugin");
         }
-        this.log(`----------------- DoKtor finish his job ! -----------------`);
+        this.log(`----------------- DoKtor finished its job ! -----------------`);
         this.log(`He suggest you to check the following points:`);
         for (const suggestion of suggestions) {
             this.logInfo(" => " + suggestion);

package/lib/commands/app/start-services.d.ts

@@ -7,5 +7,4 @@ export default class AppStartServices extends Kommand {
         check: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
     };
     runSafe(): Promise<void>;
-    checkPrerequisites(): Promise<boolean>;
 }

package/lib/commands/app/start-services.js

@@ -5,11 +5,10 @@ const fs_1 = require("fs");
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const command_1 = require("@oclif/command");
 const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
-const listr_1 = (0, tslib_1.__importDefault)(require("listr"));
 const node_emoji_1 = (0, tslib_1.__importDefault)(require("node-emoji"));
 const common_1 = require("../../common");
 const execute_1 = require("../../support/execute");
-const MIN_DOCO_VERSION = "1.12.0";
+const checkPrerequisites_1 = require("../../support/docker/checkPrerequisites");
 const kuzzleServicesFile = `
 version: '3'
 
@@ -31,7 +30,7 @@ class AppStartServices extends common_1.Kommand {
         this.createKourouDir();
         const docoFilename = path_1.default.join(this.kourouDir, "kuzzle-services.yml");
         const successfullCheck = this.flags.check
-            ? await this.checkPrerequisites()
+            ? await (0, checkPrerequisites_1.checkPrerequisites)(this)
             : true;
         if (this.flags.check && successfullCheck) {
             this.log(`\n${node_emoji_1.default.get("ok_hand")} Prerequisites are ${chalk_1.default.green.bold("OK")}!`);
@@ -39,62 +38,22 @@ class AppStartServices extends common_1.Kommand {
         else if (this.flags.check && !successfullCheck) {
             throw new Error(`${node_emoji_1.default.get("shrug")} Your system doesn't satisfy all the prerequisites. Cannot run Kuzzle services.`);
         }
-        this.log(chalk_1.default.grey(`\nWriting docker-compose file to ${docoFilename}...\n`));
+        this.log(chalk_1.default.grey(`\nWriting the Docker Compose file to ${docoFilename}...\n`));
         (0, fs_1.writeFileSync)(docoFilename, kuzzleServicesFile);
         // clean up
-        await (0, execute_1.execute)("docker-compose", "-f", docoFilename, "down");
+        await (0, execute_1.execute)("docker", "compose", "-f", docoFilename, "down");
         try {
-            await (0, execute_1.execute)("docker-compose", "-f", docoFilename, "up", "-d");
+            await (0, execute_1.execute)("docker", "compose", "-f", docoFilename, "up", "-d");
             this.logOk("Elasticsearch and Redis are booting in the background right now.");
             this.log(chalk_1.default.grey("\nTo watch the logs, run"));
-            this.log(chalk_1.default.blue.bold(`  docker-compose -f ${docoFilename} logs -f\n`));
+            this.log(chalk_1.default.blue.bold(`  docker compose -f ${docoFilename} logs -f\n`));
             this.log(`  Elasticsearch port: ${chalk_1.default.bold("9200")}`);
             this.log(`          Redis port: ${chalk_1.default.bold("6379")}`);
         }
         catch (error) {
             this.logKo(` Something went wrong: ${error.message}`);
             this.log(chalk_1.default.grey("If you want to investigate the problem, try running"));
-            this.log(chalk_1.default.grey(`  docker-compose -f ${docoFilename} up\n`));
-        }
-    }
-    async checkPrerequisites() {
-        this.log(chalk_1.default.grey("Checking prerequisites..."));
-        const checks = new listr_1.default([
-            {
-                title: `docker-compose exists and the version is at least ${MIN_DOCO_VERSION}`,
-                task: async () => {
-                    try {
-                        const docov = await (0, execute_1.execute)("docker-compose", "-v");
-                        const matches = docov.stdout.match(/[^0-9.]*([0-9.]*).*/);
-                        if (matches === null) {
-                            throw new Error("Unable to read docker-compose verson. This is weird.");
-                        }
-                        const docoVersion = matches.length > 0 ? matches[1] : null;
-                        if (docoVersion === null) {
-                            throw new Error("Unable to read docker-compose version. This is weird.");
-                        }
-                        try {
-                            if (docoVersion < MIN_DOCO_VERSION) {
-                                throw new Error(`The detected version of docker-compose (${docoVersion}) is not recent enough (${MIN_DOCO_VERSION})`);
-                            }
-                        }
-                        catch (error) {
-                            throw new Error(error);
-                        }
-                    }
-                    catch (error) {
-                        throw new Error("No docker-compose found. Are you sure docker-compose is installed?");
-                    }
-                },
-            },
-        ]);
-        try {
-            await checks.run();
-            return true;
-        }
-        catch (error) {
-            this.logKo(error.message);
-            return false;
+            this.log(chalk_1.default.grey(`  docker compose -f ${docoFilename} up\n`));
         }
     }
 }

package/lib/commands/instance/kill.js

@@ -50,7 +50,8 @@ class InstanceLogs extends common_1.Kommand {
         cli_ux_1.default.action.start(`${node_emoji_1.default.get("boom")}  Killing Kuzzle instance ${instanceName}`, undefined, {
             stdout: true,
         });
-        const instanceKill = (0, child_process_1.spawn)("docker-compose", [
+        const instanceKill = (0, child_process_1.spawn)("docker", [
+            "compose",
             "-f",
             docoFilename,
             "-p",

package/lib/commands/instance/spawn.d.ts

@@ -9,7 +9,6 @@ export default class InstanceSpawn extends Kommand {
         version: flags.IOptionFlag<string>;
     };
     runSafe(): Promise<void>;
-    checkPrerequisites(): Promise<boolean>;
     private generateDocoFile;
     private isPortAvailable;
     private findAvailablePort;

package/lib/commands/instance/spawn.js

@@ -8,12 +8,12 @@ const command_1 = require("@oclif/command");
 const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 const child_process_1 = require("child_process");
 const cli_ux_1 = (0, tslib_1.__importDefault)(require("cli-ux"));
-const listr_1 = (0, tslib_1.__importDefault)(require("listr"));
 const node_emoji_1 = (0, tslib_1.__importDefault)(require("node-emoji"));
 const common_1 = require("../../common");
 const execute_1 = require("../../support/execute");
+const checkPrerequisites_1 = require("../../support/docker/checkPrerequisites");
 const MIN_MAX_MAP_COUNT = 262144;
-const MIN_DOCO_VERSION = "1.12.0";
+const MIN_DOCO_VERSION = "2.0.0";
 const kuzzleStackV1 = (increment) => `
 version: '3'
 
@@ -89,7 +89,7 @@ class InstanceSpawn extends common_1.Kommand {
         const portIndex = await this.findAvailablePort();
         const docoFilename = path_1.default.join(this.kourouDir, `kuzzle-stack-${portIndex}.yml`);
         const successfullCheck = this.flags.check
-            ? await this.checkPrerequisites()
+            ? await (0, checkPrerequisites_1.checkPrerequisites)(this)
             : true;
         if (this.flags.check && successfullCheck) {
             this.log(`\n${node_emoji_1.default.get("ok_hand")} Prerequisites are ${chalk_1.default.green.bold("OK")}!`);
@@ -97,11 +97,12 @@ class InstanceSpawn extends common_1.Kommand {
         else if (this.flags.check && !successfullCheck) {
             throw new Error(`${node_emoji_1.default.get("shrug")} Your system doesn't satisfy all the prerequisites. Cannot run Kuzzle.`);
         }
-        this.log(chalk_1.default.grey(`\nWriting docker-compose file to ${docoFilename}...`));
+        this.log(chalk_1.default.grey(`\nWriting docker compose file to ${docoFilename}...`));
         (0, fs_1.writeFileSync)(docoFilename, this.generateDocoFile(this.flags.version, portIndex));
         // clean up
-        await (0, execute_1.execute)("docker-compose", "-f", docoFilename, "-p", `stack-${portIndex}`, "down");
-        const doco = (0, child_process_1.spawn)("docker-compose", [
+        await (0, execute_1.execute)("docker", "compose", "-f", docoFilename, "-p", `stack-${portIndex}`, "down");
+        const doco = (0, child_process_1.spawn)("docker", [
+            "compose",
             "-f",
             docoFilename,
             "-p",
@@ -117,78 +118,20 @@ class InstanceSpawn extends common_1.Kommand {
                 cli_ux_1.default.action.stop("done");
                 this.log(`\n${node_emoji_1.default.get("thumbsup")} ${chalk_1.default.bold("Kuzzle is booting")} in the background right now.`);
                 this.log(chalk_1.default.grey("To watch the logs, run"));
-                this.log(chalk_1.default.grey(`  docker-compose -f ${docoFilename} -p stack-${portIndex} logs -f\n`));
+                this.log(chalk_1.default.grey(`  docker compose -f ${docoFilename} -p stack-${portIndex} logs -f\n`));
                 this.log(`  Kuzzle port: ${7512 + portIndex}`);
                 this.log(`  MQTT port: ${1883 + portIndex}`);
                 this.log(`  Node.js debugger port: ${9229 + portIndex}`);
                 this.log(`  Elasticsearch port: ${9200 + portIndex}`);
             }
             else {
-                cli_ux_1.default.action.stop(chalk_1.default.red(` Something went wrong: docker-compose exited with ${docoCode}`));
+                cli_ux_1.default.action.stop(chalk_1.default.red(` Something went wrong: docker compose exited with ${docoCode}`));
                 this.log(chalk_1.default.grey("If you want to investigate the problem, try running"));
-                this.log(chalk_1.default.grey(`  docker-compose -f ${docoFilename} -p stack-${portIndex} up\n`));
-                throw new Error("docker-compose exited witn non-zero status");
+                this.log(chalk_1.default.grey(`  docker compose -f ${docoFilename} -p stack-${portIndex} up\n`));
+                throw new Error("docker compose exited with a non-zero status");
             }
         });
     }
-    async checkPrerequisites() {
-        this.log(chalk_1.default.grey("Checking prerequisites..."));
-        const checks = new listr_1.default([
-            {
-                title: `docker-compose exists and the version is at least ${MIN_DOCO_VERSION}`,
-                task: async () => {
-                    try {
-                        const docov = await (0, execute_1.execute)("docker-compose", "-v");
-                        const matches = docov.stdout.match(/[^0-9.]*([0-9.]*).*/);
-                        if (matches === null) {
-                            throw new Error("Unable to read docker-compose verson. This is weird.");
-                        }
-                        const docoVersion = matches.length > 0 ? matches[1] : null;
-                        if (docoVersion === null) {
-                            throw new Error("Unable to read docker-compose version. This is weird.");
-                        }
-                        try {
-                            if (docoVersion < MIN_DOCO_VERSION) {
-                                throw new Error(`The detected version of docker-compose (${docoVersion}) is not recent enough (${MIN_DOCO_VERSION})`);
-                            }
-                        }
-                        catch (error) {
-                            throw new Error(error);
-                        }
-                    }
-                    catch (error) {
-                        throw new Error("No docker-compose found. Are you sure docker-compose is installed?");
-                    }
-                },
-            },
-            {
-                title: `vm.max_map_count is greater than ${MIN_MAX_MAP_COUNT}`,
-                task: async () => {
-                    try {
-                        const sysctl = await (0, execute_1.execute)("/sbin/sysctl", "-n", "vm.max_map_count");
-                        if (sysctl.exitCode !== 0) {
-                            throw new Error("Something went wrong checking vm.max_map_count");
-                        }
-                        const value = parseInt(sysctl.stdout, 10);
-                        if (value < MIN_MAX_MAP_COUNT) {
-                            throw new Error(`vm.max_map_count must be at least ${MIN_MAX_MAP_COUNT} (found ${value})`);
-                        }
-                    }
-                    catch (error) {
-                        throw new Error(`Something went wrong checking vm.max_map_count: ${error.message}`);
-                    }
-                },
-            },
-        ]);
-        try {
-            await checks.run();
-            return true;
-        }
-        catch (error) {
-            this.logKo(error.message);
-            return false;
-        }
-    }
     generateDocoFile(kuzzleMajor, portIndex) {
         if (kuzzleMajor === "1") {
             return kuzzleStackV1(portIndex);

package/lib/support/docker/checkPrerequisites.d.ts

@@ -0,0 +1,2 @@
+import { Kommand } from "../../common";
+export declare function checkPrerequisites(ctx: Kommand): Promise<boolean>;

package/lib/support/docker/checkPrerequisites.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkPrerequisites = void 0;
+const tslib_1 = require("tslib");
+const listr_1 = (0, tslib_1.__importDefault)(require("listr"));
+const execute_1 = require("../execute");
+const MIN_DOCO_VERSION = "2.0.0";
+async function checkPrerequisites(ctx) {
+    const checks = new listr_1.default([
+        {
+            title: `docker compose exists and the version is at least ${MIN_DOCO_VERSION}`,
+            task: async () => {
+                const docov = await (0, execute_1.execute)("docker", "compose", "version");
+                const matches = docov.stdout.match(/[^0-9.]*([0-9.]*).*/);
+                const docoVersion = matches ? matches[1] : null;
+                ctx.logInfo(`Found Docker Compose version: ${docoVersion}`);
+                if (!docoVersion) {
+                    throw new Error("Unable to read the version of Docker Compose. Are you sure Docker and the Compose plugin are installed?");
+                }
+                if (docoVersion < MIN_DOCO_VERSION) {
+                    throw new Error(`Your version of Docker Compose (${docoVersion}) is below the required version (${MIN_DOCO_VERSION}).`);
+                }
+            },
+        },
+    ]);
+    try {
+        await checks.run();
+        return true;
+    }
+    catch (error) {
+        ctx.logKo(error.message);
+        return false;
+    }
+}
+exports.checkPrerequisites = checkPrerequisites;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kourou",
   "description": "The CLI that helps you manage your Kuzzle instances",
-  "version": "0.26.1",
+  "version": "0.26.2",
   "author": "The Kuzzle Team <support@kuzzle.io>",
   "bin": {
     "kourou": "./bin/run"