clever-tools 4.8.0 → 4.9.0

package/src/commands/k8s/k8s.docs.md

@@ -12,6 +12,28 @@ Manage Kubernetes clusters
 clever k8s
 ```
 
+## ➡️ `clever k8s activity` <kbd>Since 4.9.0</kbd>
+
+Show recent deployment events of a Kubernetes cluster
+
+```bash
+clever k8s activity <cluster-id|cluster-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`cluster-id|cluster-name`|Kubernetes cluster ID or name|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+|`--limit` `<limit>`|Number of events to fetch (1 to 1000) (default: 50)|
+|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+
 ## ➡️ `clever k8s add-persistent-storage` <kbd>Since 4.3.0</kbd>
 
 Activate persistent storage to a deployed Kubernetes cluster
@@ -50,8 +72,18 @@ clever k8s create <cluster-name> [options]
 
 |Name|Description|
 |---|---|
+|`--autoscaling`|Enable the cluster autoscaler|
+|`--cluster-version` `<cluster-version>`|Kubernetes version to deploy (e.g.: 1.36)|
+|`--description` `<description>`|Free-form cluster description|
+|`--flavor` `<flavor>`|Control plane flavor|
+|`--nodegroup` `<flavor:count>`|Initial node group (format: <flavor>:<count>, e.g.: XS:3)|
 |`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+|`--persistent-storage`|Enable persistent storage (Ceph CSI)|
+|`--replication-factor` `<replication-factor>`|Control plane replication factor|
+|`--tag` `<tag[,tag...]>`|Semantic tags (comma-separated, e.g.: env:prod,team:platform)|
+|`--topology` `<topology>`|Cluster topology (must be set with --flavor and --replication-factor)|
 |`-w`, `--watch`|Watch the deployment until the cluster is deployed|
+|`-y`, `--yes`|Skip confirmation prompts|
 
 ## ➡️ `clever k8s delete` <kbd>Since 4.3.0</kbd>
 
@@ -72,7 +104,7 @@ clever k8s delete <cluster-id|cluster-name> [options]
 |Name|Description|
 |---|---|
 |`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
-|`-y`, `--yes`|Skip confirmation and proceed with deletion directly|
+|`-y`, `--yes`|Skip confirmation prompts|
 
 ## ➡️ `clever k8s get` <kbd>Since 4.3.0</kbd>
 
@@ -129,3 +161,234 @@ clever k8s list [options]
 |---|---|
 |`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
 |`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+
