node-lxc 1.0.0

package/examples/concurrent_create/index.ts

@@ -0,0 +1,30 @@
+import {Container} from "../../lib";
+
+const name = "test-ct"
+
+/**
+ * In this example, a container is created and the calling process stdio is attached.
+ */
+async function main() {
+
+    const containers = await Promise.all([...Array(10).keys()].map(async (i) => {
+            const c = new Container(name + i);
+            if(!c.defined) {
+                await c.create({
+                    template: "download", argv: ["--dist", "ubuntu", "--release", "lunar", "--arch", "amd64"]
+                });
+                console.log(`Created ${c.name}`);
+            }else{
+                console.warn(`Container ${c.name} already defined`);
+            }
+            return c;
+        }
+    ));
+
+    console.table(containers.map((c) => {
+        return {name: c.name, state: c.state}
+    }));
+
+}
+
+main().catch(console.error);

package/examples/concurrent_destroy/index.ts

@@ -0,0 +1,23 @@
+import {Container} from "../../lib";
+
+const name = "test-ct"
+
+/**
+ * In this example, a container is created and the calling process stdio is attached.
+ */
+async function main() {
+
+    const containers = await Promise.all([...Array(10).keys()].map(async (i) => {
+            let c = new Container(name + i);
+            if (c.defined) {
+                console.log(`Destroying ${c.name}`);
+                await c.destroy();
+            } else {
+                console.warn(`Container ${c.name} not defined`);
+            }
+            return c;
+        }
+    ));
+}
+
+main().catch(console.error);

package/examples/concurrent_shutdown/index.ts

@@ -0,0 +1,28 @@
+import {Container} from "../../lib";
+
+const name = "test-ct"
+
+/**
+ * In this example, a container is created and the calling process stdio is attached.
+ */
+async function main() {
+
+    const containers = await Promise.all([...Array(10).keys()].map(async (i) => {
+            let c = new Container(name + i);
+            if (c.defined) {
+                console.log(`Shutting down ${c.name}`);
+                await c.shutdown();
+            } else {
+                console.warn(`Container ${c.name} not defined`);
+            }
+            return c;
+        }
+    ));
+
+    console.table(containers.map((c) => {
+        return {name: c.name, state: c.state}
+    }));
+
+}
+
+main().catch(console.error);

package/examples/concurrent_start/index.ts

@@ -0,0 +1,28 @@
+import {Container} from "../../lib";
+
+const name = "test-ct"
+
+/**
+ * In this example, a container is created and the calling process stdio is attached.
+ */
+async function main() {
+
+    const containers = await Promise.all([...Array(10).keys()].map(async (i) => {
+            const c = new Container(name + i);
+            if (!c.running) {
+                await c.start();
+                console.log(`Started ${c.name}`);
+            } else {
+                console.warn(`Container ${c.name} already running`);
+            }
+            return c;
+        }
+    ));
+
+    console.table(containers.map((c) => {
+        return {name: c.name, state: c.state}
+    }));
+
+}
+
+main().catch(console.error);

package/examples/concurrent_stop/index.ts

@@ -0,0 +1,28 @@
+import {Container} from "../../lib";
+
+const name = "test-ct"
+
+/**
+ * In this example, a container is created and the calling process stdio is attached.
+ */
+async function main() {
+
+    const containers = await Promise.all([...Array(10).keys()].map(async (i) => {
+            const c = new Container(name + i);
+            if (c.running) {
+                await c.stop();
+                console.log(`Stopped ${c.name}`);
+            } else {
+                console.warn(`Container ${c.name} already stopped`);
+            }
+            return c;
+        }
+    ));
+
+    console.table(containers.map((c) => {
+        return {name: c.name, state: c.state}
+    }));
+
+}
+
+main().catch(console.error);

package/examples/config/index.ts

@@ -0,0 +1,18 @@
+import {Container} from "../../lib";
+
+const name = "test-ct"
+
+/**
+ * In this example, a container is created and the calling process stdio is attached.
+ */
+async function main() {
+
+    const c = new Container(name);
+    c.setConfigItem("lxc.utsname", "test-host1");
+
+    const rootfs  = c.getConfigItem("lxc.rootfs");
+    console.log("Root FS: ", rootfs);
+
+}
+
+main().catch(console.error);

package/examples/console/index.ts

@@ -0,0 +1,17 @@
+import {Container} from "../../lib";
+
+const name = "node-ct"
+
+/**
+ * In this example, a container is created and the calling process stdio is attached.
+ */
+async function main() {
+    const c = new Container(name);
+    if (c.defined && c.running) {
+        await c.console(0, [process.stdin.fd, process.stdout.fd, process.stderr.fd], 1);
+    } else {
+        console.warn(`Container '${name}' not defined or not running`);
+    }
+}
+
+main().catch(console.error);

