@kustodian/plugin-k0s 1.0.0 → 1.1.0

package/README.md

@@ -0,0 +1,57 @@
+# @kustodian/plugin-k0s
+
+A [k0s](https://k0sproject.io/) cluster provider plugin for [Kustodian](https://github.com/lucasilverentand/kustodian).
+
+## Installation
+
+```bash
+bun add @kustodian/plugin-k0s
+```
+
+## Overview
+
+This plugin provides k0s cluster lifecycle management through the [k0sctl](https://github.com/k0sproject/k0sctl) tool. It implements the `ClusterProviderType` interface from `@kustodian/plugins`.
+
+### Features
+
+- **Cluster Bootstrap**: Automatically generates k0sctl configuration from your node definitions and deploys k0s
+- **Kubeconfig Retrieval**: Fetch kubeconfig from deployed clusters
+- **Cluster Reset**: Tear down clusters with optional force mode
+- **Configuration Validation**: Validates node configurations before deployment
+- **Dry Run Support**: Test configurations without applying changes
+
+### Prerequisites
+
+- [k0sctl](https://github.com/k0sproject/k0sctl) must be installed and available in your PATH
+- SSH access to target nodes
+
+## Usage
+
+```typescript
+import { create_k0s_plugin, create_k0s_provider } from '@kustodian/plugin-k0s';
+
+// Create provider with options
+const provider = create_k0s_provider({
+  k0s_version: '1.30.0+k0s.0',
+  telemetry_enabled: false,
+  dynamic_config: true,
+});
+
+// Or use the plugin directly
+const plugin = create_k0s_plugin({
+  k0s_version: '1.30.0+k0s.0',
+});
+```
+
+### Provider Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `k0s_version` | `string` | k0s version to install |
+| `telemetry_enabled` | `boolean` | Enable k0s telemetry (default: `false`) |
+| `dynamic_config` | `boolean` | Enable dynamic configuration |
+| `default_ssh` | `SshConfigType` | Default SSH configuration for nodes |
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kustodian/plugin-k0s",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "k0s cluster provider plugin for Kustodian",
   "type": "module",
   "main": "./src/index.ts",
@@ -37,9 +37,9 @@
     "registry": "https://npm.pkg.github.com"
   },
   "dependencies": {
-    "@kustodian/core": "workspace:*",
-    "@kustodian/nodes": "workspace:*",
-    "@kustodian/plugins": "workspace:*",
+    "@kustodian/core": "1.1.0",
+    "@kustodian/nodes": "1.1.0",
+    "@kustodian/plugins": "1.0.1",
     "yaml": "^2.8.2"
   },
   "devDependencies": {}

package/src/executor.ts

@@ -76,7 +76,7 @@ function is_exec_error(
  * Checks if k0sctl is available in the system PATH.
  */
 export async function check_k0sctl_available(): Promise<ResultType<string, KustodianErrorType>> {
-  const result = await exec_command('k0sctl', ['version']);
+  const result = await exec_command('k0sctl', ['version'], { timeout: 5000 });
 
   if (!result.success) {
     return result;
@@ -124,7 +124,10 @@ export async function k0sctl_kubeconfig(
   config_path: string,
   options: ExecOptionsType = {},
 ): Promise<ResultType<string, KustodianErrorType>> {
-  const result = await exec_command('k0sctl', ['kubeconfig', '--config', config_path], options);
+  const result = await exec_command('k0sctl', ['kubeconfig', '--config', config_path], {
+    timeout: 30000,
+    ...options,
+  });
 
   if (!result.success) {
     return result;
@@ -150,7 +153,10 @@ export async function k0sctl_reset(
     args.push('--force');
   }
 
-  const result = await exec_command('k0sctl', args, options);
+  const result = await exec_command('k0sctl', args, {
+    timeout: 60000,
+    ...options,
+  });
 
   if (!result.success) {
     return result;

package/src/provider.ts

@@ -117,6 +117,12 @@ export function create_k0s_provider(options: K0sProviderOptionsType = {}): Clust
     },
 
     async get_kubeconfig(node_list: NodeListType): Promise<ResultType<string, KustodianErrorType>> {
+      // Check k0sctl is available
+      const k0sctl_check = await check_k0sctl_available();
+      if (!is_success(k0sctl_check)) {
+        return k0sctl_check;
+      }
+
       // If we have a config path from install, use it
       if (config_path) {
         return k0sctl_kubeconfig(config_path);