Skip to content

Getting started

What's new

Get the latest Topo source code and its accompanying release notes here.

Installing

Installing Topo is a matter of installing the Helm chart found here on the SEI's GitHub page. The CMU-SEI Helm charts repo is a public repository on GitHub for anyone to access and use. The Topo chart contains two sub-charts: topomojo-api and topomojo-ui. The api and the ui are different apps and need to be deployed separately.

Info

This structure is consistent with the other Foundry apps: there is an api piece and a ui piece.

TopoMojo values.yaml: Contains default configurations for the api and the ui. To deploy TopoMojo, configure the Values.yaml file according to your needs and helm install TopoMojo.

Persistent/Shared Networks

Having a persistent/shared network available to all TopoMojo workspaces/gamespaces is recommended. The persistent/shared network is defined by an administrator at the time the TopoMojo API is deployed.

Use case: create a persistent/shared network that provides internet access to all TopoMojo VMs that specify the network name (e.g., bridge-net signifies bridging the traditionally isolated TopoMojo VM to the internet).

Use the Pod__Vlan__Reservations environment variable to define the name of a persistent/shared network. See screen print 1 below.

  • Pod__Vlan__Reservations__0__Id: defines the vlan Id (from the hypervisor) that corresponds to the shared/persistent network.
  • Pod__Vlan__Reservations__0__Name: defines the name of the persistent/shared network.

More than one shared/persistent network can be defined by incrementing the variable name (Pod__Vlan__Reservations__1__Id and Pod__Vlan__Reservations__1__Name). To connect VMs to shared/persistent networks, users must have at least Builder permissions.

A note about bridge-net

"bridge-net" is not always reserved. It is reserved by the SEI because we configured it that way, and it is convenient to refer to in the Topo documentation.

Screen print 1:

bridge-net