Supporting deployments on zos4 nodes

packages/grid_client/docs/deployment_flow.md

@@ -0,0 +1,117 @@
+# Deployment Flow
+
+This document outlines the process for determining whether to deploy on a zos3 or zos4 node.
+
+## Machine Model Initialization
+
+The deployment process begins with initializing the machine model as follows:
+
+```ts
+const vms: MachinesModel = {
+  name: "newMY",
+  network: {
+    name: "hellotest",
+    ip_range: "10.249.0.0/16",
+    myceliumSeeds: [
+      {
+        nodeId: 168,
+        seed: "050d109829d8492d48bfb33b711056080571c69e46bfde6b4294c4c5bf468a76", //(HexSeed of length 32)
+      },
+    ],
+  },
+  machines: [
+    {
+      name: "testvmMY",
+      node_id: 168,
+      disks: [
+        {
+          name: "wedDisk",
+          size: 8,
+          mountpoint: "/testdisk",
+        },
+      ],
+      public_ip: false,
+      public_ip6: false,
+      planetary: true,
+      mycelium: true,
+      myceliumSeed: "1e1404279b3d", //(HexSeed of length 6)
+      cpu: 1,
+      memory: 1024 * 2,
+      rootfs_size: 0,
+      flist: "https://hub.grid.tf/tf-official-apps/base:latest.flist",
+      entrypoint: "/sbin/zinit init",
+      env: {
+        SSH_KEY: config.ssh_key,
+      },
+    },
+  ],
+  metadata: "",
+  description: "test deploying single VM with mycelium via ts grid3 client",
+};
+```
+
+## Deployment Execution
+
+- The next step is invoking the `deploy` function:
+  - Takes the `MachinesModel` object as a parameter
+  - Checks if a machine with the same name already exists and if so throws an error
+  - If not it calls the `_createDeployment` function along some othe functions
+  - Finally it returns the created contracts and the wiregaurd configuration
+
+```ts
+await client.machines.deploy(vms);
+```
+
+- The `_createDeployment` function:
+  - Takes the `MachinesModel` object as a parameter
+  - Retrieves the features of the node using: `await this.rmb.request([nodeTwinId], "zos.system.node_features_get", "", 20, 3);`
+  - Examines the retrieved features to determine the network's primitive type (`Network` or `ZNetworkLight`) and initializes it accordingly.
+  - Sets the contractMetadata based on the network type.
+  - Invokes the `create` function
+
+```ts
+await this._createDeployment(options);
+```
+
+- The `create` function
+  - Validates or assigns IP addresses based on the network type.
+  - Determines network type (`network` or `network-light`) based on node features.
+  - Adds access points and updates network configurations as necessary.
+  - Initialize the VM primitive (`VMPrimitive` or `VMLightPrimitive`) based on the network type
+  - Configures the VM with networking, storage, and environment variables.
+  - Generates a Mycelium seed if not provided.
+  - Generate the deployments
+  - Returns the deployments and wiregaurd configurations
+
+```ts
+await this.vm.create(
+  machine.name,
+  machine.node_id,
+  machine.flist,
+  machine.cpu,
+  machine.memory,
+  machine.rootfs_size,
+  machine.disks!,
+  machine.public_ip,
+  machine.public_ip6!,
+  machine.planetary,
+  machine.mycelium,
+  machine.myceliumSeed!,
+  network,
+  options.network.myceliumSeeds!,
+  machine.entrypoint,
+  machine.env,
+  contractMetadata,
+  options.metadata,
+  options.description,
+  machine.qsfs_disks,
+  this.config.projectName,
+  options.network.addAccess,
+  options.network.accessNodeId,
+  machine.ip,
+  machine.corex,
+  machine.solutionProviderId!,
+  machine.zlogsOutput,
+  machine.gpus,
+);
+```

packages/grid_client/scripts/applications/casperlabs.ts

