> For the complete documentation index, see [llms.txt](https://docs.vex-nx.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vex-nx.com/labs/guided-labs.md).

# Guided Labs

![Guided Labs catalog](https://1807546539-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhgHCHWL3861o2DBW53aA%2Fuploads%2FHSysito7HbpSm923Uhm6%2Fve20261112v5-guided-labs.png?alt=media)

## Goal

Launch a ready-made teaching lab (often FRR / Alpine Docker) with topology, startup configs, and an optional markdown Guide.

## Why Guided Labs exist

New users do not know how many nodes to place or which protocols to configure first. Guided Labs give:

* A known-good topology
* Day-0 configs so Start is useful immediately
* A lesson beside the canvas

**Beginner tip:** Start here on day 1. Use blank / Generate / Migrate / Import when you already have a diagram or files.

## GUI tutorial

### Step 1 - Open the Guided Labs catalog

![Guided Labs catalog](https://1807546539-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhgHCHWL3861o2DBW53aA%2Fuploads%2FHSysito7HbpSm923Uhm6%2Fve20261112v5-guided-labs.png?alt=media)

1. Sidebar -> **Guided Labs** (or Labs -> Guided Labs panel)
2. If collapsed, click **Show (N)**

|                  |                                      |
| ---------------- | ------------------------------------ |
| **What you see** | Catalog cards with difficulty / tags |
| **Expected**     | You can open or launch a pack        |

### Step 2 - Launch and open the Guide

![Guided progress / tasks](https://1807546539-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhgHCHWL3861o2DBW53aA%2Fuploads%2FRnEBK8TbTOC9UT3h69Qp%2Fve20261112v5-guided-progress.png?alt=media)

1. Pick a pack (FRR / Alpine starters are safest day 1)
2. Create / open the lab
3. Open the **Guide** pane beside the canvas
4. Switch to **Operate** and Start - [Operate and consoles](/labs/operate-and-consoles.md)

## Open the catalog

1. Labs -> **Guided Labs** (scrolls to the panel)
2. If collapsed, click **Show (N)**

UI note: seeded Docker images for current builds include `quay.io/frrouting/frr:10.2.1` and `alpine:3.20`. If Start fails on pull, run `sudo vexnx-seed-docker` on the appliance (or ask an admin to use Operate -> More -> Seed Docker images).

## Filters

| Filter     | Why                                                                                               |
| ---------- | ------------------------------------------------------------------------------------------------- |
| Search     | Match name, description, or tags                                                                  |
| **Domain** | Switching, Routing, Datacenter, Security, Service provider, Automation, Troubleshoot, Foundations |
| **Rank**   | Bronze, Silver, Gold (start at Bronze)                                                            |

## Per card actions

| Action              | Effect                                                                                   |
| ------------------- | ---------------------------------------------------------------------------------------- |
| **Use this lab**    | Creates the lab from the preset; opens with the guide beside the topology                |
| **Guide**           | Preview markdown before creating                                                         |
| **Restore factory** | Only if the card shows **Customized** - drops this appliance's override for that starter |

## Recipe: first day on the product

1. Domain: **Foundations** (or Routing)
2. Rank: **Bronze**
3. Open **Guide** on a small FRR or Alpine card - skim the goals
4. **Use this lab**
5. **Operate** -> **Start all** -> **Terminal**
6. Follow the Guide steps (for FRR Docker, run `vtysh` inside the shell)

## Customize (instructors)

Change topology, configs, or guide on a launched lab, then publish it as the runtime default for that starter on **this** appliance. Cards show **Customized**. **Restore factory** undoes that.

Details for class delivery: Classroom for instructors.

## AI InfiniBand fabric (not in this build)

Catalog card: **AI InfiniBand fabric (GPU, storage, Ethernet)** (`ai-ib-basepod`).

This lab is withheld from the Guided Labs catalog in this build: its topology needs more memory and boot time than the current appliance class completes reliably. The topology, guide, and playbooks remain in the product, and any lab already created from it keeps working. It returns to the catalog once it passes a full start / control-plane / data-plane run.

One topology for twenty labs: HPC InfiniBand rails, Ethernet storage, general-purpose Ethernet, backbone, OOB, and **SKYWAY-01** (IPoIB-to-Ethernet IP gateway, not RDMA conversion).

1. Start `GPU01`, `IB-LEAF-HPC-1`, `OOB-1` first. On GPU01 run `ibstat` and `ping 10.10.10.1`.
2. Follow the guide for Rail-B, storage (`10.10.40.0/24`), GP Ethernet (`10.10.60.0/24`), and Skyway (`ping 10.10.60.11` via `172.20.10.254`).

Consoles speak OFED-style commands (`ibstat`, `ibnetdiscover`, `sminfo`). IB switches use `show interfaces ib`, not OSPF.

## Expected result

* Lab opens with nodes already placed
* Guide panel available
* Start works when Docker seeds (or required images) are present

## If it fails

* Docker off on Home -> wait for install phase or fix Docker
* Image pull / DNS errors -> Infrastructure Management DNS, then `sudo vexnx-seed-docker`
* No cards match filters -> clear search / set All domains and All ranks

## Related

* [First lab walkthrough](/labs/first-lab-walkthrough.md)
* [Operate and consoles](/labs/operate-and-consoles.md)
* [Labs page](/labs/labs-page.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.vex-nx.com/labs/guided-labs.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.