package/examples/console_async/index.ts

@@ -0,0 +1,101 @@
+import {Container} from "../../lib";
+
+const containerName = 'node-ct'; // Change to your container name
+
+async function main() {
+    const container = new Container(containerName);
+    container.setConfigItem('lxc.log.file', `./${containerName}/container.log`)
+
+
+    if (!container.defined || !container.running) {
+        console.error(`Container '${containerName}' is not defined or not running.`);
+        process.exit(1);
+    }
+
+    console.log(`📎 Attaching to console of container '${containerName}' (TTY 0)`);
+    console.log(`💡 Type commands, press Ctrl+C or Ctrl+D to exit.\n`);
+
+    try {
+
+        // console.log(container.initPIDFd())
+
+        // Open console
+        const session = await container.consoleAsync(0);
+
+        // Ensure we're in raw mode
+        if (!process.stdin.isTTY) {
+            console.error('Stdin is not a TTY');
+            process.exit(1);
+        }
+
+        process.stdin.setRawMode(true);
+        process.stdin.setEncoding('utf8');
+
+        // Disable line buffering
+        process.stdin.resume();
+
+        // Handle data from container → stdout
+        session.on('data', (chunk) => {
+            process.stdout.write(chunk);
+        });
+
+        session.on('close', () => {
+            process.exit(0);
+        })
+
+        // Handle input from user → container
+        process.stdin.on('data', (data) => {
+            if (data.toString() === '\x04') {
+                // Ctrl+D
+                session.close();
+                process.exit(0);
+            } else {
+                session.write(data);
+            }
+
+        });
+
+        // Handle terminal resize
+        function handleResize() {
+            const cols = process.stdout.columns || 80;
+            const rows = process.stdout.rows || 24;
+            try {
+                session.resize(cols, rows);
+            } catch (e) {
+                // Ignore resize errors
+            }
+        }
+
+        // Initial resize
+        handleResize();
+
+        // Watch for resize events
+        process.stdout.on('resize', handleResize);
+
+        // Optional: send SIGWINCH on SIGHUP, SIGTERM
+        process.on('SIGINT', () => session.close());
+        process.on('SIGTERM', () => session.close());
+
+        // Cleanup on exit
+        const cleanup = () => {
+            session.close();
+            process.stdin.setRawMode(false);
+            process.exit(0);
+        };
+
+        process.on('exit', cleanup);
+        process.on('SIGINT', cleanup);
+        process.on('SIGTERM', cleanup);
+
+        console.log('✅ Connected. You can now type inside the container.\n');
+    } catch (err) {
+        // @ts-ignore
+        console.error('❌ Console error:', err?.message || err);
+        process.exit(1);
+    }
+}
+
+main().catch(err => {
+    console.error('❌ Unexpected error:', err);
+    process.exit(1);
+});

package/examples/create/index.ts

@@ -0,0 +1,12 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if (!c.defined) {
+        console.log("Container creating...")
+        await c.create({template: "download", argv: ["--dist", "ubuntu", "--release", "jammy", "--arch", "amd64"]});
+        console.log("Done")
+    }
+}
+
+main().catch(console.error)

package/examples/create_snapshot/index.ts

@@ -0,0 +1,10 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if (c.defined) {
+        await c.snapshot("./test") //TODO: Check if this works
+    }
+}
+
+main().catch(console.error)

package/examples/destroy/index.ts

@@ -0,0 +1,10 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if (c.defined && !c.running) {
+        await c.destroy();
+    }
+}
+
+main().catch(console.error)

package/examples/destroy_snapshots/index.ts

@@ -0,0 +1,10 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if (c.defined && !c.running) {
+        await c.snapshotDestroy(true);
+    }
+}
+
+main().catch(console.error)

package/examples/device_add_remove/index.ts

@@ -0,0 +1,11 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if (c.defined && c.running) {
+        await c.addDeviceNode("/dev/network_latency");
+        await c.removeDeviceNode("/dev/network_latency");
+    }
+}
+
+main().catch(console.error)

package/examples/execute/index.ts

@@ -0,0 +1,10 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if (c.defined && c.running) {
+        await c.exec({argv: ['uname', '-a']})
+    }
+}
+
+main().catch(console.error)

package/examples/freeze/index.ts

@@ -0,0 +1,11 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if (c.defined && c.running) {
+        await c.freeze();
+        console.log("Container frozen");
+    }
+}
+
+main().catch(console.error)

