How to setup and manage gateways
This section describes how to add various Gateways via the SDA Console.
Types of gateways
There are 2 types of gateways supported via the SDA Console:
Gateway as a native Linux installation (Debian-based)
Gateway as a Docker container
Gateways for virtual PLCs (please contact SDA to get access to this feature)
Setting up a gateway
Below you will find the instructions for setting up physical gateways (types 1 and 2 above) and a reference for setting up virtual gateways in the context of Virtual PLC (type 3 above).
Pre-requisites
| Pre-requisite | Detail |
|---|---|
SSH client | Tool to run SSH commands on your local machine (e.g., OpenSSH or PuTTY) |
Network connectivity | Your local machine requires access to the network with the gateway of your choice |
IP address | IP address of the gateway you wish to connect |
Username and password | Credentials of the gateway you wish to connect |
You have multiple options with respect to the SSH client.
Most people use the preinstalled OpenSSH on Linux to run SSH commands directly from the shell.
Note that some people also use PuTTY for debugging, connecting to serial ports, and to raw sockets. To set up PuTTY on Debian, use the following command:
Followed by the tools installation command:
Setting up a gateway as a native Linux installation
In order to set up a gateway, navigate to the Gateways pane and click "+".
Under "Add New Device" choose "Gateway".
Choose a name for the Gateway and click "Save".
To set up a hardware gateway, please choose the tab "Ubuntu". Automatically copy the command to your clipboard by clicking on the "command window".
Please note that the command is only valid for 60 minutes.
Please navigate to your Linux shell, macOS terminal, or Windows PowerShell.
Connect to the device that you intend to use as your gateway and establish a Secure Shell (SSH) session by running the following command:
For the username root and the IP address 192.168.10.10, the command would look like this:
After hitting enter, you may be asked to enter your gateway's password.
Now you are ready to paste the command copied from the SDA Console. This will initiate the set-up of the SDA Connectivity Client on your gateway.
Setting up a gateway as a Docker container
To set up your local machine or IPCs as an edge gateway, please start by installing Docker to your machine here: https://www.docker.com/products/docker-desktop/
Next, start Docker Desktop, open your shell, terminal, or PowerShell, and paste the command copied from your SDA Console unter "Setup Gateway" / "Docker" as seen in the figure below.
The installation process will look similar to the screenshot below.
Check if gateway installation was successful
After the installation, go back to the SDA Console and reload the entire page via the respective web browser function. Afterwards, when clicking on the newly created gateway the status "Gateway Health" should return a green checkmark. If the status is negative, (a) your firewall blocks the connection or (b) the installation was not completed successfully. Please contact SDA to get support.
Modifying a gateway
In order to modify a gateway configuration in the SDA Console, please right-click the respective gateway and click "Edit" to modify the name of the gateway. Click "Save" to save your changes.
In order to access the setup of your gateway later on, please right-click the respective gateway, click "Setup", re-run the SSH/Docker commands as described in the sections above.
Deleting a gateway
In order to delete a gateway, navigate to the respective gateway, perform a right click, and click "Delete".
Please note: You will not be allowed to delete a gateway that still has child controls. Please delete those controls first before deleting the gateway.
Last updated
