Using groundSwXtch User Interface

WHAT TO EXPECT
In this article, users will learn how to access the groundSwXtch User Interface and how to find their way around it: static vs. dynamic multicast, the top ribbon, the right side panel and the map tools.

What is the groundSwXtch User Interface?

The groundSwXtch User Interface is a web-based monitoring and configuration tool for groundSwXtch. It presents users with a high-level view of their groundSwXtch environment with an interactive graph detailing connections to different endpoints showing multicast data between groundSwXtches.

How to Access the groundSwXtch User Interface

To access the groundSwXtch UI, users will need to enter the following URL into a web browser that has network visibility to the control interface of their groundSwXtch. While the user interface is automatically added with each groundSwXtch, it is important to just use one for all groundSwXtches that users intend to work together.

http://<groundSwXtch-address>

NOTE
The groundSwXtch User Interface has no login in this version. Do not expose it to the internet; to reach it remotely, use a VPN or an SSH tunnel.

This article covers:

What is Static vs Dynamic?

Static is used when a user wants to control the traffic, with static the user will manually create sources and destinations for multicast, only sources and destinations for each groundSwXtch will need to be configured to specify what streams should be allowed as sources and as destination.

Dynamic is used when no control is expected, the user does not want to control the traffic. Any multicast that is found in the network will be received without having to do any configuration.

Both can be used at the same time, but caution should be used as this could become a bit confusing to understand why traffic is or is not working. Additionally, the user can enable dynamic for some but not all groundSwXtches.

How to Navigate the groundSwXtch User Interface

The user interface will start out with the groundSwXtch belonging to the address entered into the URL.

Below is the user interface with dynamic enabled, no sources or destinations are manually created, instead the groundSwXtch detects the streams dynamically and adds them as an endpoint subscribes via IGMP join to a running multicast address. The map displays the multicast groups from one groundSwXtch to another and by hovering over the group the multicast group details display.

Below is the user interface showing static with some groundSwXtches already added with sources and destinations. The map displays the multicast groups from one groundSwXtch to another and by hovering over the group the multicast group details display. No endpoint has to subscribe to the multicast in this case as if it is configured as a source and a destination then the traffic will flow.

Top Ribbon

The top ribbon data area displays:

Sites: A site is one groundSwXtch instance. Each site row carries a bundle of bounded, aggregate-only data: reachability, license status, rx/tx Mbps totals, live socket/stream counts, multicast route count, and a derived health. Sites below show the number of all groundSwXtch Instances.
Nodes: A node and a site may not match, a site may have multiple reachable addresses, e.g. LAN + public IP, this is rolled up into one Site.
Multicast Groups: This is the distinct multicast groups active fleet-wide.
Inter-site flows: This is the sum of the group count for flows that cross site boundaries. Note: it's specifically flows crossing sites.
Wire load: The dominant (larger) of total received Mbps and total transmitted Mbps.
Degraded: The count of sites which are down.

The top ribbon buttons:

All Streams: Shows in the stream tab all the streams currently active. See also How to use the side panel/Streams.
Alerts: Shows the alerts panel. They can be filtered using the buttons at the top.
Licensed: Shows configure tab with the license data expanded. See also How to license the groundSwXtch.

The buttons to the far left allow the user to add groundSwXtches, Sources, Destinations and Dynamic Join/leave.

Right Side Panel

Configuration for Streams, Configure and Advanced tabs can be opened using the icons to the far right.

Depending on the one chosen the tab will be opened to that selection. See How to use the side panel.

Map Tool

The map tools allow the user to change to Schematic view from Map view, Zoom in and out, Fit to Window and Lock the map area.

Left click allows the user to move the map area.

Left click on a groundSwXtch brings up details about the groundSwXtch details pane. For more information on this pane refer to groundSwXtch Details Pane.

PLEASE NOTE
The groundSwXtch configuration, including changes made in the UI, is stored on the host in /var/lib/groundswxtch/groundswxtch.yaml.