package/examples/images/index.ts

@@ -0,0 +1,10 @@
+import {Images} from "../../lib";
+
+async function main() {
+    const available = await Images.Available()
+    console.log(available)
+    const list = await Images.List()
+    console.log(list)
+}
+
+main().catch(console.error)

package/examples/interfaces/index.ts

@@ -0,0 +1,10 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if (c.defined) {
+        console.log(await c.getInterfaces());
+    }
+}
+
+main().catch(console.error)

package/examples/ipaddress/index.ts

@@ -0,0 +1,12 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if (c.defined) {
+        console.table(Promise.all((await c.getInterfaces()).map(async (inf) => {
+            return {interface: inf, ipv4: await c.getIPs(inf, "inet"), ipv6: await c.getIPs(inf, "inet6", 0)}
+        })));
+    }
+}
+
+main().catch(console.error)

package/examples/limit/index.ts

@@ -0,0 +1,15 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    const limitInBytes = Number(c.getCGroupItem("memory.limit_in_bytes"));
+    console.log(`current limitInBytes ${limitInBytes}`);
+    const swapMemoryLimitInBytes = Number(c.getCGroupItem("memory.memsw.limit_in_bytes"));
+    console.log(`current swapMemoryLimitInBytes ${swapMemoryLimitInBytes}`);
+
+    c.setCGroupItem("memory.limit_in_bytes", (limitInBytes/4).toString())
+    c.setCGroupItem("memory.memsw.limit_in_bytes", (swapMemoryLimitInBytes/4).toString())
+
+}
+
+main().catch(console.error)

package/examples/list/index.ts

@@ -0,0 +1,12 @@
+import {LXC} from "../../lib";
+
+async function main() {
+    console.log("===== ACTIVE =====");
+    LXC.ListAllActiveContainers().forEach(console.log)
+    console.log("===== DEFINED =====");
+    LXC.ListAllDefinedContainers().forEach(console.log)
+    console.log("===== ALL =====");
+    LXC.ListAllContainers().forEach(console.log)
+}
+
+main().catch(console.error)

package/examples/list_keys/index.ts

@@ -0,0 +1,10 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    c.getKeys().forEach((key) => {
+        console.log(key, "=", c.getConfigItem(key)?.trim())
+    })
+}
+
+main().catch(console.error)

package/examples/list_snapshots/index.ts

@@ -0,0 +1,9 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    const list = await c.snapshotList();
+    console.table(list);
+}
+
+main().catch(console.error)

package/examples/reboot/index.ts

@@ -0,0 +1,11 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if(!c.defined){
+        throw "Container not defined"
+    }
+    c.shutdown().then(()=> console.log("Container shutdown"))
+}
+
+main().catch(console.error)

package/examples/rename/index.ts

@@ -0,0 +1,11 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if(!c.defined){
+        throw "Container not defined"
+    }
+    c.name = "new-name";
+}
+
+main().catch(console.error)

package/examples/restore_snapshot/index.ts

@@ -0,0 +1,11 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if (!c.defined) {
+        throw "Container not defined"
+    }
+    await c.snapshotRestore("snap0", "node-ct-restored");
+}
+
+main().catch(console.error)

package/examples/shutdown/index.ts

@@ -0,0 +1,19 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if (!c.defined) {
+        throw "Container not defined"
+    }
+
+    console.log("Shutting down the container...\n")
+    await c.shutdown(30).then(
+        () =>
+            console.log("Container shutdown"),
+        (reason) => {
+            console.warn("Failed to shutdown container reason:", reason);
+            return c.stop();
+        })
+}
+
+main().catch(console.error)

package/examples/start/index.ts

@@ -0,0 +1,11 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if(!c.defined){
+        throw "Container not defined"
+    }
+    c.start().then(()=> console.log("Container started"))
+}
+
+main().catch(console.error)

package/examples/stats/index.ts

