Creating an Edge Gateway

Edit online

You can create one or more Edge Gateways by running the Edge Gateway installer and using the pairing information that you generated from the General settings > Connections> Edge gateways page in the platform.

You must have the pairing information as described in Creating pairing code, either in a file or in your clipboard.

This procedure requires the use of sudo and you must log in as the appadmin user.

To create an Edge Gateway, open the system console and run the following command: 
sudo manageAppHost install <options>
If you have the pairing information in your clipboard, you are prompted for it by default. If you have the pairing information in a file, add the -p option:
-p <full path to file>
The installation automatically searches for a certificate to trust. If a certificate is not available and you have a certificate in PEM format, add the -c option:
-c <full path to PEM certificate>

When prompted, you must trust the certificate.

If you require proxy authentication, make sure that the system hosting Edge Gateway is configured to use a proxy as described in Configuring proxy authentication. If it is configured, you can add the --proxy options. 
--http-proxy-url <http://URL:port# of proxy> --http-proxy-user <user>
If the Edge Gateway needs to access services whose host names are not in the network Domain Name Server, you can add the host name to the server hosting the Edge Gateway as follows. The <ip_address> is the address of the server that you want to access, and <hostname> is the name of the server. If a server has multiple names, you can add each name using --hostname as shown in the following command:
manageAppHost dns --set --ip <ip_address> --hostname <hostname1> --hostname <hostname2>
Note: You can use the --show option to see the defined host names and the --clear option to remove a host name previously set with the manageAppHost command.

You can use the command to create more Edge Gateways. One system hosting multiple Edge Gateways can pair Edge Gateway to multiple platform accounts. However, a single Edge Gateway can be paired to a single platform account only.

It takes some time to pull the image from quay.io and then the app controllers pods starts. You can check the connection from the General settings > Connections > Edge gateways page on the platform. For each Edge Gateway tile, there is a status indicator. Green indicates that the Edge Gateway is online and connected to the platform. The following graphic shows an example of an Edge Gateway page with successful connections highlighted.

Sample of successful connection.