clever-tools 3.11.0 → 3.13.0

package/src/commands/metabase.js

@@ -0,0 +1,112 @@
+import {
+  operatorCheckVersion,
+  operatorList,
+  operatorOpen,
+  operatorOpenLogs,
+  operatorOpenWebUi,
+  operatorPrint,
+  operatorReboot,
+  operatorRebuild,
+  operatorUpdateVersion,
+} from '../lib/operator-commands.js';
+
+/**
+ * Check the version of a Metabase operator
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @param {string} params.options.format The output format
+ * @returns {Promise<void>}
+ */
+export async function checkVersion (params) {
+  const [addonIdOrName] = params.args;
+  const { format } = params.options;
+  await operatorCheckVersion('metabase', addonIdOrName, format);
+}
+
+/**
+ * Update the version of a Metabase operator
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @returns {Promise<void>}
+ */
+export async function updateVersion (params) {
+  const [addonIdOrName] = params.args;
+  const { target } = params.options;
+  await operatorUpdateVersion('metabase', target, addonIdOrName);
+}
+
+/**
+ * Get the details of a Metabase operator
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @param {string} params.options.format The output format
+ * @returns {Promise<void>}
+ */
+export async function get (params) {
+  const [addonIdOrName] = params.args;
+  const { format } = params.options;
+  await operatorPrint('metabase', addonIdOrName, format);
+}
+
+/**
+ * List all Metabase operators
+ * @returns {Promise<void>}
+ */
+export async function list (params) {
+  await operatorList('metabase', params.options.format);
+}
+
+/**
+ * Open a Metabase operator dashboard in the Clever Cloud Console
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @returns {Promise<void>}
+ */
+export async function open (params) {
+  const [addonIdOrName] = params.args;
+  await operatorOpen('metabase', addonIdOrName);
+}
+
+/**
+ * Open the Logs section of a Metabase Operator application in the Clever Cloud Console
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @returns {Promise<void>}
+ */
+export async function openLogs (params) {
+  const [addonIdOrName] = params.args;
+  await operatorOpenLogs('metabase', addonIdOrName);
+}
+
+/**
+ * Open the Web UI of a Metabase Operator application in the Clever Cloud Console
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @returns {Promise<void>}
+ */
+export async function openWebUi (params) {
+  const [addonIdOrName] = params.args;
+  await operatorOpenWebUi('metabase', addonIdOrName);
+}
+
+/**
+ * Reboot a Metabase operator
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @returns {Promise<void>}
+ */
+export async function reboot (params) {
+  const [addonIdOrName] = params.args;
+  await operatorReboot('metabase', addonIdOrName);
+}
+
+/**
+ * Rebuild a Metabase operator
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @returns {Promise<void>}
+ */
+export async function rebuild (params) {
+  const [addonIdOrName] = params.args;
+  await operatorRebuild('metabase', addonIdOrName);
+}

package/src/commands/ng.js

