Merge pull request #3112 from CumulusNetworks/air-testing

Add breakout ports, outbound links, DHCP disable, and cloud-init docs

Author: rachel-netq

content/nvidia-air-v2/Cloud-Init.md

@@ -0,0 +1,61 @@
+---
+title: Cloud-Init
+author: NVIDIA
+weight: 50
+product: NVIDIA Air 2.0
+---
+
+## Overview
+
+Cloud-init is an industry-standard tool for automating the initial configuration of virtual machines on first boot. NVIDIA Air supports cloud-init through the {{<exlink url="https://cloudinit.readthedocs.io/en/latest/reference/datasources/nocloud.html" text="NoCloud datasource">}}, which allows you to inject user-data and meta-data into your simulation nodes.
+
+With cloud-init, you can automate tasks such as:
+- Setting hostnames
+- Installing packages
+- Writing configuration files
+- Running custom scripts on first boot
+
+## Supported Images
+
+Cloud-init works on any image that includes cloud-init with NoCloud datasource support, including custom images. The Air-provided `generic/ubuntu` images include cloud-init out of the box.
+
+## Configuration
+
+Cloud-init configuration consists of two components:
+
+- **User-data**: Defines the actions to perform on first boot, such as installing packages, running commands, or writing files. Supports all standard {{<exlink url="https://cloudinit.readthedocs.io/en/latest/explanation/format.html" text="cloud-init user-data formats">}}.
+- **Meta-data**: Provides instance metadata such as the hostname. Uses a simple `key: value` format.
+
+### Workflow
+
+Cloud-init is configured through the API. The general workflow is:
+
+1. Create a simulation with your desired topology, but do not start it yet.
+2. Create **UserConfig** resources containing your user-data and meta-data content. UserConfigs are reusable — for example, you can create one user-data config and share it across multiple nodes, while giving each node its own meta-data with a unique hostname.
+3. Assign the UserConfig resources to simulation nodes using the {{<exlink url="https://air-ngc.nvidia.com/api/docs/#tag/nodes/PATCH/api/v3/simulations/nodes/bulk-assign" text="bulk-assign endpoint">}}. This endpoint lets you assign both user-data and meta-data to multiple nodes in a single request.
+4. Start the simulation. Cloud-init runs automatically on each node during its first boot.
+
+{{%notice note%}}
+Cloud-init runs during the initial boot of each node. Configure cloud-init assignments before starting the simulation for the first time. Assignments made after a node has already booted do not take effect until the node is rebuilt.
+{{%/notice%}}
+
+### Example
+
+The following `cloud-config` user-data installs packages and writes a configuration file on first boot:
+
+```yaml
+#cloud-config
+
+packages:
+- curl
+- jq
+
+write_files:
+- path: /etc/myapp/config.yaml
+  content: |
+    server:
+      listen: 0.0.0.0:8080
+      log_level: info
+```
+
+For information and additional examples of user-data and meta-data formats, refer to the {{<exlink url="https://cloudinit.readthedocs.io/en/latest/explanation/format.html" text="cloud-init documentation">}}.

content/nvidia-air-v2/Custom-Topology.md

@@ -85,7 +85,44 @@ Air also provides advanced options, such as enabling UEFI secure boot.
 {{<img src="/images/guides/nvidia-air-v2/AddNode.png" alt="">}}
 <br>
 <br>
