kourou 0.26.0 → 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.0 linux-x64 node-v14.21.2
+kourou/0.26.2 darwin-arm64 node-v18.17.1
 $ kourou --help [COMMAND]
 USAGE
   $ kourou COMMAND
@@ -126,72 +126,64 @@ All other arguments and options will be passed as-is to the `sdk:query` method.
 # Commands
 
 <!-- commands -->
-- [kourou](#kourou)
-- [Usage](#usage)
-  - [Connect and authenticate to Kuzzle API](#connect-and-authenticate-to-kuzzle-api)
-  - [User impersonation](#user-impersonation)
-  - [Automatic command infering for API actions](#automatic-command-infering-for-api-actions)
-- [Commands](#commands)
-  - [`kourou api-key:check TOKEN`](#kourou-api-keycheck-token)
-  - [`kourou api-key:create USER`](#kourou-api-keycreate-user)
-  - [`kourou api-key:delete USER ID`](#kourou-api-keydelete-user-id)
-  - [`kourou api-key:search USER`](#kourou-api-keysearch-user)
-  - [`kourou app:debug-proxy`](#kourou-appdebug-proxy)
-  - [`kourou app:doctor`](#kourou-appdoctor)
-  - [`kourou app:scaffold DESTINATION`](#kourou-appscaffold-destination)
-  - [`kourou app:start-services`](#kourou-appstart-services)
-  - [`kourou autocomplete [SHELL]`](#kourou-autocomplete-shell)
-  - [`kourou collection:create INDEX COLLECTION [BODY]`](#kourou-collectioncreate-index-collection-body)
-  - [`kourou collection:export INDEX COLLECTION`](#kourou-collectionexport-index-collection)
-  - [`kourou collection:import PATH`](#kourou-collectionimport-path)
-  - [`kourou collection:migrate SCRIPT PATH`](#kourou-collectionmigrate-script-path)
-  - [`kourou config:diff FIRST SECOND`](#kourou-configdiff-first-second)
-  - [`kourou document:search INDEX COLLECTION [QUERY]`](#kourou-documentsearch-index-collection-query)
-  - [`kourou es:aliases:cat`](#kourou-esaliasescat)
-  - [`kourou es:indices:cat`](#kourou-esindicescat)
-  - [`kourou es:indices:get INDEX ID`](#kourou-esindicesget-index-id)
-  - [`kourou es:indices:insert INDEX`](#kourou-esindicesinsert-index)
-  - [`kourou es:migrate`](#kourou-esmigrate)
-  - [`kourou es:snapshot:create REPOSITORY NAME`](#kourou-essnapshotcreate-repository-name)
-  - [`kourou es:snapshot:create-repository REPOSITORY LOCATION`](#kourou-essnapshotcreate-repository-repository-location)
-  - [`kourou es:snapshot:list REPOSITORY`](#kourou-essnapshotlist-repository)
-  - [`kourou file:decrypt FILE`](#kourou-filedecrypt-file)
-  - [`kourou file:encrypt FILE`](#kourou-fileencrypt-file)
-  - [`kourou file:test FILE`](#kourou-filetest-file)
-  - [`kourou help [COMMAND]`](#kourou-help-command)
-  - [`kourou import PATH`](#kourou-import-path)
-  - [`kourou index:export INDEX`](#kourou-indexexport-index)
-  - [`kourou index:import PATH`](#kourou-indeximport-path)
-  - [`kourou instance:kill`](#kourou-instancekill)
-  - [`kourou instance:list`](#kourou-instancelist)
-  - [`kourou instance:logs`](#kourou-instancelogs)
-  - [`kourou instance:spawn`](#kourou-instancespawn)
-  - [`kourou paas:deploy ENVIRONMENT APPLICATIONID IMAGE`](#kourou-paasdeploy-environment-applicationid-image)
-  - [`kourou paas:init PROJECT`](#kourou-paasinit-project)
-  - [`kourou paas:login`](#kourou-paaslogin)
-  - [`kourou paas:snapshots:cat ENVIRONMENT APPLICATIONID`](#kourou-paassnapshotscat-environment-applicationid)
-  - [`kourou paas:snapshots:dump ENVIRONMENT APPLICATIONID`](#kourou-paassnapshotsdump-environment-applicationid)
-  - [`kourou paas:snapshots:restore ENVIRONMENT APPLICATIONID SNAPSHOTID`](#kourou-paassnapshotsrestore-environment-applicationid-snapshotid)
-  - [`kourou profile:export`](#kourou-profileexport)
-  - [`kourou profile:import PATH`](#kourou-profileimport-path)
-  - [`kourou realtime:subscribe INDEX COLLECTION [FILTERS]`](#kourou-realtimesubscribe-index-collection-filters)
-  - [`kourou redis:list-keys [MATCH]`](#kourou-redislist-keys-match)
-  - [`kourou role:export`](#kourou-roleexport)
-  - [`kourou role:import PATH`](#kourou-roleimport-path)
-  - [`kourou sdk:execute [CODE]`](#kourou-sdkexecute-code)
-  - [`kourou sdk:query CONTROLLER:ACTION`](#kourou-sdkquery-controlleraction)
-  - [`kourou user:export`](#kourou-userexport)
-  - [`kourou user:export-mappings`](#kourou-userexport-mappings)
-  - [`kourou user:import PATH`](#kourou-userimport-path)
-  - [`kourou user:import-mappings PATH`](#kourou-userimport-mappings-path)
-  - [`kourou vault:add SECRETS-FILE KEY VALUE`](#kourou-vaultadd-secrets-file-key-value)
-  - [`kourou vault:decrypt FILE`](#kourou-vaultdecrypt-file)
-  - [`kourou vault:encrypt FILE`](#kourou-vaultencrypt-file)
-  - [`kourou vault:show SECRETS-FILE [KEY]`](#kourou-vaultshow-secrets-file-key)
-  - [`kourou vault:test SECRETS-FILE`](#kourou-vaulttest-secrets-file)
-- [Where does this weird name come from?](#where-does-this-weird-name-come-from)
-- [Have fun with a quine](#have-fun-with-a-quine)
-- [Telemetry](#telemetry)
+* [`kourou api-key:check TOKEN`](#kourou-api-keycheck-token)
+* [`kourou api-key:create USER`](#kourou-api-keycreate-user)
+* [`kourou api-key:delete USER ID`](#kourou-api-keydelete-user-id)
+* [`kourou api-key:search USER`](#kourou-api-keysearch-user)
+* [`kourou app:debug-proxy`](#kourou-appdebug-proxy)
+* [`kourou app:doctor`](#kourou-appdoctor)
+* [`kourou app:scaffold DESTINATION`](#kourou-appscaffold-destination)
+* [`kourou app:start-services`](#kourou-appstart-services)
+* [`kourou autocomplete [SHELL]`](#kourou-autocomplete-shell)
+* [`kourou collection:create INDEX COLLECTION [BODY]`](#kourou-collectioncreate-index-collection-body)
+* [`kourou collection:export INDEX COLLECTION`](#kourou-collectionexport-index-collection)
+* [`kourou collection:import PATH`](#kourou-collectionimport-path)
+* [`kourou collection:migrate SCRIPT PATH`](#kourou-collectionmigrate-script-path)
+* [`kourou config:diff FIRST SECOND`](#kourou-configdiff-first-second)
+* [`kourou document:search INDEX COLLECTION [QUERY]`](#kourou-documentsearch-index-collection-query)
+* [`kourou es:aliases:cat`](#kourou-esaliasescat)
+* [`kourou es:indices:cat`](#kourou-esindicescat)
+* [`kourou es:indices:get INDEX ID`](#kourou-esindicesget-index-id)
+* [`kourou es:indices:insert INDEX`](#kourou-esindicesinsert-index)
+* [`kourou es:migrate`](#kourou-esmigrate)
+* [`kourou es:snapshot:create REPOSITORY NAME`](#kourou-essnapshotcreate-repository-name)
+* [`kourou es:snapshot:create-repository REPOSITORY LOCATION`](#kourou-essnapshotcreate-repository-repository-location)
+* [`kourou es:snapshot:list REPOSITORY`](#kourou-essnapshotlist-repository)
+* [`kourou file:decrypt FILE`](#kourou-filedecrypt-file)
+* [`kourou file:encrypt FILE`](#kourou-fileencrypt-file)
+* [`kourou file:test FILE`](#kourou-filetest-file)
+* [`kourou help [COMMAND]`](#kourou-help-command)
+* [`kourou import PATH`](#kourou-import-path)
+* [`kourou index:export INDEX`](#kourou-indexexport-index)
+* [`kourou index:import PATH`](#kourou-indeximport-path)
+* [`kourou instance:kill`](#kourou-instancekill)
+* [`kourou instance:list`](#kourou-instancelist)
+* [`kourou instance:logs`](#kourou-instancelogs)
+* [`kourou instance:spawn`](#kourou-instancespawn)
+* [`kourou paas:deploy ENVIRONMENT APPLICATIONID IMAGE`](#kourou-paasdeploy-environment-applicationid-image)
+* [`kourou paas:init PROJECT`](#kourou-paasinit-project)
+* [`kourou paas:login`](#kourou-paaslogin)
+* [`kourou paas:logs ENVIRONMENT APPLICATION`](#kourou-paaslogs-environment-application)
+* [`kourou paas:snapshots:cat ENVIRONMENT APPLICATIONID`](#kourou-paassnapshotscat-environment-applicationid)
+* [`kourou paas:snapshots:dump ENVIRONMENT APPLICATIONID`](#kourou-paassnapshotsdump-environment-applicationid)
+* [`kourou paas:snapshots:restore ENVIRONMENT APPLICATIONID SNAPSHOTID`](#kourou-paassnapshotsrestore-environment-applicationid-snapshotid)
+* [`kourou profile:export`](#kourou-profileexport)
+* [`kourou profile:import PATH`](#kourou-profileimport-path)
+* [`kourou realtime:subscribe INDEX COLLECTION [FILTERS]`](#kourou-realtimesubscribe-index-collection-filters)
+* [`kourou redis:list-keys [MATCH]`](#kourou-redislist-keys-match)
+* [`kourou role:export`](#kourou-roleexport)
+* [`kourou role:import PATH`](#kourou-roleimport-path)
+* [`kourou sdk:execute [CODE]`](#kourou-sdkexecute-code)
+* [`kourou sdk:query CONTROLLER:ACTION`](#kourou-sdkquery-controlleraction)
+* [`kourou user:export`](#kourou-userexport)
+* [`kourou user:export-mappings`](#kourou-userexport-mappings)
+* [`kourou user:import PATH`](#kourou-userimport-path)
+* [`kourou user:import-mappings PATH`](#kourou-userimport-mappings-path)
+* [`kourou vault:add SECRETS-FILE KEY VALUE`](#kourou-vaultadd-secrets-file-key-value)
+* [`kourou vault:decrypt FILE`](#kourou-vaultdecrypt-file)
+* [`kourou vault:encrypt FILE`](#kourou-vaultencrypt-file)
+* [`kourou vault:show SECRETS-FILE [KEY]`](#kourou-vaultshow-secrets-file-key)
+* [`kourou vault:test SECRETS-FILE`](#kourou-vaulttest-secrets-file)
 
 ## `kourou api-key:check TOKEN`
 
@@ -377,9 +369,7 @@ ARGUMENTS
   DESTINATION  Directory to scaffold the app
 
 OPTIONS
-  --flavor=flavor  [default: generic] Template flavor ("generic", "iot-backend", "iot-console").
-                   Those can be found here: https://github.com/kuzzleio/project-templates
-
+  --flavor=flavor  [default: generic] Template flavor ("generic", "iot").
   --help           show CLI help
 ```
 
@@ -421,7 +411,7 @@ EXAMPLES
   $ kourou autocomplete --refresh-cache
 ```
 
-_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.3.0/src/commands/autocomplete/index.ts)_
+_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.3.10/src/commands/autocomplete/index.ts)_
 
 ## `kourou collection:create INDEX COLLECTION [BODY]`
 
@@ -885,7 +875,7 @@ OPTIONS
   --all  see all commands in CLI
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.2/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.18/src/commands/help.ts)_
 
 ## `kourou import PATH`
 
@@ -1108,6 +1098,31 @@ OPTIONS
 
 _See code: [src/commands/paas/login.ts](src/commands/paas/login.ts)_
 
+## `kourou paas:logs ENVIRONMENT APPLICATION`
+
+Show logs of the targeted application
+
+```
+USAGE
+  $ kourou paas:logs ENVIRONMENT APPLICATION
+
+ARGUMENTS
+  ENVIRONMENT  Kuzzle PaaS environment
+  APPLICATION  Kuzzle PaaS application
+
+OPTIONS
+  -f, --follow       Follow log output
+  -n, --tail=tail    Number of lines to show from the end of the logs
+  -t, --timestamp    Show timestamp
+  --help             show CLI help
+  --podName=podName  Name of the pod to show logs from
+  --project=project  Current PaaS project
+  --since=since      Display logs from a specific absolute (e.g. 2022/12/02 09:41) or relative (e.g. a minute ago) time
+  --until=until      Display logs until a specific absolute (e.g. 2022/12/02 09:41) or relative (e.g. a minute ago) time
+```
+
+_See code: [src/commands/paas/logs.ts](src/commands/paas/logs.ts)_
+
 ## `kourou paas:snapshots:cat ENVIRONMENT APPLICATIONID`
 
 List all snapshots for a given kuzzle application in a environment
@@ -1124,13 +1139,16 @@ OPTIONS
   --help             show CLI help
   --project=project  Current PaaS project
   --token=token      Authentication token
+
+EXAMPLE
+  kourou paas:snapshots:cat --project paas-project-myproject api main
 ```
 
 _See code: [src/commands/paas/snapshots/cat.ts](src/commands/paas/snapshots/cat.ts)_
 
 ## `kourou paas:snapshots:dump ENVIRONMENT APPLICATIONID`
 
-List all snapshots for a given kuzzle application in a environment
+Create a new snapshot of the current application state
 
 ```
 USAGE
@@ -1144,13 +1162,16 @@ OPTIONS
   --help             show CLI help
   --project=project  Current PaaS project
   --token=token      Authentication token
+
+EXAMPLE
+  kourou paas:snapshots:dump --project paas-project-myproject api main
 ```
 
 _See code: [src/commands/paas/snapshots/dump.ts](src/commands/paas/snapshots/dump.ts)_
 
 ## `kourou paas:snapshots:restore ENVIRONMENT APPLICATIONID SNAPSHOTID`
 
-List all snapshots for a given kuzzle application in a environment
+Restore a snapshot of the current application state
 
 ```
 USAGE
@@ -1165,6 +1186,9 @@ OPTIONS
   --help             show CLI help
   --project=project  Current PaaS project
   --token=token      Authentication token
+
+EXAMPLE
+  kourou paas:snapshots:restore --project paas-project-myproject api main snapshot-id
 ```
 
 _See code: [src/commands/paas/snapshots/restore.ts](src/commands/paas/snapshots/restore.ts)_

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/scaffold.d.ts

@@ -1,6 +1,7 @@
 import { flags } from "@oclif/command";
 import { Kommand } from "../../common";
 export default class AppScaffold extends Kommand {
+    templatesDir: string;
     static initSdk: boolean;
     static description: string;
     static flags: {
@@ -13,5 +14,10 @@ export default class AppScaffold extends Kommand {
         required: boolean;
     }[];
     runSafe(): Promise<void>;
-    cloneTemplate(flavor: string, destination: string): Promise<void>;
+    getRepo(flavor: string): "template-kuzzle-project" | "template-kiotp-project";
+    checkDestination(destination: string): Promise<void>;
+    prepareTemplate(): Promise<void>;
+    cloneTemplate(flavor: string): Promise<void>;
+    copyTemplate(destination: string): Promise<void>;
+    cleanup(): Promise<void>;
 }

package/lib/commands/app/scaffold.js

@@ -7,25 +7,77 @@ const listr_1 = (0, tslib_1.__importDefault)(require("listr"));
 const common_1 = require("../../common");
 const execute_1 = require("../../support/execute");
 class AppScaffold extends common_1.Kommand {
+    constructor() {
+        super(...arguments);
+        this.templatesDir = "/tmp/kuzzle-templates";
+    }
     async runSafe() {
         const destination = this.args.destination;
         const flavor = this.flags.flavor;
         const tasks = new listr_1.default([
             {
-                title: "Creating and rendering application files",
-                task: async () => this.cloneTemplate(flavor, destination),
+                title: "Checking destination",
+                task: async () => this.checkDestination(destination),
+            },
+            {
+                title: "Prepare temporary folder",
+                task: async () => this.prepareTemplate(),
             },
+            {
+                title: "Cloning template repository",
+                task: async () => this.cloneTemplate(flavor)
+            }, {
+                title: "Copying template files",
+                task: async () => this.copyTemplate(destination)
+            },
+            {
+                title: "Cleaning up",
+                task: async () => this.cleanup()
+            }
         ]);
         await tasks.run();
         this.log("");
-        this.logOk(`Scaffolding complete! Use ${chalk_1.default.grey(`cd ${destination} && npm run docker npm install`)} install dependencies and then ${chalk_1.default.grey(`npm run docker:dev`)} to run your application!`);
+        this.logOk(`Scaffolding complete!`);
+        this.logOk(`Use ${chalk_1.default.blue.bold(`cd ${destination} && docker compose up -d`)} to start your Kuzzle stack.`);
+    }
+    getRepo(flavor) {
+        console.log(flavor);
+        switch (flavor) {
+            case "generic":
+                return "template-kuzzle-project";
+            case "iot":
+                return "template-kiotp-project";
+            default:
+                return "template-kuzzle-project";
+        }
+    }
+    async checkDestination(destination) {
+        let process;
+        try {
+            process = await (0, execute_1.execute)("test", "-d", destination);
+        }
+        catch (error) {
+            if (error.result.exitCode === 1) {
+                // Destination directory does not exist
+                return;
+            }
+        }
+        if (process.exitCode === 0) {
+            throw new Error(`Destination directory ${destination} already exists.`);
+        }
+    }
+    async prepareTemplate() {
+        await (0, execute_1.execute)("rm", "-rf", this.templatesDir);
+    }
+    async cloneTemplate(flavor) {
+        const repo = this.getRepo(flavor);
+        await (0, execute_1.execute)("git", "clone", "--depth=1", `https://github.com/kuzzleio/${repo}`, "--branch", "master", "--single-branch", this.templatesDir);
+    }
+    async copyTemplate(destination) {
+        await (0, execute_1.execute)("cp", "-r", `${this.templatesDir}/`, `${destination}/`);
     }
-    async cloneTemplate(flavor, destination) {
-        const templatesDir = "/tmp/project-templates";
-        await (0, execute_1.execute)("rm", "-rf", templatesDir);
-        await (0, execute_1.execute)("git", "clone", "--depth=1", "https://github.com/kuzzleio/project-templates", "--branch", flavor, "--single-branch", templatesDir);
-        await (0, execute_1.execute)("cp", "-r", `${templatesDir}/${flavor}`, `${destination}/`);
-        await (0, execute_1.execute)("rm", "-rf", templatesDir);
+    async cleanup() {
+        await (0, execute_1.execute)("rm", "-rf", this.templatesDir);
     }
 }
 exports.default = AppScaffold;
@@ -35,8 +87,7 @@ AppScaffold.flags = {
     help: command_1.flags.help(),
     flavor: command_1.flags.string({
         default: "generic",
-        description: `Template flavor ("generic", "iot-backend", "iot-console").
-    Those can be found here: https://github.com/kuzzleio/project-templates`,
+        description: `Template flavor ("generic", "iot").`,
     }),
 };
 AppScaffold.args = [

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.grey(`  docker-compose -f ${docoFilename} logs -f\n`));
-            this.log("  Elasticsearch port: 9200");
-            this.log("  Redis port: 6379");
+            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/commands/paas/logs.js

@@ -58,6 +58,27 @@ class PaasLogs extends PaasKommand_1.PaasKommand {
             since,
             until,
         });
+        // Don't continue if an error occurred
+        if (incomingMessage.statusCode !== 200) {
+            return new Promise((_, reject) => {
+                // Collect the whole response body
+                let responseBody = "";
+                incomingMessage.on("data", (buffer) => {
+                    responseBody += buffer.toString();
+                });
+                incomingMessage.on("end", () => {
+                    let response;
+                    try {
+                        response = JSON.parse(responseBody);
+                    }
+                    catch (error) {
+                        reject(new Error("An error occurred while parsing the error response body from Kuzzle"));
+                        return;
+                    }
+                    reject(response.error);
+                });
+            });
+        }
         // Read the response line by line
         const lineStream = readline.createInterface({
             input: incomingMessage,

package/lib/commands/paas/snapshots/cat.d.ts

@@ -12,6 +12,7 @@ declare class PaasSnapshotsCat extends PaasKommand {
         description: string;
         required: boolean;
     }[];
+    static examples: string[];
     runSafe(): Promise<void>;
 }
 export default PaasSnapshotsCat;

package/lib/commands/paas/snapshots/cat.js

@@ -42,4 +42,5 @@ PaasSnapshotsCat.args = [
         required: true,
     }
 ];
+PaasSnapshotsCat.examples = ["kourou paas:snapshots:cat --project paas-project-myproject api main"];
 exports.default = PaasSnapshotsCat;

package/lib/commands/paas/snapshots/dump.d.ts

@@ -12,6 +12,7 @@ declare class PaasSnapshotsDump extends PaasKommand {
         description: string;
         required: boolean;
     }[];
+    static examples: string[];
     runSafe(): Promise<void>;
 }
 export default PaasSnapshotsDump;

package/lib/commands/paas/snapshots/dump.js

@@ -19,7 +19,7 @@ class PaasSnapshotsDump extends PaasKommand_1.PaasKommand {
         this.logOk(result.body);
     }
 }
-PaasSnapshotsDump.description = "List all snapshots for a given kuzzle application in a environment";
+PaasSnapshotsDump.description = "Create a new snapshot of the current application state";
 PaasSnapshotsDump.flags = {
     help: command_1.flags.help(),
     token: command_1.flags.string({
@@ -42,4 +42,5 @@ PaasSnapshotsDump.args = [
         required: true,
     }
 ];
+PaasSnapshotsDump.examples = ["kourou paas:snapshots:dump --project paas-project-myproject api main"];
 exports.default = PaasSnapshotsDump;

package/lib/commands/paas/snapshots/restore.d.ts

@@ -12,6 +12,7 @@ declare class PaasSnapshotsRestore extends PaasKommand {
         description: string;
         required: boolean;
     }[];
+    static examples: string[];
     runSafe(): Promise<void>;
 }
 export default PaasSnapshotsRestore;

package/lib/commands/paas/snapshots/restore.js

@@ -22,7 +22,7 @@ class PaasSnapshotsRestore extends PaasKommand_1.PaasKommand {
         this.logInfo("Ok");
     }
 }
-PaasSnapshotsRestore.description = "List all snapshots for a given kuzzle application in a environment";
+PaasSnapshotsRestore.description = "Restore a snapshot of the current application state";
 PaasSnapshotsRestore.flags = {
     help: command_1.flags.help(),
     token: command_1.flags.string({
@@ -50,4 +50,5 @@ PaasSnapshotsRestore.args = [
         required: true,
     }
 ];
+PaasSnapshotsRestore.examples = ["kourou paas:snapshots:restore --project paas-project-myproject api main snapshot-id"];
 exports.default = PaasSnapshotsRestore;

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/lib/support/execute.js

@@ -30,9 +30,7 @@ function execute(...args) {
     const process = (0, child_process_1.spawn)(command, commandArgs, options);
     let stdout = "";
     let stderr = "";
-    // eslint-disable-next-line
     process.stdout.on("data", (data) => (stdout += data.toString()));
-    // eslint-disable-next-line
     process.stderr.on("data", (data) => (stderr += data.toString()));
     const executor = new Promise((resolve, reject) => {
         process.on("close", (code) => {

package/lib/support/kuzzle.js

@@ -164,7 +164,10 @@ class KuzzleSDK {
         const options = {
             method: "POST",
             headers: {
+                Accept: "application/json",
+                "Accept-Encoding": "identity",
                 Authorization: `Bearer ${this.sdk.jwt}`,
+                Connection: "keep-alive",
                 "Content-Length": Buffer.byteLength(body),
                 "Content-Type": "application/json",
             },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kourou",
   "description": "The CLI that helps you manage your Kuzzle instances",
-  "version": "0.26.0",
+  "version": "0.26.2",
   "author": "The Kuzzle Team <support@kuzzle.io>",
   "bin": {
     "kourou": "./bin/run"
@@ -37,7 +37,7 @@
     "ndjson": "^2.0.0",
     "node-emoji": "^1.10.0",
     "node-fetch": "^2.6.7",
-    "production": "0.0.2",
+    "production": "^0.0.2",
     "strip-json-comments": "^3.1.1",
     "tar": "^6.1.11",
     "tmp": "^0.2.1",