+## ➡️ `clever k8s nodegroups` <kbd>Since 4.9.0</kbd>
+
+Manage Kubernetes node groups
+
+```bash
+clever k8s nodegroups
+```
+
+## ➡️ `clever k8s nodegroups create` <kbd>Since 4.9.0</kbd>
+
+Create a node group on a Kubernetes cluster
+
+```bash
+clever k8s nodegroups create <cluster-id|cluster-name> <nodegroup-name> <flavor:count> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`cluster-id|cluster-name`|Kubernetes cluster ID or name|
+|`nodegroup-name`|Node group name (lowercase RFC 1123, max 63 chars)|
+|`flavor:count`|Node group flavor and target node count (format: <flavor>:<count>, e.g.: XS:3)|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`--autoscaling`|Enable cluster autoscaler for this node group (requires --min and --max)|
+|`--description` `<description>`|Free-form node group description|
+|`--max` `<max>`|Maximum node count when autoscaling is enabled|
+|`--min` `<min>`|Minimum node count when autoscaling is enabled|
+|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+|`--tag` `<tag>`|Arbitrary tag attached to the node group|
+
+## ➡️ `clever k8s nodegroups delete` <kbd>Since 4.9.0</kbd>
+
+Delete a node group from a Kubernetes cluster
+
+```bash
+clever k8s nodegroups delete <cluster-id|cluster-name> <nodegroup-id|nodegroup-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`cluster-id|cluster-name`|Kubernetes cluster ID or name|
+|`nodegroup-id|nodegroup-name`|Kubernetes node group ID or name|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+|`-y`, `--yes`|Skip confirmation prompts|
+
+## ➡️ `clever k8s nodegroups get` <kbd>Since 4.9.0</kbd>
+
+Get information about a Kubernetes node group
+
+```bash
+clever k8s nodegroups get <cluster-id|cluster-name> <nodegroup-id|nodegroup-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`cluster-id|cluster-name`|Kubernetes cluster ID or name|
+|`nodegroup-id|nodegroup-name`|Kubernetes node group ID or name|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+
+## ➡️ `clever k8s nodegroups list` <kbd>Since 4.9.0</kbd>
+
+List the node groups of a Kubernetes cluster
+
+```bash
+clever k8s nodegroups list <cluster-id|cluster-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`cluster-id|cluster-name`|Kubernetes cluster ID or name|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+
+## ➡️ `clever k8s nodegroups update` <kbd>Since 4.9.0</kbd>
+
+Update a node group on a Kubernetes cluster
+
+```bash
+clever k8s nodegroups update <cluster-id|cluster-name> <nodegroup-id|nodegroup-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`cluster-id|cluster-name`|Kubernetes cluster ID or name|
+|`nodegroup-id|nodegroup-name`|Kubernetes node group ID or name|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`--autoscaling`|Enable the cluster autoscaler|
+|`--count` `<count>`|Target node count|
+|`--description` `<description>`|Free-form node group description|
+|`--disable-autoscaling`|Disable the cluster autoscaler|
+|`--max` `<max>`|Maximum node count (autoscaling bound)|
+|`--min` `<min>`|Minimum node count (autoscaling bound)|
+|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+|`--tag` `<tag>`|Arbitrary tag attached to the node group|
+
+## ➡️ `clever k8s quota` <kbd>Since 4.9.0</kbd>
+
+Get the Kubernetes quota, usage and remaining of an organisation
+
+```bash
+clever k8s quota [options]
+```
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+
+## ➡️ `clever k8s update` <kbd>Since 4.9.0</kbd>
+
+Update a Kubernetes cluster metadata or features
+
+```bash
+clever k8s update <cluster-id|cluster-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`cluster-id|cluster-name`|Kubernetes cluster ID or name|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`--autoscaling`|Enable the cluster autoscaler|
+|`--description` `<description>`|Free-form cluster description|
+|`--disable-autoscaling`|Disable the cluster autoscaler|
+|`--name` `<name>`|Rename the cluster|
+|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+|`--tag` `<tag[,tag...]>`|Replace tags (comma-separated, e.g.: env:prod,team:platform)|
+
+## ➡️ `clever k8s version` <kbd>Since 4.9.0</kbd>
+
+Check a Kubernetes cluster deployed version
+
+```bash
+clever k8s version <cluster-id|cluster-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`cluster-id|cluster-name`|Kubernetes cluster ID or name|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+
+## ➡️ `clever k8s version check` <kbd>Since 4.9.0</kbd>
+
+Check a Kubernetes cluster deployed version
+
+```bash
+clever k8s version check <cluster-id|cluster-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`cluster-id|cluster-name`|Kubernetes cluster ID or name|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+
+## ➡️ `clever k8s version update` <kbd>Since 4.9.0</kbd>
+
+Update a Kubernetes cluster to a target version
+
+```bash
+clever k8s version update <cluster-id|cluster-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`cluster-id|cluster-name`|Kubernetes cluster ID or name|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
+|`--target` `<version>`|Target version to upgrade to (e.g.: 24, 2.4, 2.4.1)|

package/src/commands/k8s/k8s.get.command.js

@@ -23,13 +23,67 @@ export const k8sGetCommand = defineCommand({
         Logger.printJson(k8sInfo);
         break;
       case 'human':
-      default:
-        console.table({
+      default: {
+        const topo = k8sInfo.topologyConfig;
+        const overview = {
           Name: k8sInfo.name,
           ID: k8sInfo.id,
-          Version: k8sInfo.version,
           Status: k8sInfo.status,
-        });
+          Version: k8sInfo.version,
+          Topology: formatTopology(topo),
+          Autoscaling: k8sInfo.features?.autoscalingEnabled ? 'enabled' : 'disabled',
+          'Persistent storage': k8sInfo.features?.csi != null ? 'enabled' : 'disabled',
+        };
+        if (k8sInfo.tags?.length) overview.Tags = k8sInfo.tags.join(', ');
+        if (k8sInfo.description) overview.Description = k8sInfo.description;
+        if (k8sInfo.storageUsageBytes != null) {
+          overview.Storage = `${Math.round((k8sInfo.storageUsageBytes / 1024 ** 3) * 100) / 100} GB`;
+        }
+        console.table(overview);
+
+        if (topo?.topology === 'DISTRIBUTED' && topo.components) {
+          Logger.println('');
+          Logger.println('🧩 Control plane components');
+          console.table(
+            Object.fromEntries(
+              Object.entries(topo.components).map(([name, c]) => [
+                name,
+                { Flavor: c?.flavor ?? '-', RF: c?.replicationFactor ?? '-' },
+              ]),
+            ),
+          );
+        }
+
+        if (k8sInfo.nodeGroups?.length) {
+          Logger.println('');
+          Logger.println(`🧮 Node groups (${k8sInfo.nodeGroups.length})`);
+          console.table(
+            Object.fromEntries(
+              k8sInfo.nodeGroups.map((ng) => [
+                ng.id,
+                {
+                  Name: ng.name,
+                  Status: ng.status,
+                  Flavor: ng.flavor,
+                  Nodes: `${ng.currentNodeCount}/${ng.targetNodeCount}`,
+                },
+              ]),
+            ),
+          );
+        }
+
+        if (k8sInfo.loadBalancers?.length) {
+          Logger.println('');
+          Logger.println(`🔀 Load balancers (${k8sInfo.loadBalancers.length})`);
+          k8sInfo.loadBalancers.forEach((lb) => {
+            console.table({
+              ID: lb.id,
+              Flavor: lb.flavor,
+              IPs: lb.ips?.join(', ') ?? '-',
+              Domain: lb.domainName ?? '-',
+            });
+          });
+        }
 
         Logger.println('');
         const orgMessageComplement = orgIdOrName ? `--org "${orgIdOrName.orga_id || orgIdOrName.orga_name}"` : '';
@@ -38,6 +92,13 @@ export const k8sGetCommand = defineCommand({
           `Once ACTIVE, get the kubeconfig with ${styleText('blue', `clever k8s get-kubeconfig ${k8sInfo.id} ${orgMessageComplement}`)}`,
         );
         break;
+      }
     }
   },
 });
+
+function formatTopology(topo) {
+  if (topo == null) return '-';
+  if (topo.topology === 'DISTRIBUTED') return 'DISTRIBUTED';
+  return `${topo.topology} (${topo.flavor}, rf=${topo.replicationFactor})`;
+}

package/src/commands/k8s/k8s.nodegroups.command.js

@@ -0,0 +1,7 @@
+import { defineCommand } from '../../lib/define-command.js';
+
+export const k8sNodeGroupCommand = defineCommand({
+  description: 'Manage Kubernetes node groups',
+  since: '4.9.0',
+  featureFlag: 'k8s',
+});

package/src/commands/k8s/k8s.nodegroups.create.command.js

@@ -0,0 +1,79 @@
+import { z } from 'zod';
+import { defineArgument } from '../../lib/define-argument.js';
+import { defineCommand } from '../../lib/define-command.js';
+import { defineOption } from '../../lib/define-option.js';
+import { k8sCreateNodeGroup } from '../../lib/k8s.js';
+import { styleText } from '../../lib/style-text.js';
+import { Logger } from '../../logger.js';
+import { flavorCount } from '../../parsers.js';
+import { orgaIdOrNameOption } from '../global.options.js';
+import { k8sIdOrNameArg } from './k8s.args.js';
+
+export const k8sNodeGroupCreateCommand = defineCommand({
+  description: 'Create a node group on a Kubernetes cluster',
+  since: '4.9.0',
+  options: {
+    description: defineOption({
+      name: 'description',
+      schema: z.string().max(4096).optional(),
+      description: 'Free-form node group description',
+      placeholder: 'description',
+    }),
+    tag: defineOption({
+      name: 'tag',
+      schema: z.string().max(1024).optional(),
+      description: 'Arbitrary tag attached to the node group',
+      placeholder: 'tag',
+    }),
+    autoscaling: defineOption({
+      name: 'autoscaling',
+      schema: z.boolean().default(false),
+      description: 'Enable cluster autoscaler for this node group (requires --min and --max)',
+    }),
+    min: defineOption({
+      name: 'min',
+      schema: z.coerce.number().int().min(0).max(256).optional(),
+      description: 'Minimum node count when autoscaling is enabled',
+      placeholder: 'min',
+    }),
+    max: defineOption({
+      name: 'max',
+      schema: z.coerce.number().int().min(0).max(256).optional(),
+      description: 'Maximum node count when autoscaling is enabled',
+      placeholder: 'max',
+    }),
+    org: orgaIdOrNameOption,
+  },
+  args: [
+    k8sIdOrNameArg,
+    defineArgument({
+      schema: z
+        .string()
+        .regex(
+          /^[a-z0-9]([-a-z0-9]{0,61}[a-z0-9])?$/,
+          'Must be lowercase RFC 1123 (letters, digits, "-"), start/end alphanumeric, max 63 chars',
+        ),
+      description: 'Node group name (lowercase RFC 1123, max 63 chars)',
+      placeholder: 'nodegroup-name',
+    }),
+    defineArgument({
+      schema: z.string().transform(flavorCount),
+      description: 'Node group flavor and target node count (format: <flavor>:<count>, e.g.: XS:3)',
+      placeholder: 'flavor:count',
+    }),
+  ],
+  async handler(options, clusterIdOrName, nodeGroupName, spec) {
+    const { org: orgIdOrName } = options;
+    const nodeGroup = await k8sCreateNodeGroup(orgIdOrName, clusterIdOrName, {
+      name: nodeGroupName,
+      flavor: spec.flavor,
+      targetNodeCount: spec.targetNodeCount,
+      description: options.description,
+      tag: options.tag,
+      autoscaling: options.autoscaling,
+      min: options.min,
+      max: options.max,
+    });
+    Logger.println(`🚀 Node group ${styleText('white', `${nodeGroup.name} (${nodeGroup.id})`)} is being deployed`);
+  },
+});

package/src/commands/k8s/k8s.nodegroups.delete.command.js

@@ -0,0 +1,34 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { k8sDeleteNodeGroup } from '../../lib/k8s.js';
+import { ask } from '../../lib/prompts.js';
+import { styleText } from '../../lib/style-text.js';
+import { Logger } from '../../logger.js';
+import { orgaIdOrNameOption, skipConfirmationOption } from '../global.options.js';
+import { k8sIdOrNameArg, k8sNodeGroupIdOrNameArg } from './k8s.args.js';
+
+export const k8sNodeGroupDeleteCommand = defineCommand({
+  description: 'Delete a node group from a Kubernetes cluster',
+  since: '4.9.0',
+  options: {
+    org: orgaIdOrNameOption,
+    yes: skipConfirmationOption,
+  },
+  args: [k8sIdOrNameArg, k8sNodeGroupIdOrNameArg],
+  async handler(options, clusterIdOrName, nodeGroupIdOrName) {
+    const { org: orgIdOrName, yes } = options;
+
+    if (!yes) {
+      const proceed = await ask(
+        `Are you sure you want to delete the node group ${styleText('blue', nodeGroupIdOrName)}?`,
+        false,
+      );
+      if (!proceed) {
+        Logger.println('Node group deletion cancelled');
+        return;
+      }
+    }
+
+    await k8sDeleteNodeGroup(orgIdOrName, clusterIdOrName, nodeGroupIdOrName);
+    Logger.printSuccess(`Node group ${styleText('green', nodeGroupIdOrName)} successfully deleted`);
+  },
+});

package/src/commands/k8s/k8s.nodegroups.get.command.js

@@ -0,0 +1,66 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { k8sGetNodeGroup } from '../../lib/k8s.js';
+import { Logger } from '../../logger.js';
+import { humanJsonOutputFormatOption, orgaIdOrNameOption } from '../global.options.js';
+import { k8sIdOrNameArg, k8sNodeGroupIdOrNameArg } from './k8s.args.js';
+
+export const k8sNodeGroupGetCommand = defineCommand({
+  description: 'Get information about a Kubernetes node group',
+  since: '4.9.0',
+  options: {
+    org: orgaIdOrNameOption,
+    format: humanJsonOutputFormatOption,
+  },
+  args: [k8sIdOrNameArg, k8sNodeGroupIdOrNameArg],
+  async handler(options, clusterIdOrName, nodeGroupIdOrName) {
+    const { format, org: orgIdOrName } = options;
+    const nodeGroup = await k8sGetNodeGroup(orgIdOrName, clusterIdOrName, nodeGroupIdOrName);
+
+    switch (format) {
+      case 'json':
+        Logger.printJson(nodeGroup);
+        break;
+      case 'human':
+      default: {
+        const overview = {
+          Name: nodeGroup.name,
+          ID: nodeGroup.id,
+          Status: nodeGroup.status,
+          Flavor: nodeGroup.flavor,
+          Nodes: `${nodeGroup.currentNodeCount}/${nodeGroup.targetNodeCount}`,
+          Autoscaling: nodeGroup.autoscalingEnabled ? 'enabled' : 'disabled',
+          'Min / Max': `${nodeGroup.minNodeCount} / ${nodeGroup.maxNodeCount}${nodeGroup.autoscalingEnabled ? '' : ' (inactive)'}`,
+          Created: formatDate(nodeGroup.createdAt),
+        };
+        const createdFmt = formatDate(nodeGroup.createdAt);
+        const updatedFmt = formatDate(nodeGroup.updatedAt);
+        if (nodeGroup.updatedAt && updatedFmt !== createdFmt) {
+          overview.Updated = updatedFmt;
+        }
+        if (nodeGroup.description) overview.Description = nodeGroup.description;
+        if (nodeGroup.tag) overview.Tag = nodeGroup.tag;
+        console.table(overview);
+
+        const labels = Object.entries(nodeGroup.labels ?? {});
+        if (labels.length > 0) {
+          Logger.println('');
+          Logger.println(`🏷️  Labels (${labels.length})`);
+          console.table(Object.fromEntries(labels.map(([k, v]) => [k, { Value: v }])));
+        }
+
+        const taints = nodeGroup.taints ?? [];
+        if (taints.length > 0) {
+          Logger.println('');
+          Logger.println(`🚫 Taints (${taints.length})`);
+          console.table(Object.fromEntries(taints.map((t) => [t.key, { Value: t.value ?? '-', Effect: t.effect }])));
+        }
+        break;
+      }
+    }
+  },
+});
+
+function formatDate(iso) {
+  if (iso == null) return '-';
+  return `${iso.slice(0, 16).replace('T', ' ')}Z`;
+}

package/src/commands/k8s/k8s.nodegroups.list.command.js

@@ -0,0 +1,49 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { k8sListNodeGroups } from '../../lib/k8s.js';
+import { styleText } from '../../lib/style-text.js';
+import { Logger } from '../../logger.js';
+import { humanJsonOutputFormatOption, orgaIdOrNameOption } from '../global.options.js';
+import { k8sIdOrNameArg } from './k8s.args.js';
+
+export const k8sNodeGroupListCommand = defineCommand({
+  description: 'List the node groups of a Kubernetes cluster',
+  since: '4.9.0',
+  options: {
+    org: orgaIdOrNameOption,
+    format: humanJsonOutputFormatOption,
+  },
+  args: [k8sIdOrNameArg],
+  async handler(options, clusterIdOrName) {
+    const { format, org: orgIdOrName } = options;
+    const nodeGroups = await k8sListNodeGroups(orgIdOrName, clusterIdOrName);
+
+    switch (format) {
+      case 'json':
+        Logger.printJson(nodeGroups);
+        break;
+      case 'human':
+      default:
+        if (nodeGroups.length === 0) {
+          Logger.println(
+            `🔎 No node group found, create one with ${styleText('blue', 'clever k8s nodegroups create')}`,
+          );
+          return;
+        }
+        console.table(
+          Object.fromEntries(
+            nodeGroups.map((ng) => [
+              ng.id,
+              {
+                Name: ng.name,
+                Status: ng.status,
+                Flavor: ng.flavor,
+                Nodes: `${ng.currentNodeCount}/${ng.targetNodeCount}`,
+                Autoscaling: ng.autoscalingEnabled ? `${ng.minNodeCount}-${ng.maxNodeCount}` : 'disabled',
+              },
+            ]),
+          ),
+        );
+        break;
+    }
+  },
+});