dgx-spark-playbooks/nvidia/station-brev/endpoint-test.yaml

kind: Playbook
metadata:
  name: station-brev
  displayName: Station Register to Brev
  shortDescription: Link your DGX Station to Brev for remote access and sharing
  publisher: nvidia
  description: |
    # REPLACE THIS WITH YOUR MODEL CARD
    https://gitlab-master.nvidia.com/api-catalog/examples/-/blob/main/modelcard-example-mixtral8x7b.md?ref_type=heads
    
  labelsV2:
  - gpuType:playbook:gpu_type_station
  - DGX
  - Station
  - Brev
  
  attributes:
  - key: DURATION
    value: 5 MIN
  
spec:
  artifactName: station-brev
  nvcfFunctionId: None
  attributes:

    showUnavailableBanner: false
    apiDocsUrl: None
    termsOfUse: |
      
    cta:
      text: Brev Overview
      url: https://docs.nvidia.com/brev/concepts/overview
      

    tabs:
    - 
      id: overview
      
      label: Overview
      content: |
        # Basic idea
        
        NVIDIA Brev is an AI development platform that makes GPU environments remotely accessible, shareable, and easy to standardize using preconfigured setups called Launchables. 
        
        This walkthrough will help you connect your NVIDIA DGX Station to Brev so it shows up as a managed GPU environment in Brev. After a one-time registration, your Station becomes remotely accessible and shareable.
        
        # What you'll accomplish
        
        You’ll register your DGX Station with Brev and it will be visible as a healthy node in the Brev web UI and CLI, ready to share access and accept workloads whenever needed.
        
        # What to know before starting
        
        While Brev automates the complex configuration, understanding a few key concepts when establishing the initial connection will be useful:
        
        * **Terminal Basics**:
          * Familiarity with the command line to run a few simple setup commands
        
        # Prerequisites
        
        You will also need the following:
        
        * NVIDIA DGX Station with GB300 GPU
        * **Brev Account**:
          * Have an NVIDIA Brev account. [Create an NVIDIA Brev account](https://login.brev.nvidia.com/signin) if you don’t have one.
        
        * **Permissions**:
          * You have administrative (root or sudo) access on the DGX Station device to run the registration command.
        
        # Time & risk
        
        * **Estimated time:** 5-10 minutes
        * **Risk level:** Low - Registration configures the Station for secure remote access without altering your existing workloads
        * **Rollback:** The Brev configuration can be removed through the UI and CLI
        
      

    - 
      id: instructions
      
      label: Instructions
      content: |
        # Step 1. Login to Brev
        
        Go to the [Brev UI](https://brev.nvidia.com), log in, and confirm you’re in the correct org (by clicking the org button on the top right hand side of the page). Once logged in, go to the [Registered Compute](https://brev.nvidia.com/org/environments?tab=registered-compute) section under the "GPU" tab in the main navigation.
        
        Click the “Register Compute” button and follow the instructions in the pop-up window.
        
        # Step 2. Complete Popup Instructions
        
        * Install the Brev CLI
        * Configure your compute
            * Add a name for compute
            * To configure ssh, ensure the “Enable SSH access” toggle is on
        * Run the registration command
        
        # Step 3. Follow Registration Flow
        
        In the CLI, you’ll be walked through registration. Go through the flow until registration is complete.
        
        # Step 4. Confirm DGX Station in Brev UI
        
        * Go to the [Brev UI](https://brev.nvidia.com)
        * Navigate to the [Registered Compute](https://brev.nvidia.com/org/environments?tab=registered-compute)
        * Confirm that the DGX Station appears as a registered node with an **Available** status 
        
        # Step 5. Next Steps
        
        Your DGX Station is now integrated into Brev as a secure, remotely accessible GPU environment.
        
        Now that your hardware is connected, you can:
        
        * **Share Access Anywhere:** Access your machine from anywhere and share access with others through the Brev UI under [Registered Compute](https://brev.nvidia.com/org/environments?tab=registered-compute).
        
        # Step 6. Cleanup
        
        If you ever decide to unregister your DGX Station with Brev, you can either do so through the Brev UI or the Brev CLI.
        
        With the CLI simply run:
        
        ```bash
        brev deregister
        ```
        
        In the UI:
        * Go to the [Brev UI](https://brev.nvidia.com)
        * Navigate to the section listing “GPU Environments” and look under “Registered Compute”
        * Click the “Deregister” menu item on the device you wish to delete from Brev
        * Confirm your selection
        
      

    - 
      id: troubleshooting
      
      label: Troubleshooting
      content: |
        | Symptom | Cause | Fix |
        |---------|-------|-----|
        | Your DGX Station is showing up in the wrong org | It was registered to the wrong org | Run `brev set <my-org>` and then redo the registration process |
        | Unable to `brev shell <name>` | Need to refresh | `brev refresh` |
        
      


    resources:
    - name: Brev Documentation
      url: https://docs.nvidia.com/brev/latest