clever-tools 4.2.0 → 4.4.0

package/README.md

@@ -7,7 +7,7 @@ The official CLI for [Clever Cloud](https://www.clever.cloud) - Deploy and manag
 
 ## Quick Start
 
-**Prerequisites:** Node.js 22+ 
+**Prerequisites:** Node.js 22+
 
 ```bash
 # Install globally
@@ -38,7 +38,7 @@ For Node.js users, npm is the fastest way. For other installation methods includ
 
 - Docker images
 - Binary downloads
-- Native packages (RPM, DEB)  
+- Native packages (RPM, DEB)
 - Package managers (Homebrew, WinGet, AUR)
 
 See our complete [setup guide](docs/setup-systems.md).
@@ -51,15 +51,15 @@ Enable smart autocompletion for bash or zsh:
 # Bash
 clever --bash-autocomplete-script $(which clever) | sudo tee /usr/share/bash-completion/completions/clever
 
-# Zsh  
+# Zsh
 clever --zsh-autocomplete-script $(which clever) | sudo tee /usr/share/zsh/site-functions/_clever
 ```
 
 ## Documentation
 
-- **[Complete CLI Documentation](https://www.clever-cloud.com/developers/doc/cli/)** - Official user guide
-- **[CLI Reference](https://www.clever-cloud.com/developers/doc/reference/cli/)** - Complete command reference
-- **[Deployment Examples](https://www.clever-cloud.com/developers/guides/)** - Real-world tutorials
+- **[Complete CLI Documentation](https://www.clever.cloud/developers/doc/cli/)** - Official user guide
+- **[CLI Reference](https://www.clever.cloud/developers/doc/reference/cli/)** - Complete command reference
+- **[Deployment Examples](https://www.clever.cloud/developers/guides/)** - Real-world tutorials
 
 ## Basic Usage
 
@@ -100,7 +100,7 @@ clever logs --since 1h
 clever restart --app <app_id>
 ```
 
-Learn more in our [Application Management Guide](https://www.clever-cloud.com/developers/doc/cli/applications/).
+Learn more in our [Application Management Guide](https://www.clever.cloud/developers/doc/cli/applications/).
 
 ### Add-ons & Services Management
 
@@ -121,7 +121,7 @@ clever features enable operatos
 clever keycloak get myKetcloak
 ```
 
-Learn more in our [Add-ons & Services Guide](https://www.clever-cloud.com/developers/doc/cli/addons/).
+Learn more in our [Add-ons & Services Guide](https://www.clever.cloud/developers/doc/cli/addons/).
 
 # Create and manage
 
@@ -144,7 +144,7 @@ clever tokens create myTokenName
 clever tokens create myTokenName --expiration 2w --format json
 ```
 
-Learn more about API integration in our [API How-to Guide](https://www.clever-cloud.com/developers/api/howto).
+Learn more about API integration in our [API How-to Guide](https://www.clever.cloud/developers/api/howto).
 
 ### Get Help
 

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';
@@ -99,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',
     }),
@@ -162,8 +168,8 @@ async function run() {
     }),
     drainId: cliparse.argument('drain-id', { description: 'Drain ID' }),
     drainType: cliparse.argument('drain-type', {
-      description: 'Drain type',
-      complete: Drain.listDrainTypes,
+      description: Drain.DRAIN_TYPE_CLI_CODES.join(', '),
+      complete: Drain.DRAIN_TYPE_CLI_CODES,
     }),
     drainUrl: cliparse.argument('drain-url', { description: 'Drain URL' }),
     fqdn: cliparse.argument('fqdn', { description: 'Domain name of the application' }),
@@ -196,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)',
@@ -407,7 +420,7 @@ async function run() {
     drainPassword: cliparse.option('password', {
       aliases: ['p'],
       metavar: 'password',
-      description: '(HTTP drains) basic auth password',
+      description: 'Basic auth password (for elasticsearch or raw-http)',
     }),
     addonPlan: cliparse.option('plan', {
       aliases: ['p'],
@@ -479,22 +492,22 @@ async function run() {
     drainUsername: cliparse.option('username', {
       aliases: ['u'],
       metavar: 'username',
-      description: '(HTTP drains) basic auth username',
+      description: 'Basic auth username (for elasticsearch or raw-http)',
     }),
-    drainAPIKey: cliparse.option('api-key', {
+    drainApiKey: cliparse.option('api-key', {
       aliases: ['k'],
       metavar: 'api_key',
-      description: '(NewRelic drains) API key',
+      description: 'API key (for newrelic)',
     }),
     drainIndexPrefix: cliparse.option('index-prefix', {
       aliases: ['i'],
       metavar: 'index_prefix',
-      description: '(ElasticSearch drains) optional index prefix. `logstash` value is used if not set',
+      description: 'Optional index prefix (for elasticsearch), `logstash` value is used if not set',
     }),
-    drainSDParameters: cliparse.option('sd-params', {
+    drainSdParameters: cliparse.option('sd-params', {
       aliases: ['s'],
       metavar: 'sd_params',
-      description: '(TCP and UDP drains) sd-params string (e.g.: `X-OVH-TOKEN=\\"REDACTED\\"`)',
+      description: 'RFC5424 structured data parameters (for ovh-tcp), e.g.: `X-OVH-TOKEN=\\"REDACTED\\"`',
     }),
     verbose: cliparse.flag('verbose', { aliases: ['v'], description: 'Verbose output' }),
     color: cliparse.flag('color', {
@@ -857,20 +870,29 @@ async function run() {
       options: [
         opts.drainUsername,
         opts.drainPassword,
-        opts.drainAPIKey,
+        opts.drainApiKey,
         opts.drainIndexPrefix,
-        opts.drainSDParameters,
+        opts.drainSdParameters,
       ],
     },
     drain.create,
   );
+  const drainGetCommand = cliparse.command(
+    'get',
+    {
+      description: 'Get drain info',
+      args: [args.drainId],
+      privateOptions: [opts.humanJsonOutputFormat],
+    },
+    drain.get,
+  );
   const drainRemoveCommand = cliparse.command(
     'remove',
     {
       description: 'Remove a drain',
       args: [args.drainId],
     },
-    drain.rm,
+    drain.remove,
   );
   const drainEnableCommand = cliparse.command(
     'enable',
@@ -892,9 +914,9 @@ async function run() {
     'drain',
     {
       description: 'Manage drains',
-      options: [opts.alias, opts.appIdOrName, opts.addonId],
+      options: [opts.alias, opts.appIdOrName],
       privateOptions: [opts.humanJsonOutputFormat],
-      commands: [drainCreateCommand, drainRemoveCommand, drainEnableCommand, drainDisableCommand],
+      commands: [drainCreateCommand, drainGetCommand, drainRemoveCommand, drainEnableCommand, drainDisableCommand],
     },
     drain.list,
   );
@@ -1043,6 +1065,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',
@@ -1531,6 +1620,14 @@ async function run() {
     },
     otoroshi.get,
   );
+  const otoroshiGetConfigCommand = cliparse.command(
+    'get-config',
+    {
+      description: 'Get configuration of a deployed Otoroshi in otoroshictl format',
+      args: [args.addonIdOrName],
+    },
+    otoroshi.getConfig,
+  );
   const otoroshiEnableNgCommand = cliparse.command(
     'enable-ng',
     {
@@ -1623,6 +1720,7 @@ async function run() {
       privateOptions: [opts.humanJsonOutputFormat],
       commands: [
         otoroshiGetCommand,
+        otoroshiGetConfigCommand,
         otoroshiEnableNgCommand,
         otoroshiDisableNgCommand,
         otoroshiOpenCommand,
@@ -2048,6 +2146,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.2.0",
+  "version": "4.4.0",
   "description": "Command Line Interface for Clever Cloud.",
   "keywords": [
     "cli",
@@ -90,6 +90,7 @@
     "node": ">=22"
   },
   "volta": {
-    "node": "22.17.0"
+    "node": "22.17.0",
+    "npm": "11.6.2"
   }
 }

package/src/clever-client/drains.js

@@ -0,0 +1,127 @@
+// TODO: Move this to the Clever Cloud JS Client
+
+/**
+ * GET /v4/drains/organisations/{ownerId}/applications/{applicationId}/drains?status={status}&executionStatus={executionStatus}&executionStatusNotIn={executionStatusNotIn}
+ * @param {Object} params
+ * @param {String} params.ownerId
+ * @param {String} params.applicationId
+ * @param {String} params.status
+ * @param {String} params.executionStatus
+ * @param {String} params.executionStatusNotIn
+ */
+export function getDrains(params) {
+  // no multipath for /self or /organisations/{id}
+  return Promise.resolve({
+    method: 'get',
+    url: `/v4/drains/organisations/${params.ownerId}/applications/${params.applicationId}/drains`,
+    headers: { Accept: 'application/json' },
+    queryParams: {
+      status: params.status,
+      executionStatus: params.executionStatus,
+      executionStatusNotIn: params.executionStatusNotIn,
+    },
+    // no body
+  });
+}
+
+/**
+ * POST /v4/drains/organisations/{ownerId}/applications/{applicationId}/drains
+ * @param {Object} params
+ * @param {String} params.ownerId
+ * @param {String} params.applicationId
+ * @param {Object} params.body
+ */
+export function createDrain(params) {
+  // no multipath for /self or /organisations/{id}
+  return Promise.resolve({
+    method: 'post',
+    url: `/v4/drains/organisations/${params.ownerId}/applications/${params.applicationId}/drains`,
+    headers: { Accept: 'application/json', 'Content-Type': 'application/json' },
+    body: params.body,
+  });
+}
+
+/**
+ * DELETE /v4/drains/organisations/{ownerId}/applications/{applicationId}/drains/{drainId}
+ * @param {Object} params
+ * @param {String} params.ownerId
+ * @param {String} params.applicationId
+ * @param {String} params.drainId
+ */
+export function deleteDrain(params) {
+  // no multipath for /self or /organisations/{id}
+  return Promise.resolve({
+    method: 'delete',
+    url: `/v4/drains/organisations/${params.ownerId}/applications/${params.applicationId}/drains/${params.drainId}`,
+    headers: { Accept: 'application/json' },
+    // no body
+  });
+}
+
+/**
+ * GET /v4/drains/organisations/{ownerId}/applications/{applicationId}/drains/{drainId}
+ * @param {Object} params
+ * @param {String} params.ownerId
+ * @param {String} params.applicationId
+ * @param {String} params.drainId
+ */
+export function getDrain(params) {
+  // no multipath for /self or /organisations/{id}
+  return Promise.resolve({
+    method: 'get',
+    url: `/v4/drains/organisations/${params.ownerId}/applications/${params.applicationId}/drains/${params.drainId}`,
+    headers: { Accept: 'application/json' },
+    // no body
+  });
+}
+
+/**
+ * PUT /v4/drains/organisations/{ownerId}/applications/{applicationId}/drains/{drainId}/disable
+ * @param {Object} params
+ * @param {String} params.ownerId
+ * @param {String} params.applicationId
+ * @param {String} params.drainId
+ */
+export function disableDrain(params) {
+  // no multipath for /self or /organisations/{id}
+  return Promise.resolve({
+    method: 'put',
+    url: `/v4/drains/organisations/${params.ownerId}/applications/${params.applicationId}/drains/${params.drainId}/disable`,
+    headers: { Accept: 'application/json' },
+    // no body
+  });
+}
+
+/**
+ * PUT /v4/drains/organisations/{ownerId}/applications/{applicationId}/drains/{drainId}/enable
+ * @param {Object} params
+ * @param {String} params.ownerId
+ * @param {String} params.applicationId
+ * @param {String} params.drainId
+ */
+export function enableDrain(params) {
+  // no multipath for /self or /organisations/{id}
+  return Promise.resolve({
+    method: 'put',
+    url: `/v4/drains/organisations/${params.ownerId}/applications/${params.applicationId}/drains/${params.drainId}/enable`,
+    headers: { Accept: 'application/json' },
+    // no body
+  });
+}
+
+/**
+ * PATCH /v4/drains/organisations/{ownerId}/applications/{applicationId}/drains/{drainId}/reset-cursor
+ * @param {Object} params
+ * @param {String} params.ownerId
+ * @param {String} params.applicationId
+ * @param {String} params.drainId
+ */
+export function resetDrainCursor(params) {
+  // no multipath for /self or /organisations/{id}
+  return Promise.resolve({
+    method: 'patch',
+    url: `/v4/drains/organisations/${params.ownerId}/applications/${params.applicationId}/drains/${params.drainId}/reset-cursor`,
+    headers: { Accept: 'application/json' },
+    // no body
+  });
+}

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/clever-client/operators.js

@@ -119,3 +119,19 @@ export function versionUpdate(params, body) {
     body,
   });
 }
+
+/**
+ * GET /v4/addon-providers/addon-otoroshi/addons/{realId}/config.yaml
+ * @param {Object} params
+ * @param {String} params.realId
+ */
+export function getOtoroshiConfig(params) {
+  // no multipath for /self or /organisations/{id}
+  return Promise.resolve({
+    method: 'get',
+    url: `/v4/addon-providers/addon-otoroshi/addons/${params.realId}/config.yaml`,
+    // headers: { Accept: 'application/yaml' },
+    // no queryParams
+    // no body
+  });
+}