@@ -33,7 +33,7 @@
   log("================= Getting deployment information =================");
 }
 
 async function cancel(client, vms, gw) {
   const resultVM = await client.machines.delete(vms);
   const resultGateway = await client.gateway.delete_name(gw);
   log("================= Canceling the deployment =================");
@@ -55,6 +55,7 @@
     sru: instanceCapacity.sru,
     availableFor: grid3.twinId,
     farmId: 1,
+    features: ["wiregaurd"],
   };
   //GatewayNode Selection
   const gatewayQueryOptions: FilterOptions = {

packages/grid_client/scripts/applications/discourse.ts

@@ -36,7 +36,7 @@
   log("================= Getting deployment information =================");
 }
 
 async function cancel(client, vms, gw) {
   const resultVM = await client.machines.delete(vms);
   const resultGateway = await client.gateway.delete_name(gw);
   log("================= Canceling the deployment =================");
@@ -63,6 +63,7 @@
     sru: instanceCapacity.sru,
     availableFor: grid3.twinId,
     farmId: 1,
+    features: ["ipv4", "wiregaurd"],
   };
   //GatewayNode Selection
   const gatewayQueryOptions: FilterOptions = {

packages/grid_client/scripts/applications/funkwhale.ts

@@ -33,7 +33,7 @@
   log("================= Getting deployment information =================");
 }
 
 async function cancel(client, vms, gw) {
   const resultVM = await client.machines.delete(vms);
   const resultGateway = await client.gateway.delete_name(gw);
   log("================= Canceling the deployment =================");
@@ -55,6 +55,7 @@
     sru: instanceCapacity.sru,
     availableFor: grid3.twinId,
     farmId: 1,
+    features: ["wiregaurd"],
   };
   //GatewayNode Selection
   const gatewayQueryOptions: FilterOptions = {

packages/grid_client/scripts/applications/mattermost.ts

@@ -33,7 +33,7 @@
   log("================= Getting deployment information =================");
 }
 
 async function cancel(client, vms, gw) {
   const resultVM = await client.machines.delete(vms);
   const resultGateway = await client.gateway.delete_name(gw);
   log("================= Canceling the deployment =================");
@@ -47,6 +47,8 @@
   const grid3 = await getClient(`mattermost/${name}`);
   const subdomain = "mm" + grid3.twinId + name;
   const instanceCapacity = { cru: 1, mru: 2, sru: 15 }; // Update the instance capacity values according to your requirements.
+  // Change to true if smtp is configured
+  const smtp = false;
 
   //VMNode Selection
   const vmQueryOptions: FilterOptions = {
@@ -55,6 +57,7 @@
     sru: instanceCapacity.sru,
     availableFor: grid3.twinId,
     farmId: 1,
+    features: smtp ? ["ipv4", "wiregaurd"] : [],
   };
   //GatewayNode Selection
   const gatewayQueryOptions: FilterOptions = {

packages/grid_client/scripts/applications/nextcloud.ts

@@ -33,7 +33,7 @@
   log("================= Getting deployment information =================");
 }
 
 async function cancel(client, vms, gw) {
   const resultVM = await client.machines.delete(vms);
   const resultGateway = await client.gateway.delete_name(gw);
   log("================= Canceling the deployment =================");
@@ -55,6 +55,7 @@
     sru: instanceCapacity.sru,
     availableFor: grid3.twinId,
     farmId: 1,
+    features: ["wiregaurd"],
   };
   //GatewayNode Selection
   const gatewayQueryOptions: FilterOptions = {

packages/grid_client/scripts/applications/nodepilot.ts

@@ -35,6 +35,7 @@ async function main() {
     sru: instanceCapacity.sru,
     availableFor: grid3.twinId,
     farmId: 1,
+    features: ["ipv4", "wiregaurd", "ip"],
   };
   const nodes = await grid3.capacity.filterNodes(vmQueryOptions);
   const vmNode = await pingNodes(grid3, nodes);

packages/grid_client/scripts/applications/peertube.ts

@@ -55,6 +55,7 @@ async function main() {
     sru: instanceCapacity.sru,
     availableFor: grid3.twinId,
     farmId: 1,
+    features: ["wiregaurd"],
   };
   //GatewayNode Selection
   const gatewayQueryOptions: FilterOptions = {

packages/grid_client/scripts/applications/static_website.ts

@@ -55,6 +55,7 @@ async function main() {
     sru: instanceCapacity.sru,
     availableFor: grid3.twinId,
     farmId: 1,
+    features: ["wiregaurd"],
   };
   //GatewayNode Selection
   const gatewayQueryOptions: FilterOptions = {

packages/grid_client/scripts/applications/subsquid.ts

@@ -55,6 +55,7 @@ async function main() {
     sru: instanceCapacity.sru,
     availableFor: grid3.twinId,
     farmId: 1,
+    features: ["wiregaurd"],
   };
   //GatewayNode Selection
   const gatewayQueryOptions: FilterOptions = {

packages/grid_client/scripts/applications/taiga.ts

@@ -55,6 +55,7 @@ async function main() {
     sru: instanceCapacity.sru,
     availableFor: grid3.twinId,
     farmId: 1,
+    features: ["wiregaurd"],
   };
   //GatewayNode Selection
   const gatewayQueryOptions: FilterOptions = {

packages/grid_client/scripts/applications/wordpress.ts

@@ -56,6 +56,7 @@ async function main() {
     sru: instanceCapacity.sru,
     availableFor: grid3.twinId,
     farmId: 1,
+    features: ["wiregaurd"],
   };
   //GatewayNode Selection
   const gatewayQueryOptions: FilterOptions = {

packages/grid_client/scripts/orchestrators/caprover_leader.ts

@@ -34,6 +34,7 @@ async function main() {
     sru: 10,
     farmId: 1,
     availableFor: grid3.twinId,
+    features: ["ipv4", "wireguard"],
   };
 
   const vms: MachinesModel = {

packages/grid_client/scripts/orchestrators/caprover_worker.ts

@@ -32,6 +32,7 @@ async function main() {
     mru: 4, // GB
     sru: 10,
     farmId: 1,
+    features: ["ipv4", "wireguard"],
   };
 
   const vms: MachinesModel = {

packages/grid_client/scripts/orchestrators/kubernetes_leader.ts

@@ -33,6 +33,7 @@ async function main() {
     sru: 6,
     availableFor: grid3.twinId,
     farmId: 1,
+    features: ["wireguard"],
   };
 
   const workerQueryOptions: FilterOptions = {

packages/grid_client/scripts/orchestrators/kubernetes_with_qsfs.ts

@@ -50,6 +50,7 @@ async function main() {
     sru: 6,
     availableFor: grid3.twinId,
     farmId: 1,
+    features: ["wireguard"],
   };
 
   const qsfsQueryOptions: FilterOptions = {

packages/grid_client/scripts/orchestrators/kubernetes_worker.ts

@@ -34,6 +34,7 @@ async function main() {
     mru: 1, // GB
     sru: 10,
     farmId: 1,
+    features: ["wireguard"],
   };
 
   const worker: AddWorkerModel = {

packages/grid_client/scripts/single_vm_zos4.ts

@@ -0,0 +1,115 @@
+import { FilterOptions, generateRandomHexSeed, GridClient, MachinesDeleteModel, MachinesModel } from "../src";
+import { config, getClient } from "./client_loader";
+import { log, pingNodes } from "./utils";
+
+async function deploy(client, vms) {
+  const resultVM = await client.machines.deploy(vms);
+  log("================= Deploying VM =================");
+  log(resultVM);
+  log("================= Deploying VM =================");
+}
+
+async function getDeployment(client, vms) {
+  const resultVM = await client.machines.getObj(vms.name);
+  log("================= Getting deployment information =================");
+  log(resultVM);
+  log("================= Getting deployment information =================");
+}
+
+async function cancel(client, vms) {
+  const resultVM = await client.machines.delete(vms);
+  log("================= Canceling the deployment =================");
+  log(resultVM);
+  log("================= Canceling the deployment =================");
+}
+
+async function main() {
+  const name = "newalgorand";
+  const grid3 = await getClient(`algorand/${name}`);
+  const instanceCapacity = { cru: 2, mru: 4, sru: 100 }; // Update the instance capacity values according to your requirements.
+
+  //VMNode Selection
+  const vmQueryOptions: FilterOptions = {
+    cru: instanceCapacity.cru,
+    mru: instanceCapacity.mru,
+    sru: instanceCapacity.sru,
+    availableFor: grid3.twinId,
+    farmId: 1,
+    features: ["zmachine-light"],
+  };
+  const nodes = await grid3.capacity.filterNodes(vmQueryOptions);
+  const vmNode = await pingNodes(grid3, nodes);
+
+  const vms: MachinesModel = {
+    name,
+    network: {
+      name: "vmNode",
+      ip_range: "10.249.0.0/16",
+      myceliumSeeds: [
+        {
+          nodeId: vmNode,
+          /**
+           * ### Mycelium Network Seed:
+           * - The `seed` is an optional field used to provide a specific seed for the Mycelium network.
+           * - If not provided, the `GridClient` will generate a seed automatically when the `mycelium` flag is enabled.
+           * - **Use Case:** If you need the new machine to have the same IP address as a previously deleted machine, set the `seed` field to the old seed value.
+           */
+          seed: generateRandomHexSeed(32),
+        },
+      ],
+    },
+    machines: [
+      {
+        name: "testvmMY",
+        node_id: vmNode,
+        disks: [
+          {
+            name: "wedDisk",
+            size: instanceCapacity.sru,
+            mountpoint: "/testdisk",
+          },
+        ],
+        planetary: false,
+        public_ip: false,
+        public_ip6: false,
+        /**
+         * ### Mycelium Flag Behavior:
+         * - When the `mycelium` flag is enabled, there’s no need to manually provide the `myceliumSeed` flag.
+         * - The `GridClient` will automatically generate the necessary seed for you.
+         * - **However**, if you have **an existing seed** from a previously deleted machine and wish to deploy a new machine that retains the same IP address,
+         * - **you can simply pass in the old seed during deployment instead of calling the `generateRandomHexSeed()` function**.
+         */
+        mycelium: true,
+        /**
+         * ### Mycelium Seed:
+         * - The `myceliumSeed` is an optional field used to provide a specific seed for the Mycelium network.
+         * - If not provided, the `GridClient` will generate a seed automatically when the `mycelium` flag is enabled.
+         * - **Use Case:** If you need the new machine to have the same IP address as a previously deleted machine, set the `seed` field to the old seed value.         */
+        myceliumSeed: generateRandomHexSeed(6), // (HexSeed of length 6)
+        cpu: instanceCapacity.cru,
+        memory: 1024 * instanceCapacity.mru,
+        rootfs_size: 0,
+        flist: "https://hub.grid.tf/tf-official-apps/base:latest.flist",
+        entrypoint: "/sbin/zinit init",
+        env: {
+          SSH_KEY: config.ssh_key,
+        },
+      },
+    ],
+    metadata: "",
+    description: "test deploying single ZOS4 VM with mycelium via ts grid3 client",
+  };
+
+  //Deploy VMs
+  await deploy(grid3, vms);
+
+  //Get the deployment
+  await getDeployment(grid3, vms);
+
+  //Uncomment the line below to cancel the deployment
+  // await cancel(grid3, { name });
+
+  await grid3.disconnect();
+}
+
+main();