@@ -0,0 +1,48 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if (!c.defined) {
+        throw "Container not defined"
+    }
+    const memUsed = c.getCGroupItem("memory.usage_in_bytes");
+    console.log("MemoryUsage:", memUsed);
+
+    const memLimit = c.getConfigItem("memory.limit_in_bytes");
+    console.log("MemoryLimit:", memLimit);
+
+    const kmemUsed = c.getConfigItem("memory.kmem.usage_in_bytes");
+    console.log("KernelMemoryUsage:", kmemUsed);
+
+    const kmemLimit = c.getConfigItem("memory.kmem.limit_in_bytes");
+    console.log("KernelMemoryLimit:", kmemLimit);
+
+    const swapUsed = c.getConfigItem("memory.memsw.usage_in_bytes");
+    console.log("MemorySwapUsage:", swapUsed);
+
+    const swapLimit = c.getConfigItem("memory.memsw.limit_in_bytes");
+    console.log("MemorySwapLimit:", swapUsed);
+
+    const blkioUsage = c.getConfigItem("blkio.throttle.io_service_bytes"); //TODO: Go bindings more complex on nested items and io services
+    console.log("BlkioUsage:", blkioUsage);
+
+    const cpuTime = c.getConfigItem("cpuacct.usage");
+    console.log("cpuacct.usage:", cpuTime);
+
+    const cpuTimePerCPU = c.getConfigItem("cpuacct.usage_percpu");  //TODO: Go bindings more complex on nested cpuTimes
+    console.log("cpuacct.usage_percpu:", cpuTimePerCPU);
+
+
+    const cpuStats = c.getConfigItem("cpuacct.usage_percpu");  //TODO: CPUStats returns the number of CPU cycles (in the units defined by USER_HZ on the system)
+                                                                   //TODO: consumed by tasks in this cgroup and its children in both user mode and system (kernel) mode.
+    console.log("cpuacct.stat:", cpuStats);
+
+
+    const interfaceStats = c.getConfigItem("cpuacct.usage"); //TODO: InterfaceStats returns the stats about container's network interfaces
+                                                                 // @see https://github.com/lxc/go-lxc/blob/v2/container.go#L1707
+    console.log("InterfaceStats:", interfaceStats);
+
+
+}
+
+main().catch(console.error)

package/examples/stop/index.ts

@@ -0,0 +1,11 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if(!c.defined){
+        throw "Container not defined"
+    }
+    c.stop().then(()=> console.log("Container stopped"))
+}
+
+main().catch(console.error)

package/examples/unfreeze/index.ts

@@ -0,0 +1,11 @@
+import {Container} from "../../lib";
+
+async function main() {
+    const c = new Container("node-ct");
+    if (!c.defined) {
+        throw "Container not defined"
+    }
+    c.unfreeze().then(() => console.log("Container thawed"))
+}
+
+main().catch(console.error)

package/lib/binding.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+declare const _default: any;
+export default _default;

package/lib/binding.js

@@ -0,0 +1,32 @@
+"use strict";
+/**
+ * @author A.P.A. Slaa (a.p.a.slaa@projectsource.nl) ProjectSource V.O.F.
+ * @date 03-07-2024
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const platform = process.platform;
+const arch = process.arch;
+const base_name = "node-lxc";
+const is_package = __dirname.includes("node_modules");
+let addonPath;
+if (!is_package) {
+    const mode = process.env["NODE_ENV"] === "development" ? "Debug" : "Release";
+    if (mode === "Debug") {
+        console.warn("!!!RUNNING IN DEVELOPMENT MODE!!!");
+    }
+    addonPath = path_1.default.join(__dirname, '..', 'build', mode, `${base_name}.node`);
+}
+else {
+    if (platform === 'linux' && arch === 'x64') {
+        addonPath = path_1.default.join(__dirname, '..', 'bin', 'x86_64-linux-gnu', `${base_name}.node`);
+    }
+    else {
+        throw new Error(`Unsupported platform or architecture: ${platform}-${arch}`);
+    }
+}
+exports.default = require(addonPath);
+//# sourceMappingURL=binding.js.map

package/lib/binding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binding.js","sourceRoot":"","sources":["../../lib/binding.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AAEH,gDAAwB;AAExB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;AAClC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;AAE1B,MAAM,SAAS,GAAG,UAAU,CAAA;AAC5B,MAAM,UAAU,GAAG,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;AACtD,IAAI,SAAS,CAAC;AACd,IAAI,CAAC,UAAU,EAAE,CAAC;IACd,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7E,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACnB,OAAO,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;IACtD,CAAC;IACD,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAC,OAAO,EAAE,IAAI,EAAE,GAAG,SAAS,OAAO,CAAC,CAAC;AAC9E,CAAC;KAAM,CAAC;IACJ,IAAI,QAAQ,KAAK,OAAO,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;QACzC,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,kBAAkB,EAAE,GAAG,SAAS,OAAO,CAAC,CAAC;IAC3F,CAAC;SAAM,CAAC;QACJ,MAAM,IAAI,KAAK,CAAC,yCAAyC,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC;IACjF,CAAC;AACL,CAAC;AAGD,kBAAe,OAAO,CAAC,SAAS,CAAC,CAAA"}