This quick start provides an easy way to get started with the NVIDIA Air simulation platform.
Log into NVIDIA Air
NVIDIA Air uses the same credentials as the NVIDIA developer forums for account access. When the login page appears, enter your email address (the one you already use for the forums or the one you intend to use to sign up) in the entry field and click Get Started:
The page redirects to the NVIDIA forums login page. Click the Create Account link to sign up or enter your password to log in with an existing account:
NVIDIA Air Landing Page
After you log in, the NVIDIA Air landing page appears:
The landing page offers the following options:
Organizations: If you have custom simulations, the
Organizationsdropdown shows the different organizations to which each simulation belongs. This is typically only visible if you are working directly with an NVIDIA Solutions Architect to set up a custom topology.
Search Simulations: If you have more than one simulation, the search field can help filter your simulations based on a text match.
Build a Simulation: If you have no simulations, click the Build a Simulation button in the middle of the screen. You can read details of the demos in Pre-built Demos.
This launches a new window from where you can choose one of the pre-built demos from the list.
Sidebar: The sidebar to the left has a Create a Simulation link to create new simulations, links to the current Cumulus Linux and NetQ user guides and a link to self-paced labs.
Every simulation has a basic view and an advanced view, which provides more options.
The basic view of the simulation provides a graphical view of the simulation’s topology.
Click a node in the topology to launch a console to connect to that node:
The advanced view has 4 different panes:
- Guided Tour: A detailed description of the simulation, complete with step-by-step instructions on running the demo infrastructure.
- Console: The console connection to the simulation.
- Nodes: The list of the nodes in the topology. The list shows the status, number of CPUs and amount of memory for each node. You can take the following actions for each node:
- Rebuild: To restore the node to its default configuration.
- Reset: To issue a hard reset to the node.
- View Console: To connect to the node via a console.
- Services: Optional services you can add, such as SSH. See Services below.
The Services pane provides the ability to create an external connection into the simulation. Example use cases for this include:
- Accessing the simulation environment using your local preferred SSH client.
- Running Grafana on the oob-mgmt-server and accessing the Grafana GUI externally.
- Setting up SNMP polling from your local laptop into the simulation environment.
To set up a service click the + Add Service button.
The Create Service dialog appears:
- In the Service Name field, enter the name of the service. This is a free form text field.
- In the Interface dropdown, select the name of the interface in the simulation where the connection terminates. This is most commonly the eth0 interface on the oob-mgmt-server.
- In the Service Type dropdown, select the type of service you are creating. If you select SSH, HTTP or HTTPS, a hyperlink to the URL is automatically created in the Services panel. If you select Other, you can select any port, but no hyperlink gets created. The hyperlink has no functional difference other than providing users a quick way to copy and paste the service.
- In the Service Port field, specify the internal port where the service terminates.
- Click Submit to create the service.
The example below shows the creation of a service for TCP port 1022. The external port is 24886, so connecting to this service requires connecting to worker06.air.nvidia.com on TCP port 24886, which would forward and redirect to the oob-mgmt-server on TCP port 1022.
The Enable SSH button automatically populates the Services panel with an SSH session. It is a shortcut to enable inbound SSH to the oob-mgmt-server so that you can leverage your preferred local SSH client. Note that SSH password authentication is disabled on the oob-mgmt-server by default, so you must upload SSH keys to your user profile so you can use this feature. More information about uploading SSH keys to the user profile is in User Settings below.
Manage a Simulation
From the Air landing page, you can manage simulations. There are three options for each public simulation:
- Power On/Off: Wakes the simulation up or puts it to sleep.
- Rebuild: Resets the simulation to its initial configuration. This is useful if you’ve made many changes to the simulation and it is no longer in a desireable state.
- Delete: Deletes the simulation.
In the top right of the Air window next to the Logout link is a gear icon:
Clicking the gear loads the User Settings page where you can:
- Generate API tokens
- Upload SSH keys
You can use API tokens to execute authenticated activities using the Air API/SDK.
To generate a token, enter the requisite data into the field and click Create.
This generates a token that you can use to access the API and SDK.
The SSH Keys tab is where you can upload your public SSH key.
These SSH keys are automatically uploaded to the oob-mgmt-server. Creating a simulation and enabling SSH allows for passwordless authentication.