Merge pull request #22 from FyraStack/vmagent/networking

VM Agents: Networking

Author: korewaChino

.github/workflows/build_x86.yml

@@ -11,32 +11,31 @@ env:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
-    - uses: rui314/setup-mold@v1
-    - name: Run sccache-cache
-      uses: mozilla-actions/sccache-action@v0.0.9
-    
-    - name: Build
-      run: cargo build --verbose --release
-    - name: Upload artifact - agent
-      uses: actions/upload-artifact@v7
-      with:
-        archive: false
-        name: odorobo-agent-x86
-        path: |
-          target/release/odorobo-agent
-          
-    - name: Upload artifact - odoroboctl
-      uses: actions/upload-artifact@v7
-      with:
-        archive: false
-        name: odoroboctl-x86
-        path: |
-          target/release/odoroboctl
-          
-    - name: Run tests
-      run: cargo test --verbose
+      - uses: actions/checkout@v4
+      - uses: rui314/setup-mold@v1
+      - name: Run sccache-cache
+        uses: mozilla-actions/sccache-action@v0.0.9
+
+      - name: Build
+        run: cargo build --verbose --release
+      - name: Upload artifact - agent
+        uses: actions/upload-artifact@v7
+        with:
+          archive: false
+          name: odorobo-agent-x86
+          path: |
+            target/release/odorobo-agent
+
+      - name: Upload artifact - odoroboctl
+        uses: actions/upload-artifact@v7
+        with:
+          archive: false
+          name: odoroboctl-x86
+          path: |
+            target/release/odoroboctl
+
+      - name: Run tests
+        run: cargo test --verbose

.github/workflows/clippy.yml

@@ -13,8 +13,7 @@ on:
   push:
   pull_request:
   schedule:
-    - cron: '39 6 * * 6'
-
+    - cron: "39 6 * * 6"
 
 env:
   CARGO_TERM_COLOR: always
@@ -41,18 +40,15 @@ jobs:
           components: clippy
           override: true
 
-  
       - uses: rui314/setup-mold@v1
       - name: Run sccache-cache
         uses: mozilla-actions/sccache-action@v0.0.9
 
-
       - name: Install required cargo
         run: cargo install clippy-sarif sarif-fmt
 
       - name: Run rust-clippy
-        run:
-          cargo clippy
+        run: cargo clippy
           --all-features
           --message-format=json | clippy-sarif | tee rust-clippy-results.sarif | sarif-fmt
         continue-on-error: true

Cargo.lock

@@ -32,6 +32,7 @@ odoroboctl = { path = "odoroboctl" }
 odorobo-manager = { path = "odorobo-manager" }
 dotenvy = "0.15"
 clap = { version = "4", features = ["derive", "env"] }
+ipnet = {version = "2.12.0", features = ["serde", "schemars08"]}
 # these are for performance optimizations, based on https://nnethercote.github.io/perf-book/build-configuration.html#optimization-level
 # these options can take a while to compile (up to 5-10 minutes), so its really only necessary for production binaries.
 # also look in .cargo/config.toml for info on microarchitecture optimizations.

Cargo.toml

@@ -28,6 +28,9 @@ Odorobo Agent is meant to be run as a system agent on each bare-metal node (or a
 Build the Agent binary with `cargo build --release` and run it on the host machine. The Agent will listen for commands from the Gateway to create, manage, and delete VMs.
 
 ```bash
+# Install dependencies (fedora)
+sudo dnf in -y clang-devel nftables
+
 # Build the Agent
 cargo build --release
 # Run the Agent (requires write permissions to /run/odorobo, and access to systemd's system session bus
@@ -62,14 +65,19 @@ Now apply the [Cloud Hypervisor VM spec](https://github.com/cloud-hypervisor/clo
 odoroboctl create my-vm --boot ./my-vm.json
 ```
 
-To connect directly on the host, look up the PTY path from the VM info:
+To connect directly on the host, connect to the VM's serial console socket in its runtime directory:
 
 ```bash
-odoroboctl info my-vm  # find config.serial.file, e.g. /dev/pts/3
-screen /dev/pts/3
+sudo socat -,rawer UNIX-CONNECT:/run/odorobo/vms/01KPBBXKK0R0M09VN7G6R6R3JF/console.sock
+```
+
+Replace the VM ID in the socket path with your VM's ID. The serial console socket is created at:
+
+```text
+/run/odorobo/vms/<vmid>/console.sock
 ```
 
-See [docs/console.md](docs/console.md) for WebSocket console usage and integration details.
+See [docs/console.md](docs/console.md) for direct serial socket access, WebSocket console usage, and integration details.
 
 For more advanced usage, Odorobo Agent also exposes a passthrough route for the local Cloud Hypervisor API, allowing you to call the full Cloud Hypervisor API directly through the agent's REST API