clever-tools 4.1.0 → 4.3.0

package/bin/clever.js

@@ -28,6 +28,7 @@ import * as drain from '../src/commands/drain.js';
 import * as emails from '../src/commands/emails.js';
 import * as env from '../src/commands/env.js';
 import * as features from '../src/commands/features.js';
+import * as k8s from '../src/commands/k8s.js';
 import * as keycloak from '../src/commands/keycloak.js';
 import * as kv from '../src/commands/kv.js';
 import * as link from '../src/commands/link.js';
@@ -79,6 +80,10 @@ process.stdout.on('error', (error) => {
 const cliparseCommand = cliparse.command;
 
 cliparse.command = function (name, options, commandFunction) {
+  if (commandFunction == null) {
+    return cliparseCommand(name, options);
+  }
+
   return cliparseCommand(name, options, (...args) => {
     const promise = commandFunction(...args);
     handleCommandPromise(promise);
@@ -95,6 +100,11 @@ function colorizeExperimentalCommand(command, id) {
 async function run() {
   // ARGUMENTS
   const args = {
+    k8sClusterName: cliparse.argument('cluster-name', { description: 'Kubernetes cluster name' }),
+    k8sIdOrName: cliparse.argument('id-or-name', {
+      description: 'Kubernetes cluster ID or name',
+      parser: Parsers.addonIdOrName,
+    }),
     kvRawCommand: cliparse.argument('command', {
       description: 'The raw command to send to the Materia KV or Redis® add-on',
     }),
@@ -120,12 +130,16 @@ async function run() {
       parser: Parsers.ngResourceType,
     }),
     ngAnyIdOrLabel: cliparse.argument('id-or-label', {
-      description: 'ID or Label of a Network group, a member or an (external) peer',
+      description: 'ID or Label of a Network Group, a member or an (external) peer',
+      parser: Parsers.ngResourceType,
+    }),
+    ngResourceId: cliparse.argument('id', {
+      description: 'ID of a resource to (un)link to a Network Group',
       parser: Parsers.ngResourceType,
     }),
     wgPublicKey: cliparse.argument('public-key', {
       metavar: 'public_key',
-      description: 'Wireguard public key of the external peer to link to a Network Group',
+      description: 'WireGuard public key of the external peer to link to a Network Group',
     }),
     email: cliparse.argument('email', {
       description: 'Email address',
@@ -188,6 +202,13 @@ async function run() {
 
   // OPTIONS
   const opts = {
+    k8sDeployWatch: cliparse.flag('watch', {
+      aliases: ['w'],
+      description: 'Watch the deployment until the cluster is deployed',
+    }),
+    kubeConfigForceDownload: cliparse.flag('force', {
+      description: 'Force the download of the kubeconfig file, even if it already exists',
+    }),
     targetVersion: cliparse.option('target', {
       metavar: 'version',
       description: 'Target version to upgrade to (e.g.: 24, 2.4, 2.4.1)',
@@ -206,7 +227,7 @@ async function run() {
     ngMembersIdsToLink: cliparse.option('link', {
       metavar: 'members_ids',
       description:
-        "Comma separated list of members IDs to link to a Network Group ('app_xxx', 'addon_xxx', 'external_xxx')",
+        'Comma separated list of members IDs to link to a Network Group (app_xxx, external_xxx, mysql_xxx, postgresql_xxx, redis_xxx, etc.)',
       parser: Parsers.commaSeparated,
     }),
     ngResourceType: cliparse.option('type', {
@@ -1035,6 +1056,73 @@ async function run() {
     features.list,
   );
 
+  // K8S COMMAND
+  const k8sListCommand = cliparse.command(
+    'list',
+    {
+      description: 'List Kubernetes clusters',
+      options: [opts.orgaIdOrName, opts.humanJsonOutputFormat],
+    },
+    k8s.list,
+  );
+  const k8sCreateCommand = cliparse.command(
+    'create',
+    {
+      description: 'Create a Kubernetes cluster',
+      args: [args.k8sClusterName],
+      options: [opts.orgaIdOrName, opts.k8sDeployWatch],
+    },
+    k8s.create,
+  );
+  const k8sDeleteCommand = cliparse.command(
+    'delete',
+    {
+      description: 'Delete a Kubernetes cluster',
+      options: [opts.orgaIdOrName, opts.confirmAddonDeletion],
+      args: [args.k8sIdOrName],
+    },
+    k8s.del,
+  );
+  const k8sGetCommand = cliparse.command(
+    'get',
+    {
+      description: 'Get information about a Kubernetes cluster',
+      args: [args.k8sIdOrName],
+      options: [opts.orgaIdOrName, opts.humanJsonOutputFormat],
+    },
+    k8s.get,
+  );
+  const k8sGetConfigCommand = cliparse.command(
+    'get-kubeconfig',
+    {
+      description: 'Get configuration of a Kubernetes cluster',
+      args: [args.k8sIdOrName],
+      options: [opts.orgaIdOrName],
+    },
+    k8s.getConfig,
+  );
+  const k8sAddPersistentStorageCommand = cliparse.command(
+    'add-persistent-storage',
+    {
+      description: 'Activate persistent storage to a deployed Kubernetes cluster',
+      args: [args.k8sIdOrName],
+      options: [opts.orgaIdOrName],
+    },
+    k8s.addPersistentStorage,
+  );
+
+  const k8sCommand = cliparse.command('k8s', {
+    description: 'Manage Kubernetes clusters',
+    commands: [
+      k8sListCommand,
+      k8sCreateCommand,
+      k8sAddPersistentStorageCommand,
+      k8sDeleteCommand,
+      k8sGetCommand,
+      k8sGetConfigCommand,
+    ],
+  });
+
   // KEYCLOAK COMMAND
   const keycloakGetCommand = cliparse.command(
     'get',
@@ -1413,16 +1501,18 @@ async function run() {
   const ngLinkCommand = cliparse.command(
     'link',
     {
-      description: 'Link an application or a database add-on by its ID to a Network Group',
-      args: [args.ngAnyIdOrLabel, args.ngIdOrLabel],
+      description:
+        'Link a resource by its ID (app_xxx, external_xxx, mysql_xxx, postgresql_xxx, redis_xxx, etc.) to a Network Group',
+      args: [args.ngResourceId, args.ngIdOrLabel],
     },
     ng.linkToNg,
   );
   const ngUnlinkCommand = cliparse.command(
     'unlink',
     {
-      description: 'Unlink an application or a database add-on by its ID from a Network Group',
-      args: [args.ngAnyIdOrLabel, args.ngIdOrLabel],
+      description:
+        'Unlink a resource by its ID (app_xxx, external_xxx, mysql_xxx, postgresql_xxx, redis_xxx, etc.) from a Network Group',
+      args: [args.ngResourceId, args.ngIdOrLabel],
     },
     ng.unlinkFromNg,
   );
@@ -1438,7 +1528,7 @@ async function run() {
   const ngGetConfigCommand = cliparse.command(
     'get-config',
     {
-      description: 'Get the Wireguard configuration of a peer in a Network Group',
+      description: 'Get the WireGuard configuration of a peer in a Network Group',
       args: [args.ngExternalIdOrLabel, args.ngIdOrLabel],
       options: [opts.humanJsonOutputFormat],
     },
@@ -1977,18 +2067,10 @@ async function run() {
     },
     database.listBackups,
   );
-  const databaseCommand = cliparse.command(
-    'database',
-    {
-      description: 'List available databases',
-      commands: [backupsCommand],
-    },
-    async () => {
-      console.info('This command is not available, you can try the following commands:');
-      console.info('clever database backups');
-      console.info('clever database backups download');
-    },
-  );
+  const databaseCommand = cliparse.command('database', {
+    description: 'Manage databases and backups',
+    commands: [backupsCommand],
+  });
 
   // Patch help command description
   cliparseCommands.helpCommand.description = 'Display help about the Clever Cloud CLI';
@@ -2046,6 +2128,10 @@ async function run() {
     commands.push(colorizeExperimentalCommand(otoroshiCommand, 'operators'));
   }
 
+  if (featuresFromConf.k8s) {
+    commands.push(colorizeExperimentalCommand(k8sCommand, 'k8s'));
+  }
+
   if (featuresFromConf.kv) {
     commands.push(colorizeExperimentalCommand(kvRawCommand, 'kv'));
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clever-tools",
-  "version": "4.1.0",
+  "version": "4.3.0",
   "description": "Command Line Interface for Clever Cloud.",
   "keywords": [
     "cli",

package/src/clever-client/k8s.js

@@ -0,0 +1,96 @@
+// TODO: Move this to the Clever Cloud JS Client
+
+/**
+ * POST /v4/kubernetes/organisations/{ownerId}/clusters
+ * @param {Object} params
+ * @param {String} params.ownerId
+ * @param {Object} body
+ */
+export function createK8sCluster(params, body) {
+  return Promise.resolve({
+    method: 'post',
+    url: `/v4/kubernetes/organisations/${params.ownerId}/clusters`,
+    headers: { 'Content-Type': 'application/json', Accept: 'application/json' },
+    // no queryParams
+    body,
+  });
+}
+
+/**
+ * DELETE /v4/kubernetes/organisations/{ownerId}/clusters/{clusterId}
+ * @param {Object} params
+ * @param {String} params.ownerId
+ * @param {String} params.clusterId
+ */
+export function deleteK8sCluster(params) {
+  return Promise.resolve({
+    method: 'delete',
+    url: `/v4/kubernetes/organisations/${params.ownerId}/clusters/${params.clusterId}`,
+    headers: { Accept: 'application/json' },
+    // no queryParams
+    // no body
+  });
+}
+
+/**
+ * GET /v4/kubernetes/organisations/{ownerId}/clusters
+ * @param {Object} params
+ * @param {String} params.ownerId
+ */
+export function listK8sClusters(params) {
+  return Promise.resolve({
+    method: 'get',
+    url: `/v4/kubernetes/organisations/${params.ownerId}/clusters`,
+    headers: { Accept: 'application/json' },
+    // no queryParams
+    // no body
+  });
+}
+
+/**
+ * GET /v4/kubernetes/organisations/{ownerId}/clusters/{clusterId}
+ * @param {Object} params
+ * @param {String} params.ownerId
+ * @param {String} params.clusterId
+ */
+export function getK8sAddon(params) {
+  return Promise.resolve({
+    method: 'get',
+    url: `/v4/kubernetes/organisations/${params.ownerId}/clusters/${params.clusterId}`,
+    headers: { Accept: 'application/json' },
+    // no queryParams
+    // no body
+  });
+}
+
+/**
+ * GET /v4/kubernetes/organisations/{ownerId}/clusters/{clusterId}/kubeconfig.yaml
+ * @param {Object} params
+ * @param {String} params.ownerId
+ * @param {String} params.clusterId
+ */
+export function getK8sConfig(params) {
+  return Promise.resolve({
+    method: 'get',
+    url: `/v4/kubernetes/organisations/${params.ownerId}/clusters/${params.clusterId}/kubeconfig.yaml`,
+    // headers: { Accept: 'application/x-yaml' },
+    // no queryParams
+    // no body
+  });
+}
+
+/**
+ * POST /v4/kubernetes/organisations/ownerId}/clusters/{clusterId}/csi/ceph
+ * @param {Object} params
+ * @param {String} params.ownerId
+ * @param {String} params.clusterId
+ */
+export function addK8sPersistentStorage(params) {
+  return Promise.resolve({
+    method: 'post',
+    url: `/v4/kubernetes/organisations/${params.ownerId}/clusters/${params.clusterId}/csi/ceph`,
+    headers: { Accept: 'application/json' },
+    // no queryParams
+    // no body
+  });
+}

package/src/commands/addon.js

@@ -3,6 +3,7 @@ import { styleText } from '../lib/style-text.js';
 import { getAllEnvVars } from '@clevercloud/client/esm/api/v2/addon.js';
 import { toNameEqualsValueString } from '@clevercloud/client/esm/utils/env-vars.js';
 import dedent from 'dedent';
+import { getOperator } from '../clever-client/operators.js';
 import { formatTable } from '../format-table.js';
 import { Logger } from '../logger.js';
 import * as Addon from '../models/addon.js';
@@ -53,6 +54,45 @@ export async function list(params) {
   }
 }
 
+const ADDON_PROVIDERS = {
+  keycloak: {
+    name: 'Keycloak',
+    isOperator: true,
+    postCreateInstructions: `Learn more about Keycloak on Clever Cloud: ${conf.DOC_URL}/addons/keycloak/`,
+  },
+  kv: {
+    name: 'Materia KV',
+    isOperator: false,
+    status: 'beta',
+    postCreateInstructions: (addonId) => dedent`
+      ${styleText('yellow', "You can easily use Materia KV with 'redis-cli', with such commands:")}
+      ${styleText('blue', `source <(clever addon env ${addonId} -F shell)`)}
+      ${styleText('blue', 'redis-cli -h $KV_HOST -p $KV_PORT --tls')}
+      Learn more about Materia KV on Clever Cloud: ${conf.DOC_URL}/addons/materia-kv/
+    `,
+  },
+  'addon-matomo': {
+    name: 'Matomo',
+    isOperator: true,
+    postCreateInstructions: `Learn more about Matomo on Clever Cloud: ${conf.DOC_URL}/addons/matomo/`,
+  },
+  metabase: {
+    name: 'Metabase',
+    isOperator: true,
+    postCreateInstructions: `Learn more about Metabase on Clever Cloud: ${conf.DOC_URL}/addons/metabase/`,
+  },
+  otoroshi: {
+    name: 'Otoroshi with LLM',
+    isOperator: true,
+    postCreateInstructions: `Learn more about Otoroshi with LLM on Clever Cloud: ${conf.DOC_URL}/addons/otoroshi/`,
+  },
+  'addon-pulsar': {
+    name: 'Pulsar',
+    isOperator: false,
+    postCreateInstructions: `Learn more about Pulsar on Clever Cloud: ${conf.DOC_URL}/addons/pulsar/`,
+  },
+};
+
 export async function create(params) {
   const [providerName, name] = params.args;
   const {
@@ -62,23 +102,21 @@ export async function create(params) {
     yes: skipConfirmation,
     org: orgaIdOrName,
     format,
+    'addon-version': version,
+    option: addonOptions,
   } = params.options;
-  const version = params.options['addon-version'];
-  const addonOptions = parseAddonOptions(params.options.option);
-
-  const ownerId = orgaIdOrName != null ? await Organisation.getId(orgaIdOrName) : await User.getCurrentId();
 
   const addonToCreate = {
-    ownerId,
     name,
     providerName,
     planName,
     region,
     skipConfirmation,
     version,
-    addonOptions,
+    addonOptions: parseAddonOptions(addonOptions),
   };
 
+  const ownerId = orgaIdOrName != null ? await Organisation.getId(orgaIdOrName) : await User.getCurrentId();
   if (linkedAppAlias != null) {
     const linkedAppData = await AppConfig.getAppDetails({ alias: linkedAppAlias });
     if (orgaIdOrName != null && linkedAppData.ownerId !== ownerId && format === 'human') {
@@ -86,163 +124,98 @@ export async function create(params) {
         'The specified application does not belong to the specified organisation. Ignoring the `--org` option',
       );
     }
-    const newAddon = await Addon.create({
-      ...addonToCreate,
-      ownerId: linkedAppData.ownerId,
-    });
-    await Addon.link(linkedAppData.ownerId, linkedAppData.appId, { addon_id: newAddon.id });
-    displayAddon(
-      format,
-      newAddon,
-      providerName,
-      `Add-on created and linked to application ${linkedAppAlias} successfully!`,
-    );
+    addonToCreate.ownerId = linkedAppData.ownerId;
   } else {
-    const newAddon = await Addon.create(addonToCreate);
-    displayAddon(format, newAddon, providerName, 'Add-on created successfully!');
+    addonToCreate.ownerId = ownerId;
   }
-}
 
-function displayAddon(format, addon, providerName, message) {
-  const PROVIDERS_WITH_URL = {
-    keycloak: {
-      name: 'Keycloak',
-      urlEnv: 'CC_KEYCLOAK_URL',
-    },
-    'addon-matomo': {
-      name: 'Matomo',
-      urlEnv: 'MATOMO_URL',
-    },
-    metabase: {
-      name: 'Metabase',
-      urlEnv: 'METABASE_URL',
-    },
-    otoroshi: {
-      name: 'Otoroshi with LLM',
-      urlEnv: 'CC_OTOROSHI_URL',
-    },
-  };
+  const newAddon = await Addon.create(addonToCreate);
 
-  const WIP_PROVIDERS = {
-    keycloak: {
-      status: '',
-      postCreateInstructions: dedent`
-        Learn more about Keycloak on Clever Cloud: ${conf.DOC_URL}/addons/keycloak/,
-      `,
-    },
-    kv: {
-      status: 'alpha',
-      postCreateInstructions: dedent`
-        ${styleText('yellow', "You can easily use Materia KV with 'redis-cli', with such commands:")}
-        ${styleText('blue', `source <(clever addon env ${addon.id} -F shell)`)}
-        ${styleText('blue', 'redis-cli -h $KV_HOST -p $KV_PORT --tls')}
-        Learn more about Materia KV on Clever Cloud: ${conf.DOC_URL}/addons/materia-kv/
-      `,
-    },
-    'addon-matomo': {
-      status: '',
-      postCreateInstructions: dedent`
-        Learn more about Matomo on Clever Cloud: ${conf.DOC_URL}/addons/matomo/
-      `,
-    },
-    metabase: {
-      status: '',
-      postCreateInstructions: dedent`
-        Learn more about Metabase on Clever Cloud: ${conf.DOC_URL}/addons/metabase/
-      `,
-    },
-    otoroshi: {
-      status: '',
-      postCreateInstructions: dedent`
-        Learn more about Otoroshi with LLM on Clever Cloud: ${conf.DOC_URL}/addons/otoroshi/
-      `,
-    },
-    'addon-pulsar': {
-      status: 'beta',
-      postCreateInstructions: dedent`
-        Learn more about Pulsar on Clever Cloud: ${conf.DOC_URL}/addons/pulsar/
-      `,
-    },
-  };
+  if (linkedAppAlias != null) {
+    const linkedAppData = await AppConfig.getAppDetails({ alias: linkedAppAlias });
+    await Addon.link(linkedAppData.ownerId, linkedAppData.appId, { addon_id: newAddon.id });
+  }
 
-  let providerNameToShow = '';
+  const provider = ADDON_PROVIDERS[providerName];
   let statusMessage = '';
-  if (providerName in WIP_PROVIDERS && WIP_PROVIDERS[providerName].status !== '') {
-    providerNameToShow = providerName === 'kv' ? 'Materia KV' : providerName;
+  if (provider?.status) {
+    statusMessage = `The ${provider.name} provider is in ${provider.status} testing phase`;
+    if (provider.status === 'alpha') {
+      statusMessage += ". Don't store sensitive or production grade data.";
+    }
+  }
+
+  // JSON format
+  if (format === 'json') {
+    const jsonAddon = {
+      id: newAddon.id,
+      realId: newAddon.realId,
+      name: newAddon.name,
+      env: newAddon.env,
+    };
+
+    if (provider?.status) {
+      jsonAddon.availability = provider.status;
+      jsonAddon.message = statusMessage;
+    }
 
-    statusMessage = `The ${providerNameToShow} provider is in ${WIP_PROVIDERS[providerName].status} testing phase`;
-    statusMessage +=
-      WIP_PROVIDERS[providerName].status === 'alpha' ? ". Don't store sensitive or production grade data." : '';
+    Logger.printJson(jsonAddon);
+    return;
   }
 
-  switch (format) {
-    case 'json': {
-      const jsonAddon = {
-        id: addon.id,
-        realId: addon.realId,
-        name: addon.name,
-        env: addon.env,
-      };
+  // Human format
+  if (linkedAppAlias != null) {
+    Logger.println(`Add-on created and linked to application ${linkedAppAlias} successfully!`);
+  } else {
+    Logger.println('Add-on created successfully!');
+  }
 
-      Logger.printJson(
-        WIP_PROVIDERS[providerName] != null
-          ? { ...jsonAddon, availability: WIP_PROVIDERS[providerName].status, message: statusMessage }
-          : jsonAddon,
-      );
-      break;
-    }
+  Logger.println(`ID: ${newAddon.id}`);
+  Logger.println(`Real ID: ${newAddon.realId}`);
+  Logger.println(`Name: ${newAddon.name}`);
 
-    case 'human':
-    default:
-      Logger.println([message, `ID: ${addon.id}`, `Real ID: ${addon.realId}`, `Name: ${addon.name}`].join('\n'));
-
-      if (providerName in PROVIDERS_WITH_URL) {
-        const provider = PROVIDERS_WITH_URL[providerName];
-        const urlEnv = addon.env.find((entry) => entry.name === provider.urlEnv);
-        const urlToShow = urlEnv.value;
-        const urlToShowWithHttps = urlToShow.startsWith('http') ? urlToShow : `https://${urlToShow}`;
-
-        if (urlEnv) {
-          Logger.println();
-          Logger.println(`Your ${provider.name} is starting:`);
-          Logger.println(` - Access it: ${urlToShowWithHttps}`);
-          Logger.println(` - Manage it: ${conf.GOTO_URL}/${addon.id}`);
-        }
+  const operator = ADDON_PROVIDERS[providerName]?.isOperator
+    ? await getOperator({ provider: providerName, realId: newAddon.realId }).then(sendToApi)
+    : null;
 
-        if (providerName === 'keycloak') {
-          Logger.println();
-          Logger.println(
-            "An initial account has been created, you'll be invited to change the password at first login:",
-          );
-          Logger.println(` - Admin user name: ${addon.env.find((e) => e.name === 'CC_KEYCLOAK_ADMIN').value}`);
-          Logger.println(
-            ` - Temporary password: ${addon.env.find((e) => e.name === 'CC_KEYCLOAK_ADMIN_DEFAULT_PASSWORD').value}`,
-          );
-        }
+  if (operator) {
+    if (operator.accessUrl) {
+      Logger.println();
+      Logger.println(`Your ${ADDON_PROVIDERS[providerName].name} is starting:`);
+      Logger.println(` - Access it: ${operator.accessUrl}`);
+      Logger.println(` - Manage it: ${conf.GOTO_URL}/${newAddon.id}`);
+    }
 
-        if (providerName === 'otoroshi') {
-          Logger.println();
-          Logger.println(
-            'An initial account has been created, change the password at first login (Security -> Administrators -> Edit user):',
-          );
-          Logger.println(
-            ` - Admin user name: ${addon.env.find((e) => e.name === 'CC_OTOROSHI_INITIAL_ADMIN_LOGIN').value}`,
-          );
-          Logger.println(
-            ` - Initial password: ${addon.env.find((e) => e.name === 'CC_OTOROSHI_INITIAL_ADMIN_PASSWORD').value}`,
-          );
-        }
+    if (operator.initialCredentials) {
+      if (providerName === 'keycloak') {
+        Logger.println();
+        Logger.println("An initial account has been created, you'll be invited to change the password at first login:");
+        Logger.println(` - Admin user name: ${operator.initialCredentials.user}`);
+        Logger.println(` - Temporary password: ${operator.initialCredentials.password}`);
       }
-
-      if (providerName in WIP_PROVIDERS) {
+      if (providerName === 'otoroshi') {
         Logger.println();
+        Logger.println(
+          'An initial account has been created, change the password at first login (Security -> Administrators -> Edit user):',
+        );
+        Logger.println(` - Admin user name: ${operator.initialCredentials.user}`);
+        Logger.println(` - Password: ${operator.initialCredentials.password}`);
+      }
+    }
+  }
 
-        if (statusMessage !== '') {
-          Logger.println(styleText('yellow', `/!\\ ${statusMessage}`));
-        }
+  if (provider?.postCreateInstructions) {
+    Logger.println();
 
-        Logger.println(WIP_PROVIDERS[providerName].postCreateInstructions);
-      }
+    if (statusMessage !== '') {
+      Logger.println(styleText('yellow', `/!\\ ${statusMessage}`));
+    }
+
+    if (typeof provider.postCreateInstructions === 'function') {
+      Logger.println(provider.postCreateInstructions(newAddon.id));
+    } else {
+      Logger.println(provider.postCreateInstructions);
+    }
   }
 }