Support mycelium on grid client deployments

packages/grid_client/scripts/add_node_to_network.ts

@@ -15,6 +15,7 @@ async function main() {
     name: "wedtest",
     ipRange: "10.249.0.0/16",
     nodeId: 14,
+    mycelium: false,
   };
   // if the network is not created, it will create one and add this node to it.
   await addNode(grid3, node);

packages/grid_client/scripts/add_worker.ts

@@ -46,6 +46,7 @@ async function main() {
     public_ip: false,
     public_ip6: false,
     planetary: true,
+    mycelium: true,
   };
 
   //Add Worker

packages/grid_client/scripts/caprover_leader.ts

@@ -54,6 +54,7 @@ async function main() {
         public_ip: true,
         public_ip6: false,
         planetary: false,
+        mycelium: false,
         cpu: 4,
         memory: 1024 * 4,
         rootfs_size: 0,

packages/grid_client/scripts/caprover_worker.ts

@@ -53,6 +53,7 @@ async function main() {
         public_ip: true,
         public_ip6: false,
         planetary: false,
+        mycelium: false,
         cpu: 4,
         memory: 1024 * 4,
         rootfs_size: 0,

packages/grid_client/scripts/dynamic_single_vm.ts

@@ -54,6 +54,7 @@ async function main() {
         public_ip: false,
         public_ip6: false,
         planetary: true,
+        mycelium: false,
         cpu: 1,
         memory: 1024,
         rootfs_size: 0,

packages/grid_client/scripts/kubernetes.ts

@@ -61,6 +61,7 @@ async function main() {
         public_ip: false,
         public_ip6: false,
         planetary: true,
+        mycelium: true,
       },
     ],
     workers: [
@@ -74,6 +75,7 @@ async function main() {
         public_ip: false,
         public_ip6: false,
         planetary: true,
+        mycelium: true,
       },
     ],
     metadata: "",

packages/grid_client/scripts/kubernetes_with_qsfs.ts

@@ -102,6 +102,7 @@ async function main() {
         public_ip: false,
         public_ip6: false,
         planetary: true,
+        mycelium: false,
         qsfs_disks: [
           {
             qsfs_zdbs_name: qsfs_name,
@@ -127,6 +128,7 @@ async function main() {
         public_ip: false,
         public_ip6: false,
         planetary: true,
+        mycelium: false,
       },
     ],
     metadata: "",

packages/grid_client/scripts/mass_deployments.ts

@@ -119,6 +119,7 @@ async function main() {
       vm.disks = [];
       vm.public_ip = publicIp;
       vm.planetary = true;
+      vm.mycelium = false;
       vm.cpu = cru;
       vm.memory = mru;
       vm.rootfs_size = rootFs;

packages/grid_client/scripts/multiple_vms.ts

@@ -54,6 +54,7 @@ async function main() {
         public_ip: false,
         public_ip6: false,
         planetary: true,
+        mycelium: false,
         cpu: 1,
         memory: 1024,
         rootfs_size: 0,

packages/grid_client/scripts/single_vm.ts

@@ -35,7 +35,7 @@ async function main() {
     machines: [
       {
         name: "testvm",
-        node_id: 17,
+        node_id: 11,
         disks: [
           {
             name: "wedDisk",
@@ -46,6 +46,7 @@ async function main() {
         public_ip: false,
         public_ip6: false,
         planetary: true,
+        mycelium: true,
         cpu: 1,
         memory: 1024 * 2,
         rootfs_size: 0,

packages/grid_client/scripts/vm_with_gpu.ts

@@ -67,6 +67,7 @@ async function main() {
         public_ip: false,
         public_ip6: false,
         planetary: true,
+        mycelium: false,
         cpu: 8,
         memory: 1024 * 16,
         rootfs_size: 0,

packages/grid_client/scripts/vm_with_qsfs.ts

@@ -110,6 +110,7 @@ async function main() {
         public_ip: false,
         public_ip6: false,
         planetary: true,
+        mycelium: false,
         cpu: 1,
         memory: 1024,
         rootfs_size: 0,

packages/grid_client/scripts/wireguard_vm.ts

@@ -16,6 +16,7 @@ function createMachineModel(node: number) {
     node_id: node,
     public_ip: false,
     planetary: true,
+    mycelium: false,
     cpu: 1,
     memory: 1024 * 2,
     rootfs_size: 0,

packages/grid_client/src/helpers/validator.ts

@@ -1,6 +1,7 @@
 import { ValidationError } from "@threefold/types";
 import { plainToInstance } from "class-transformer";
 import { validate } from "class-validator";
+import * as crypto from "crypto";
 
 async function validateObject(obj) {
   const errors = await validate(obj);
@@ -23,4 +24,24 @@ function validateInput(target, propertyKey: string, descriptor: PropertyDescript
   };
 }
 
-export { validateObject, validateInput };
+function generateRandomHexSeed(length: number, numbers: number[]) {
+  // If no given numbers, generate all random
+  if (numbers.length == 0) {
+    const bytes = crypto.randomBytes(length);
+    return bytes.toString("hex");
+  }
+
+  const hexSeed = numbers[0].toString(16).padStart(length, "0") + numbers[1].toString(16).padStart(length, "0");
+
+  return hexSeed;
+}
+
+function validateHexSeed(seed: string, length: number): boolean {
+  const hexSeedRegex = new RegExp(`^[0-9A-Fa-f]{${length}}$`);
+  if (!hexSeedRegex.test(seed)) {
+    throw new ValidationError(`Invalid seed. It should be a ${length}-character hexadecimal string.`);
+  }
+  return true;
+}
+
+export { validateObject, validateInput, generateRandomHexSeed, validateHexSeed };

packages/grid_client/src/high_level/kubernetes.ts

@@ -20,7 +20,10 @@ class KubernetesHL extends HighLevelBase {
     publicIp: boolean,
     publicIp6: boolean,
     planetary: boolean,
+    mycelium: boolean,
+    myceliumSeed: string,
     network: Network,
+    networkSeed: string,
     sshKey: string,
     metadata = "",
     description = "",
@@ -61,7 +64,10 @@ class KubernetesHL extends HighLevelBase {
       publicIp,
       publicIp6,
       planetary,
+      mycelium,
+      myceliumSeed!,
       network,
+      networkSeed!,
       "/sbin/zinit init",
       env,
       metadata,
@@ -90,7 +96,10 @@ class KubernetesHL extends HighLevelBase {
     publicIp: boolean,
     publicIp6: boolean,
     planetary: boolean,
+    mycelium: boolean,
+    myceliumSeed: string,
     network: Network,
+    networkSeed: string,
     sshKey: string,
     metadata = "",
     description = "",
@@ -131,7 +140,10 @@ class KubernetesHL extends HighLevelBase {
       publicIp,
       publicIp6,
       planetary,
+      mycelium,
+      myceliumSeed,
       network,
+      networkSeed,
       "/sbin/zinit init",
       env,
       metadata,

packages/grid_client/src/high_level/machine.ts

@@ -3,6 +3,7 @@ import { Addr } from "netaddr";
 
 import { events } from "../helpers/events";
 import { randomChoice } from "../helpers/utils";
+import { generateRandomHexSeed, validateHexSeed } from "../helpers/validator";
 import { DiskModel, QSFSDiskModel } from "../modules/models";
 import { qsfs_zdbs } from "../modules/qsfs_zdbs";
 import {
@@ -33,7 +34,10 @@ class VMHL extends HighLevelBase {
     publicIp: boolean,
     publicIp6: boolean,
     planetary: boolean,
+    mycelium: boolean,
+    myceliumSeed: string,
     network: Network,
+    networkSeed: string,
     entrypoint: string,
     env: Record<string, unknown>,
     metadata = "",
@@ -212,10 +216,32 @@ class VMHL extends HighLevelBase {
 
         access_node_id = accessNodeId;
       }
-      access_net_workload = await network.addNode(access_node_id, networkMetadata, description, accessNodeSubnet);
+      access_net_workload = await network.addNode(
+        access_node_id,
+        mycelium,
+        networkMetadata,
+        description,
+        accessNodeSubnet,
+        networkSeed,
+      );
       wgConfig = await network.addAccess(access_node_id, true);
     }
-    const znet_workload = await network.addNode(nodeId, networkMetadata, description, userIPsubnet);
+    // If node exits on network check if mycelium needs to be added or not
+    if (network.nodeExists(nodeId)) {
+      const deployment = await network.checkMycelium(nodeId, mycelium, networkSeed);
+      if (deployment) {
+        deployments.push(new TwinDeployment(deployment, Operations.update, 0, 0, network));
+      }
+    }
+
+    const znet_workload = await network.addNode(
+      nodeId,
+      mycelium,
+      networkMetadata,
+      description,
+      userIPsubnet,
+      networkSeed,
+    );
     if ((await network.exists()) && (znet_workload || access_net_workload)) {
       // update network
       for (const deployment of network.deployments) {
@@ -263,6 +289,22 @@ class VMHL extends HighLevelBase {
     } else {
       machine_ip = network.getFreeIP(nodeId);
     }
+
+    // Split machine_ip to get last 2 numbers to be used in mycelium hex seed
+    const parts = machine_ip.split("/");
+    const ipPart = parts[0];
+    const ipNumbers = ipPart.split(".").map(part => parseInt(part, 10));
+    const lastTwoNumbers = ipNumbers.slice(-2);
+
+    // Validate mycelium seed If provided, if not generate it.
+    if (mycelium) {
+      if (myceliumSeed) {
+        validateHexSeed(myceliumSeed, 6);
+      } else {
+        myceliumSeed = generateRandomHexSeed(6, lastTwoNumbers);
+      }
+    }
+
     events.emit("logs", `Creating a vm on node: ${nodeId}, network: ${network.name} with private ip: ${machine_ip}`);
     workloads.push(
       vm.create(
@@ -275,6 +317,8 @@ class VMHL extends HighLevelBase {
         network.name,
         machine_ip,
         planetary,
+        mycelium,
+        myceliumSeed,
         ipName,
         entrypoint,
         env,

packages/grid_client/src/high_level/network.ts

@@ -7,7 +7,16 @@ import { HighLevelBase } from "./base";
 import { Operations, TwinDeployment } from "./models";
 
 class NetworkHL extends HighLevelBase {
-  async addNode(networkName: string, ipRange: string, nodeId: number, solutionProviderId: number, description = "") {
+  async addNode(
+    networkName: string,
+    ipRange: string,
+    nodeId: number,
+    solutionProviderId: number,
+    mycelium: boolean,
+    description = "",
+    subnet = "",
+    networkSeed = "",
+  ) {
     const network = new Network(networkName, ipRange, this.config);
     await network.load();
     const networkMetadata = JSON.stringify({
@@ -16,7 +25,7 @@ class NetworkHL extends HighLevelBase {
       projectName: this.config.projectName,
     });
 
-    const workload = await network.addNode(nodeId, networkMetadata, description);
+    const workload = await network.addNode(nodeId, mycelium, networkMetadata, description, subnet, networkSeed);
     if (!workload) {
       throw new ValidationError(`Node ${nodeId} already exists on network ${networkName}.`);
     }

packages/grid_client/src/modules/base.ts

@@ -230,7 +230,9 @@ class BaseModule {
       message: workload.result.message,
       flist: data.flist,
       publicIP: await this._getMachinePubIP(deploymentName, deployments, data.network.public_ip),
-      planetary: data.network.planetary ? (workload.result.data as ZmachineResult).ygg_ip : "",
+      planetary: data.network.planetary
+        ? (workload.result.data as ZmachineResult).ygg_ip || (workload.result.data as ZmachineResult).planetary_ip
+        : "",
       interfaces: data.network.interfaces.map(n => ({
         network: n.network,
         ip: n.ip,

packages/grid_client/src/modules/k8s.ts

@@ -104,7 +104,10 @@ class K8sModule extends BaseModule {
         master.public_ip,
         master.public_ip6,
         master.planetary,
+        master.mycelium,
+        master.myceliumSeed!,
         network,
+        options.network.network_seed!,
         options.ssh_key,
         options.metadata || metadata,
         options.description,
@@ -148,7 +151,10 @@ class K8sModule extends BaseModule {
         worker.public_ip,
         worker.public_ip6,
         worker.planetary,
+        worker.mycelium,
+        worker.myceliumSeed!,
         network,
+        options.network.network_seed!,
         options.ssh_key,
         options.metadata || metadata,
         options.description,
@@ -286,7 +292,10 @@ class K8sModule extends BaseModule {
       options.public_ip,
       options.public_ip6,
       options.planetary,
+      options.mycelium,
+      options.myceliumSeed!,
       network,
+      options.mycelium_network_seed!,
       masterWorkload.data["env"]["SSH_KEY"],
       masterWorkload.metadata,
       masterWorkload.description,

packages/grid_client/src/modules/machines.ts

@@ -59,7 +59,10 @@ class MachinesModule extends BaseModule {
         machine.public_ip,
         machine.public_ip6!,
         machine.planetary,
+        machine.mycelium,
+        machine.myceliumSeed!,
         network,
+        options.network.network_seed!,
         machine.entrypoint,
         machine.env,
         options.metadata || metadata,
@@ -104,6 +107,7 @@ class MachinesModule extends BaseModule {
   async getObj(deploymentName: string) {
     const deployments = await this._get(deploymentName);
     const workloads = await this._getWorkloadsByTypes(deploymentName, deployments, [WorkloadTypes.zmachine]);
+    console.log("Deployments: ", workloads);
     const promises = workloads.map(
       async workload => await this._getZmachineData(deploymentName, deployments, workload),
     );
@@ -177,7 +181,10 @@ class MachinesModule extends BaseModule {
       options.public_ip,
       options.public_ip6!,
       options.planetary,
+      options.mycelium,
+      options.myceliumSeed!,
       network,
+      options.mycelium_network_seed!,
       options.entrypoint,
       options.env,
       workload.metadata,