@@ -0,0 +1,202 @@
+import colors from 'colors/safe.js';
+import * as networkGroup from '../models/ng.js';
+import * as networkGroupResources from '../models/ng-resources.js';
+
+import { Logger } from '../logger.js';
+import { printResults } from '../lib/ng-print.js';
+
+/** Create a Network Group
+ * @param {Object} params
+ * @param {Array<Object>} params.args
+ * @param {Object} params.args[0] Network Group label
+ * @param {string} params.options.description Network Group description
+ * @param {Array<string>}  params.options.link Array of member IDs or labels to link to the Network Group
+ * @param {Object} params.options.org Organisation ID or name
+ * @param {string} params.options.tags Comma-separated list of tags
+ */
+export async function createNg (params) {
+  const [ngLabel] = params.args;
+  const label = ngLabel.ngResourceLabel;
+  const { description, link: membersIds, org, tags } = params.options;
+
+  await networkGroup.create(label, description, tags, membersIds, org);
+
+  const successMessage = `Network Group ${colors.green(label)} successfully created`;
+  if (membersIds == null) {
+    Logger.printSuccess(`${successMessage}!`);
+  }
+  else {
+    Logger.printSuccess(`${successMessage} with member(s):`);
+    Logger.println(membersIds.map((id) => colors.grey(`  - ${id}`)).join('\n'));
+  }
+}
+
+/** Delete a Network Group
+ * @param {Object} params
+ * @param {Object} params.args[0] Network Group ID or label
+ * @param {Object} params.options.org Organisation ID or name
+ */
+export async function deleteNg (params) {
+  const [ngIdOrLabel] = params.args;
+  const { org } = params.options;
+
+  await networkGroup.destroy(ngIdOrLabel, org);
+  const ngText = ngIdOrLabel.ngResourceLabel ?? ngIdOrLabel.ngId;
+  Logger.printSuccess(`Network Group ${colors.green(ngText)} successfully deleted!`);
+}
+
+/** Create an external peer in a Network Group
+ * @param {Object} params
+ * @param {Object} params.args[0] External peer ID or label
+ * @param {Object} params.args[1] Network Group ID or label
+ * @param {string} params.args[2] Wireguard public key
+ * @param {Object} params.options.org Organisation ID or name
+ */
+export async function createExternalPeer (params) {
+  const [peerIdOrLabel, ngIdOrLabel, publicKey] = params.args;
+  const { org } = params.options;
+
+  await networkGroupResources.createExternalPeerWithParent(ngIdOrLabel, peerIdOrLabel.ngResourceLabel, publicKey, org);
+  const ngText = ngIdOrLabel.ngResourceLabel ?? ngIdOrLabel.ngId;
+  Logger.printSuccess(`External peer ${colors.green(peerIdOrLabel.ngResourceLabel)} successfully created in Network Group ${colors.green(ngText)}`);
+}
+
+/** Delete an external peer from a Network Group
+ * @param {Object} params
+ * @param {Object} params.args[0] External peer ID or label
+ * @param {Object} params.args[1] Network Group ID or label
+ * @param {Object} params.options.org Organisation ID or name
+ */
+export async function deleteExternalPeer (params) {
+  const [peerIdOrLabel, ngIdOrLabel] = params.args;
+  const { org } = params.options;
+
+  const peerText = peerIdOrLabel.ngResourceLabel ?? peerIdOrLabel.memberId;
+  const ngText = ngIdOrLabel.ngResourceLabel ?? ngIdOrLabel.ngId;
+  await networkGroupResources.deleteExternalPeerWithParent(ngIdOrLabel, peerText, org);
+  Logger.printSuccess(`External peer ${colors.green(peerText)} successfully deleted from Network Group ${colors.green(ngText)}`);
+}
+
+/** Link a member to a Network Group
+ * @param {Object} params
+ * @param {string} params.args[0] Member ID
+ * @param {Object} params.args[1] Network Group ID or label
+ * @param {Object} params.options.org Organisation ID or name
+ */
+export async function linkToNg (params) {
+  const [resourceId, ngIdOrLabel] = params.args;
+  const { org } = params.options;
+
+  await networkGroupResources.linkMember(ngIdOrLabel, resourceId.memberId, org);
+  const ngText = ngIdOrLabel.ngResourceLabel ?? ngIdOrLabel.ngId;
+  Logger.printSuccess(`Member ${colors.green(resourceId.memberId)} successfully linked to Network Group ${colors.green(ngText)}`);
+}
+
+/** Unlink a member from a Network Group
+ * @param {Object} params
+ * @param {string} params.args[0] Member ID
+ * @param {Object} params.args[1] Network Group ID or label
+ * @param {Object} params.options.org Organisation ID or name
+ */
+export async function unlinkFromNg (params) {
+  const [resourceId, ngIdOrLabel] = params.args;
+  const { org } = params.options;
+
+  await networkGroupResources.unlinkMember(ngIdOrLabel, resourceId.memberId, org);
+  const ngText = ngIdOrLabel.ngResourceLabel ?? ngIdOrLabel.ngId;
+  Logger.printSuccess(`Member ${colors.green(resourceId.memberId)} successfully unlinked from Network Group ${colors.green(ngText)}`);
+}
+
+/** Print the configuration of a Network Group's peer
+ * @param {Object} params
+ * @param {Object} params.args[0] Peer ID or label
+ * @param {Object} params.args[1] Network Group ID or label
+ * @param {Object} params.options.org Organisation ID or name
+ * @param {string} params.options.format Output format
+ */
+export async function getPeerConfig (params) {
+  const [peerIdOrLabel, ngIdOrLabel] = params.args;
+  const { org, format } = params.options;
+
+  const config = await networkGroup.getPeerConfig(peerIdOrLabel, ngIdOrLabel, org);
+
+  switch (format) {
+    case 'json': {
+      Logger.printJson(config);
+      break;
+    }
+    case 'human':
+    default: {
+      const decodedConfiguration = Buffer.from(config.configuration, 'base64').toString('utf8');
+      Logger.println(decodedConfiguration);
+    }
+  }
+}
+
+/** List Network Groups, their members and peers
+ * @param {Object} params
+ * @param {Object} params.options.orgaIdOrName Organisation ID or name
+ * @param {string} params.options.format Output format
+ */
+export async function listNg (params) {
+  const { org, format } = params.options;
+
+  const ngs = await networkGroup.getAllNGs(org);
+
+  switch (format) {
+    case 'json': {
+      Logger.printJson(ngs);
+      break;
+    }
+    case 'human':
+    default: {
+      if (!ngs.length) {
+        Logger.println(`ℹ️ No Network Group found, create one with ${colors.blue('clever ng create')} command`);
+        return;
+      }
+      const ngList = ngs.map(({
+        id,
+        label,
+        networkIp,
+        members,
+        peers,
+      }) => ({
+        ID: id,
+        Label: label,
+        'Network CIDR': networkIp,
+        Members: Object.keys(members).length,
+        Peers: Object.keys(peers).length,
+      }));
+
+      console.table(ngList);
+    }
+  }
+}
+
+/** Show information about a Network Group, a member or a peer
+ * @param {Object} params
+ * @param {Object} params.args[0] ID or label of the Network Group, a member or a peer
+ * @param {Object} params.options.org Organisation ID or name
+ * @param {string} params.options.format Output format
+ */
+export async function get (params) {
+  const [idOrLabel] = params.args;
+  const { org, format } = params.options;
+  const type = params.options.type ?? 'single';
+
+  await printResults(idOrLabel, org, format, 'get', type);
+}
+
+/** Show information about a Network Group, a member or a peer
+ * @param {Object} params
+ * @param {Object} params.args[0] ID or label of the Network Group, a member or a peer
+ * @param {Object} params.options.org Organisation ID or name
+ * @param {string} params.options.format Output format
+ */
+export async function search (params) {
+  const [idOrLabel] = params.args;
+  const { org, format } = params.options;
+  const type = params.options.type;
+
+  await printResults(idOrLabel, org, format, 'search', type);
+}