-After you create your topology, start the simulation. You cannot add, remove, or edit nodes after the simulation starts for the first time
+After you create your topology, start the simulation. You cannot add, remove, or edit nodes after the simulation starts for the first time.
+
+### Breakout Ports
+
+For switch nodes, you can break out a port into multiple sub-ports to simulate multi-lane configurations. For example, breaking out `swp1` into four sub-ports creates `swp1s0`, `swp1s1`, `swp1s2`, and `swp1s3`.
+
+To break out a port:
+
+1. Select a switch node to open its properties panel.
+2. In the **Connectors** section, click **Breakout Port**.
+3. Select the ports you want to break out.
+4. Choose the split type (number of sub-ports) and click **Confirm**.
+
+{{<img src="/images/guides/nvidia-air-v2/BreakoutPorts.png" alt="Breakout Port dialog showing port selection and split type">}}
+
+The available split options depend on the switch model. To revert a breakout, select **Delete Breakout** in the Breakout Port dialog.
+
+{{%notice note%}}
+Breakout ports can only be configured before the simulation starts for the first time. Only data plane interfaces on switch nodes support breakout — management and OOB interfaces do not.
+{{%/notice%}}
+
+### Outbound Links
+
+Outbound links connect a node's interface directly to external networks, giving that interface internet access independently of the OOB management network. This is useful when you need a node to have a public-facing interface — for example, to simulate an edge router or a firewall with an external uplink.
+
+To configure an outbound link:
+
+1. Select a node to open its properties panel.
+2. In the **Connectors** section, click the port you want to connect externally.
+3. In the Connect dialog, toggle **Outbound link** on.
+
+{{<img src="/images/guides/nvidia-air-v2/OutboundLink.png" alt="Connect dialog showing outbound link toggle">}}
+
+Outbound interfaces appear in the **Services** tab, where you can create services (such as SSH or HTTP) that terminate on the outbound interface.
+
+{{%notice note%}}
+An outbound interface connects directly to the external network. It cannot also be connected to another node's interface.
+{{%/notice%}}
 
 ### OOB Management Network
 
@@ -483,7 +520,7 @@ The following topology defines two nodes (`node-1` and `node-2`) connected to ea
 
 The following topology defines two nodes (`node-1` and `node-2`) connected to each other through `eth1` interfaces. The out-of-band management network is disabled (`"oob": false`). The example includes:
 - Custom values for configurable node fields (`cpu`, `memory`, `storage`)
-- A public-facing interface (with a custom `mac` address) to the outside world (`eth2` of `node-1`)
+- An outbound link (`eth2` of `node-1`) that connects directly to external networks. In the links array, use the string `"outbound"` as the second element instead of a node reference.
 - A reference to the `os` image by specific UUID (`node-2`)
 
 ```
@@ -503,11 +540,15 @@ The following topology defines two nodes (`node-1` and `node-2`) connected to ea
     },
     "links": [
         [{"node": "node-1", "interface": "eth1"}, {"node": "node-2", "interface": "eth1"}],
-        [{"node": "node-1", "interface": "eth2", "mac": "02:00:00:00:00:07"}, "exit"]
+        [{"node": "node-1", "interface": "eth2", "mac": "02:00:00:00:00:07"}, "outbound"]
     ]
 }
 ```
 
+{{%notice note%}}
+The string `"exit"` is also accepted as an alias for `"outbound"` in the links array.
+{{%/notice%}}
+
 {{< /tab >}}
 {{< /tabs >}}
 

content/nvidia-air-v2/OOB-Management-Network.md

@@ -2,7 +2,7 @@
 title: OOB Management Network
 author: NVIDIA
 weight: 45
-product: NVIDIA Air
+product: NVIDIA Air 2.0
 ---
 
 ## Overview
@@ -119,6 +119,29 @@ When you enable the OOB network, Air automatically configures:
 - **DHCP relay** on leaf switches to forward DHCP requests to the server
 - **SSH key injection** so your Air SSH keys work on the `oob-mgmt-server`
 
+### Disabling the DHCP Service
+
+By default, the OOB network includes a fully configured DHCP server. If you want to manage DHCP yourself — for example, to run your own DHCP server with custom configurations — you can disable the automatic DHCP service while keeping the rest of the OOB network (L2 connectivity, management interfaces, and infrastructure nodes).
+
+To disable DHCP when importing a JSON topology, set `enable_dhcp` to `false` in the `oob` object:
+
+```
+{
+    "nodes": { ... },
+    "links": [ ... ],
+    "oob": {
+        "enable_dhcp": false
+    }
+}
+```
+
+When DHCP is disabled:
+
+- The `oob-mgmt-server` and OOB switch infrastructure are still created.
+- Management interfaces (`eth0`) are still connected to the OOB network.
+- No DHCP server, DNS, or NAT gateway is configured on the `oob-mgmt-server`.
+- Nodes do not receive automatic IP assignments. You must configure IP addresses manually or provide your own DHCP server.
+
 ## Accessing Your Nodes
 
 The `oob-mgmt-server` is the entry point to your simulation. When you connect via SSH (using the service URL provided by Air), you land on this server.