kourou 1.0.1 → 1.1.0

package/README.md

@@ -27,7 +27,7 @@ $ npm install -g kourou
 $ kourou COMMAND
 running command...
 $ kourou (-v|--version|version)
-kourou/1.0.1 linux-x64 node-v22.12.0
+kourou/1.1.0 linux-x64 node-v22.14.0
 $ kourou --help [COMMAND]
 USAGE
   $ kourou COMMAND
@@ -719,12 +719,18 @@ OPTIONS
   --dry-run                Print witch collections will be migrated
   --help                   show CLI help
   --no-interactive         Skip confirmation interactive prompts (perfect for scripting)
+  --only-mappings          Only migrate mappings
   --pattern=pattern        Pattern to match indices to migrate
   --reset                  Reset destination Elasticsearch server
   --scroll=scroll          [default: 30s] Scroll duration for Elasticsearch scrolling
   --src=src                (required) Migration source provider
 
 EXAMPLES
+  kourou es:migrate --src http://elasticsearch:9200 --dest ./my-backup
+  kourou es:migrate --src ./my-backup --dest http://elasticsearch:9200
+  kourou es:migrate --src ./my-backup --dest http://username:password@elasticsearch:9200 --reset
+  kourou es:migrate --src ./my-backup --dest http://nologin:api-key@elasticsearch:9200 --reset // nologin is a special 
+  username that allows you to use an API key as password
   kourou es:migrate --src http://elasticsearch:9200 --dest ./my-backup --batch-size 2000 --pattern 
   '&myindexes.collection-*'
   kourou es:migrate --src ./my-backup --dest http://elasticsearch:9200 --reset --batch-size 2000 --no-interactive

package/lib/commands/app/scaffold.js

@@ -25,15 +25,16 @@ class AppScaffold extends common_1.Kommand {
             },
             {
                 title: "Cloning template repository",
-                task: async () => this.cloneTemplate(flavor)
-            }, {
+                task: async () => this.cloneTemplate(flavor),
+            },
+            {
                 title: "Copying template files",
-                task: async () => this.copyTemplate(destination)
+                task: async () => this.copyTemplate(destination),
             },
             {
                 title: "Cleaning up",
-                task: async () => this.cleanup(destination)
-            }
+                task: async () => this.cleanup(destination),
+            },
         ]);
         await tasks.run();
         this.log("");
@@ -70,7 +71,7 @@ class AppScaffold extends common_1.Kommand {
     }
     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);
+        await (0, execute_1.execute)("git", "clone", "--depth=1", `https://github.com/kuzzleio/${repo}`, "--branch", "main", "--single-branch", this.templatesDir);
     }
     async copyTemplate(destination) {
         await (0, execute_1.execute)("cp", "-r", `${this.templatesDir}/`, `${destination}/`);

package/lib/commands/es/migrate.d.ts

@@ -13,6 +13,7 @@ export default class EsMigrate extends Kommand {
         "dry-run": import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         pattern: flags.IOptionFlag<string | undefined>;
         scroll: flags.IOptionFlag<string>;
+        "only-mappings": import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
     };
     static examples: string[];
     private src;

package/lib/commands/es/migrate.js

@@ -65,6 +65,11 @@ class EsMigrate extends common_1.Kommand {
         this.logInfo(`Importing ${chalk_1.default.bold(index)} to ${chalk_1.default.bold(this.flags.dest)}`);
         await this.migrateIndex(index);
         this.logOk("Mappings successfully imported!");
+        if (this.flags["only-mappings"]) {
+            this.logInfo("Skipping data import");
+            return;
+        }
+        this.logInfo("Importing data...");
         const count = await this.migrateData(index);
         if (count === 0) {
             this.logInfo("No documents to import\n");
@@ -134,8 +139,16 @@ EsMigrate.flags = {
         description: "Scroll duration for Elasticsearch scrolling",
         default: "30s",
     }),
+    "only-mappings": command_1.flags.boolean({
+        description: "Only migrate mappings",
+        default: false,
+    }),
 };
 EsMigrate.examples = [
+    "kourou es:migrate --src http://elasticsearch:9200 --dest ./my-backup",
+    "kourou es:migrate --src ./my-backup --dest http://elasticsearch:9200",
+    "kourou es:migrate --src ./my-backup --dest http://username:password@elasticsearch:9200 --reset",
+    "kourou es:migrate --src ./my-backup --dest http://nologin:api-key@elasticsearch:9200 --reset // nologin is a special username that allows you to use an API key as password",
     "kourou es:migrate --src http://elasticsearch:9200 --dest ./my-backup --batch-size 2000 --pattern '&myindexes.collection-*'",
     "kourou es:migrate --src ./my-backup --dest http://elasticsearch:9200 --reset --batch-size 2000 --no-interactive",
 ];

package/lib/support/migrate/providers/elasticsearch.d.ts

@@ -7,6 +7,7 @@ export declare class Elasticsearch implements Provider {
     private readonly client;
     private readonly options;
     constructor(url: string, options: ElasticsearchProviderOptions);
+    private extractCredentials;
     listIndices(pattern?: string): Promise<string[]>;
     getIndex(index: string): Promise<any>;
     createIndex(index: string, specifications: any): Promise<void>;

package/lib/support/migrate/providers/elasticsearch.js

@@ -4,9 +4,42 @@ exports.Elasticsearch = void 0;
 const elasticsearch_1 = require("@elastic/elasticsearch");
 class Elasticsearch {
     constructor(url, options) {
-        this.client = new elasticsearch_1.Client({ node: url });
+        const { auth, url: cleanedUrl } = this.extractCredentials(url);
+        this.client = new elasticsearch_1.Client({
+            node: cleanedUrl,
+            auth,
+        });
         this.options = options;
     }
+    extractCredentials(url) {
+        let auth = undefined;
+        if (url.includes("@")) {
+            const urlCleaned = url.replace(/https?:\/\//, "");
+            const [credentials] = urlCleaned.split("@");
+            const [username, password] = credentials.split(":");
+            if (!username || !password) {
+                throw new Error("Invalid credentials format. Expected format: username:password@url");
+            }
+            if (username === "nologin" && password) {
+                auth = {
+                    apiKey: password,
+                };
+            }
+            else if (username && password) {
+                auth = {
+                    username,
+                    password,
+                };
+            }
+            if (url.startsWith("http://")) {
+                url = url.replace(/https?:\/\/[^@]+@/, "http://");
+            }
+            else if (url.startsWith("https://")) {
+                url = url.replace(/https?:\/\/[^@]+@/, "https://");
+            }
+        }
+        return { auth, url };
+    }
     async listIndices(pattern) {
         const { body } = await this.client.cat.indices({ format: "json" });
         return body
@@ -48,13 +81,13 @@ class Elasticsearch {
             return {
                 documents: body.hits.hits,
                 total: body.hits.total.value,
-                scrollId: body._scroll_id
+                scrollId: body._scroll_id,
             };
         }
         else {
             const { body: { hits }, } = await this.client.scroll({
                 scroll_id: args.scrollId,
-                scroll: this.options.scrollDuration
+                scroll: this.options.scrollDuration,
             });
             return hits.hits;
         }

package/package.json

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