package/src/commands/open.js

@@ -1,8 +1,6 @@
-import openPage from 'open';
-
 import * as Application from '../models/application.js';
 import * as Domain from '../models/domain.js';
-import { Logger } from '../logger.js';
+import { openBrowser } from '../models/utils.js';
 
 export async function open (params) {
   const { alias, app: appIdOrName } = params.options;
@@ -11,6 +9,5 @@ export async function open (params) {
   const vhost = await Domain.getBest(appId, ownerId);
   const url = 'https://' + vhost.fqdn;
 
-  Logger.println('Opening the application in your browser');
-  await openPage(url, { wait: false });
+  await openBrowser(url, 'Opening the application in your browser');
 }

package/src/commands/otoroshi.js

@@ -0,0 +1,138 @@
+import {
+  operatorCheckVersion,
+  operatorList,
+  operatorNgDisable,
+  operatorNgEnable,
+  operatorOpen,
+  operatorOpenLogs,
+  operatorOpenWebUi,
+  operatorPrint,
+  operatorReboot,
+  operatorRebuild,
+  operatorUpdateVersion,
+} from '../lib/operator-commands.js';
+
+/**
+ * Check the version of an Otoroshi operator
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @param {string} params.options.format The output format
+ * @returns {Promise<void>}
+ */
+export async function checkVersion (params) {
+  const [addonIdOrName] = params.args;
+  const { format } = params.options;
+  await operatorCheckVersion('otoroshi', addonIdOrName, format);
+}
+
+/**
+ * Update the version of an Otoroshi operator
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @returns {Promise<void>}
+ */
+export async function updateVersion (params) {
+  const [addonIdOrName] = params.args;
+  const { target } = params.options;
+  await operatorUpdateVersion('otoroshi', target, addonIdOrName);
+}
+
+/**
+ * Get the details of an Otoroshi operator
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @param {string} params.options.format The output format
+ * @returns {Promise<void>}
+ */
+export async function get (params) {
+  const [addonIdOrName] = params.args;
+  const { format } = params.options;
+  await operatorPrint('otoroshi', addonIdOrName, format);
+}
+
+/**
+ * List all Otoroshi operators
+ * @returns {Promise<void>}
+ */
+export async function list (params) {
+  await operatorList('otoroshi', params.options.format);
+}
+
+/**
+ * Unlink a Operator from a Network Group
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @returns {Promise<void>}
+ * @throws {Error} If the Network Group feature is already disabled
+ */
+export async function ngDisable (params) {
+  const [addonIdOrName] = params.args;
+  await operatorNgDisable('otoroshi', addonIdOrName);
+}
+
+/**
+ * Link a Operator to a Network Group
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @returns {Promise<void>}
+ * @throws {Error} If the Network Group feature is already enabled
+ */
+export async function ngEnable (params) {
+  const [addonIdOrName] = params.args;
+  await operatorNgEnable('otoroshi', addonIdOrName);
+}
+
+/**
+ * Open an Otoroshi operator dashboard in the Clever Cloud Console
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @returns {Promise<void>}
+ */
+export async function open (params) {
+  const [addonIdOrName] = params.args;
+  await operatorOpen('otoroshi', addonIdOrName);
+}
+
+/**
+ * Open the Logs section of an Otoroshi Operator application in the Clever Cloud Console
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @returns {Promise<void>}
+ */
+export async function openLogs (params) {
+  const [addonIdOrName] = params.args;
+  await operatorOpenLogs('otoroshi', addonIdOrName);
+}
+
+/**
+ * Open the Web UI of an Otoroshi Operator application in the Clever Cloud Console
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @returns {Promise<void>}
+ */
+export async function openWebUi (params) {
+  const [addonIdOrName] = params.args;
+  await operatorOpenWebUi('otoroshi', addonIdOrName);
+}
+
+/**
+ * Reboot an Otoroshi operator
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @returns {Promise<void>}
+ */
+export async function reboot (params) {
+  const [addonIdOrName] = params.args;
+  await operatorReboot('otoroshi', addonIdOrName);
+}
+
+/**
+ * Rebuild an Otoroshi operator
+ * @param {object} params The command's parameters
+ * @param {string} params.args[0] The operator's name or ID
+ * @returns {Promise<void>}
+ */
+export async function rebuild (params) {
+  const [addonIdOrName] = params.args;
+  await operatorRebuild('otoroshi', addonIdOrName);
+}

package/src/commands/profile.js

@@ -1,7 +1,8 @@
 import colors from 'colors/safe.js';
-import openPage from 'open';
+import { openBrowser } from '../models/utils.js';
 import { Logger } from '../logger.js';
 import * as User from '../models/user.js';
+import dedent from 'dedent';
 
 export async function profile (params) {
   const { format } = params.options;
@@ -37,18 +38,18 @@ export async function profile (params) {
     }
     case 'human':
     default: {
-      Logger.println('You\'re currently logged in as:');
-      Logger.println(`User id           ${formattedUser.id}`);
-      Logger.println(`Name              ${formattedUser.name ?? colors.red.bold('[not specified]')}`);
-      Logger.println(`Email             ${formattedUser.email}`);
-      Logger.println(`Token expiration  ${tokenExpiration}`);
-      Logger.println(`Two factor auth   ${formattedUser.has2FA ? 'yes' : 'no'}`);
+      Logger.println(dedent`
+        You're currently logged in as:
+        User id           ${formattedUser.id}
+        Name              ${formattedUser.name ?? colors.red.bold('[not specified]')}
+        Email             ${formattedUser.email}
+        Token expiration  ${tokenExpiration}
+        Two factor auth   ${formattedUser.has2FA ? 'yes' : 'no'}
+      `);
     }
   }
 };
 
 export async function openProfile () {
-  const URL = 'https://console.clever-cloud.com/users/me/information';
-  Logger.debug('Opening the profile page in your browser');
-  await openPage(URL, { wait: false });
+  await openBrowser('/users/me/information', 'Opening the profile page in your browser');
 }

