Changes between Version 23 and Version 24 of User Guide


Ignore:
Timestamp:
Mar 30, 2026, 6:41:08 PM (4 days ago)
Author:
editor
Comment:

Rewrote User Guide with structured sections and quick links

Legend:

Unmodified
Added
Removed
Modified
  • User Guide

    v23 v24  
    11[[Include(WikiToC)]]
    2 = User Guide
     2= COSMOS/ORBIT User Guide =
    33
    4 This Section contains detailed information about usage of the Testbed.
     4Welcome to the COSMOS/ORBIT Testbed User Guide. This guide provides everything you need to go from creating an account to running experiments on the testbed. Whether you are a first-time user or an experienced researcher, these pages cover the tools and workflows that make the testbed productive and accessible.
    55
    6 * For a quick start, refer to GettingStarted.
    7 * General information is available at [CosmosOverview/Concepts Concepts] and [CosmosOverview/Workflow Workflow].
    8 * Detailed pages are listed below.
    9 [[TOC(UserGuide/*,inline,nonumbering,notitle,noheading,depth=2)]]
     6If you are brand new, start with the [wiki:GettingStarted Getting Started] tutorial, which walks you through your very first experiment step by step. The sections below provide detailed reference material for each aspect of the testbed.
     7
     8----
     9
     10== The COSMOS Portal ==
     11
     12The [wiki:UserGuide/Portal COSMOS Portal] is your primary interface to the testbed. Through the portal you manage your account, reserve testbed time, monitor node status, browse disk images, and connect with the user community. The portal is a modern web application accessible at '''https://www.cosmos-lab.org/portal''' from any browser.
     13
     14The portal documentation is organized into the following pages:
     15
     16* [wiki:UserGuide/Portal/GettingStarted '''Getting Started'''] — Create your account, activate it, and log in for the first time
     17* [wiki:UserGuide/Portal/Dashboard '''Dashboard'''] — Your home page with profile summary, usage statistics, and community forum access
     18* [wiki:UserGuide/Portal/Account '''Account Management'''] — Edit your profile, change your password, and manage SSH keys
     19* [wiki:UserGuide/Portal/Scheduler '''Scheduler'''] — Reserve testbed domains, manage recurring reservations, and understand the approval system
     20* [wiki:UserGuide/Portal/Status '''Testbed Status'''] — Real-time node power states and RF Matrix control during your reservations
     21* [wiki:UserGuide/Portal/DiskImages '''Disk Images'''] — Browse, search, and manage the testbed image library
     22* [wiki:UserGuide/Portal/Forum '''Community Forum'''] — Ask questions, share results, and discuss experiments with the community
     23* [wiki:UserGuide/Portal/Directory '''Directory'''] — Browse registered users and organizations
     24
     25----
     26
     27== Connecting to the Testbed ==
     28
     29Once you have a reservation and SSH keys set up, you connect to testbed nodes through SSH. The testbed uses a jump-host model where you first reach a console server, then hop to individual nodes.
     30
     31* [wiki:UserGuide/Portal/SSH '''SSH Access'''] — Connection patterns, ProxyJump, tunneling, file transfer, and SSH configuration
     32* [wiki:UserGuide/RemoteAccess '''Remote Access Options'''] — VPN, remote desktop (Chrome Remote Desktop, TigerVNC), and alternative access methods
     33* [wiki:UserGuide/StorageSpace '''Storage Space'''] — Local disk, NFS shared storage, and cloud storage options available on testbed nodes
     34
     35----
     36
     37== Running Experiments ==
     38
     39The testbed is controlled through the `omf` command-line tools, which you run from the console server during your reservation. These tools let you power nodes on and off, load disk images, save custom images, and check node status.
     40
     41* [wiki:UserGuide/OmfQuickStart '''OMF Quick Start'''] — Complete reference for all `omf` commands: `omf stat`, `omf tell`, `omf load`, `omf save`
     42* [wiki:UserGuide/DiskImages '''Disk Images Reference'''] — Baseline images, creating custom images, and image management
     43* [wiki:UserGuide/Results '''Collecting Results'''] — Retrieving experiment data from testbed nodes
     44
     45For hands-on tutorials that walk you through specific experiment types (wireless, SDR, optical, 5G, edge computing), see the [wiki:Tutorials Tutorials] section.
     46
     47----
     48
     49== Policies and Support ==
     50
     51* [wiki:UserGuide/AcceptableUse '''Acceptable Use Policy'''] — Guidelines for responsible use of testbed resources
     52* [wiki:UserGuide/Faq '''Frequently Asked Questions'''] — Common questions about accounts, SSH, and testbed usage
     53* [wiki:UserGuide/Support '''Getting Help'''] — How to contact support, report problems, and find answers
     54* [wiki:UserGuide/CameraStreaming '''Camera Streaming'''] — Accessing live camera feeds from testbed sites
     55
     56----
     57
     58== Quick Links ==
     59
     60||= I want to... =||= Go to... =||
     61|| Create an account || [wiki:UserGuide/Portal/GettingStarted Portal: Getting Started] ||
     62|| Upload my SSH key || [wiki:UserGuide/Portal/Account Portal: Account Management] ||
     63|| Make a reservation || [wiki:UserGuide/Portal/Scheduler Portal: Scheduler] ||
     64|| Connect to a node || [wiki:UserGuide/Portal/SSH SSH Access] ||
     65|| Load an image onto nodes || [wiki:UserGuide/OmfQuickStart OMF Quick Start] ||
     66|| Save my experiment || [wiki:UserGuide/OmfQuickStart OMF Quick Start] ||
     67|| Ask a question || [wiki:UserGuide/Portal/Forum Community Forum] ||
     68|| Report a problem || [wiki:UserGuide/Support Support] ||