User Tools

Site Tools


Sidebar

opensand:manuals:5.2:user_manual_legacy:index

User manual (Legacy)

This manual explains how to use the OpenSAND testbed by means of the OpenSAND Manager and monitor OpenSAND (logs/metrics) by means of OpenSAND Collector. OpenSAND software must already be installed, and the testbed configured. Refer to the installation and configuration manuals.

OpenSAND Manager Manual

Overview

OpenSAND Manager is a graphical application based on GTK that allows the user to control the OpenSAND testbed. Some of its features include:

  • start/stop a simulation,
  • check simulation status
  • deploy configuration and binary files to other testbed hosts,
  • import/export scenarios from/to files.
The manager does not display logs and probes. To do so, you will need to install a collector and give the manager its IP address when you install the packet (see opensand_collector_manual).

Launch OpenSAND manager

OpenSAND manager uses zeroconf to detect the different OpenSAND hosts in the platform, which is why it is important that the machine be connected to the same network as the hosts, and that the service name be unique. If the default service name is used (_opensand._tcp), then the manager can be launched with:

sand-manager

Else, the service name must be specified:

sand-manager -t <service_name>

The main window will appear:

Start a simulation

In order to start a simulation, the user can simply click on the Start OpenSAND button, located on the upper left corner of the Run tab (or click Start OpenSAND on the Simulation menu). This will start the OpenSAND processes on all the testbed hosts. Once the simulation is started, user workstations can send and receive network traffic over the satellite network.

The spot besides each host name indicates the state of said host. When launching the simulation, all hosts states should turn green, which means that the hosts are running. Red and orange colours indicate that there is a problem with the daemon.

The output view displays messages relayed from the daemons to the manager, and include a message indicating that a simulation has successfully started.

The Run ID field allows the user to specify a name for the session. By default, the Run ID is named default_N, with N incremented on each start.

Stop simulation

In order to stop a simulation while it is running, the user can simply click on the Stop OpenSAND button, located on the upper left corner of the Run tab (or click Stop OpenSAND on the Simulation menu). This will stop the OpenSAND processes on all the testbed hosts. Once simulation is stopped, user workstations can no longer send nor receive network traffic over the satellite network.

OpenSAND manager will print messages to show which actions are executed, and eventual errors. The spot of each component should turn red after stopping the simulation.

Manage simulations

OpenSAND manager allows the user to save and load previous simulations. A simulation contains the manager configuration, the hosts' configurations, and all the simulation results, which can be loaded on the Probes tab.

Simulations are stored in dedicated folters: to save a simulation, the user must create a new folder; to load one, the user must provide the path to a folder. By default, all simulations are saved in ~/.opensand/default folder, and cleaned on exit. To keep the results, the user must specify another folder.

The current scenario name is displayed in the window title.

Configure simulations

The configuration in OpenSAND Manager is divided in two tabs: Resource Configuration, and Configuration.

The Resource Configuration tab allows the user to configure parameters linked with the waveforms used, such as the available MODCODs and the available bandwidth, the GW associated to each ST, as well as its category.

On the Configuration tab, the user can select the type of LAN adaptation to use, the encapsulation protocols on the forward and return link, and whether to use physical attenuation or not. For more advanced configurations, the Advanced button will display the Advanced Configurations Dialog.

Further information

The complete list of satcom features implemented by OpenSAND is presented in the emulated satcom features page. Each feature contains at least one page, with information about how it is implemented in OpenSAND, and how to make use of it.

Furthermore, the OpenSAND Testbed Description page presents the different characteristics specific of the OpenSAND test platform.

Configure attenuation based on MODCODs

A script is available (modcod2attenuation), which allows the user to convert MODCOD trace files to attenuation files: this way, the user can specify the evolution of the MODCODs used on a link (forward or return), and the script will calculate the attenuations needed to obtain such MODCODs. Refer to its page for more information about how to use it.

OpenSAND Collector Manual

This manual documents the different parts composing the OpenSAND's collector, their configuration and their usage.

Overview

The OpenSAND collector is composed of:

  • Logstash that receives, prepares and dispatch data from OpenSAND to the other components;
  • ElasticSearch that stores logs;
  • InfluxDB that stores probes.

It also installs the following visualization tool:

Each component is brought as dependency of the opensand-collector package and set-up to work with one another.

Access Probes and Logs

Logs

Kibana is installed and configured by the opensand-collector package as a way to visualize the logs sent by OpenSAND.

It provides a web server that is listening on port 5601 by default. In order to visualize your logs, fire a web browser and open it to:

 http://<your_collector_ip>:5601 

To explore the logs, go to the Dashboard tab on the left pane. The default view will list the logs received by the collector during the past 15 minutes. You can select the refresh and time-period options by using the menu in the top-right corner.


Probes

Chronograf is installed and configured by the opensand-collector package as a way to visualize the probes sent by OpenSAND.

It provides a web server that is listening on port 8888 by default. In order to visualize your logs, fire a web browser and open it to:

 http://<your_collector_ip>:8888 

In order to explore your probes, go to the Explore tab on the left pane and choose the opensand.autogen retention policy (see highlighted fields in the picture below). Probes emitted by OpenSAND will be shown and you will be able to select those that are of interest to you (we recommend you to disable the mean function when you select each Probe).

We recommend you to use the Chronograf manual Chronograf.


You can also create your own dashboards for monitoring OpenSAND. Go to the Dashboards tab on the left pane, then:

  • Crate dashboard or Add cell (blue square on top that seems a Tetris game).
  • Add data on the cell and select the Probes as you did in the Explore tab.
  • Do not forget to save your cell (click on top right corner)

An example of dashboard Chronograf with OpenSAND probes is shown below:

opensand/manuals/5.2/user_manual_legacy/index.txt ยท Last modified: 2020/04/27 18:48 by dpradas