package/src/commands/published-config.js

@@ -3,13 +3,13 @@ import { Logger } from '../logger.js';
 import * as variables from '../models/variables.js';
 import { sendToApi } from '../models/send-to-api.js';
 import { toNameEqualsValueString, validateName } from '@clevercloud/client/esm/utils/env-vars.js';
-import * as application from '@clevercloud/client/esm/api/v2/application.js';
+import { getAllExposedEnvVars, updateAllExposedEnvVars } from '@clevercloud/client/esm/api/v2/application.js';
 
 export async function list (params) {
   const { alias, app: appIdOrName, format } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
-  const publishedConfigs = await application.getAllExposedEnvVars({ id: ownerId, appId }).then(sendToApi);
+  const publishedConfigs = await getAllExposedEnvVars({ id: ownerId, appId }).then(sendToApi);
   const pairs = Object.entries(publishedConfigs).map(([name, value]) => ({ name, value }));
 
   switch (format) {
@@ -39,9 +39,9 @@ export async function set (params) {
 
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
-  const publishedConfigs = await application.getAllExposedEnvVars({ id: ownerId, appId }).then(sendToApi);
+  const publishedConfigs = await getAllExposedEnvVars({ id: ownerId, appId }).then(sendToApi);
   publishedConfigs[varName] = varValue;
-  await application.updateAllExposedEnvVars({ id: ownerId, appId }, publishedConfigs).then(sendToApi);
+  await updateAllExposedEnvVars({ id: ownerId, appId }, publishedConfigs).then(sendToApi);
 
   Logger.println('Your published config item has been successfully saved');
 };
@@ -51,9 +51,9 @@ export async function rm (params) {
   const { alias, app: appIdOrName } = params.options;
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
-  const publishedConfigs = await application.getAllExposedEnvVars({ id: ownerId, appId }).then(sendToApi);
+  const publishedConfigs = await getAllExposedEnvVars({ id: ownerId, appId }).then(sendToApi);
   delete publishedConfigs[varName];
-  await application.updateAllExposedEnvVars({ id: ownerId, appId }, publishedConfigs).then(sendToApi);
+  await updateAllExposedEnvVars({ id: ownerId, appId }, publishedConfigs).then(sendToApi);
 
   Logger.println('Your published config item has been successfully removed');
 };
@@ -64,7 +64,7 @@ export async function importEnv (params) {
   const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
 
   const publishedConfigs = await variables.readVariablesFromStdin(format);
-  await application.updateAllExposedEnvVars({ id: ownerId, appId }, publishedConfigs).then(sendToApi);
+  await updateAllExposedEnvVars({ id: ownerId, appId }, publishedConfigs).then(sendToApi);
 
   Logger.println('Your published configs have been set');
 };

package/src/commands/restart.js

@@ -26,7 +26,7 @@ export async function restart (params) {
   const commitId = fullCommitId || remoteCommitId;
   if (commitId != null) {
     const cacheSuffix = withoutCache ? ' without using cache' : '';
-    Logger.println(`Restarting ${app.name} on commit ${colors.green(commitId)}${cacheSuffix}`);
+    Logger.println(`🔄 Restarting ${colors.bold(app.name)}${cacheSuffix} ${colors.grey(`(${commitId})`)}`);
   }
 
   // This should be handled by the API when a deployment ID is set but we'll do this for now