How to Register the Edge Router VM (Ubuntu)

Overview

The Edge Router VM has pre-installed software and configuration management to allow it to function as a router on the edge of your NetFoundry network. Deploying the VM involves:

  1. launching or downloading the latest VM,
  2. logging in to the VM as "ziggy"
  3. registering the VM.

The launch or download and login instructions are maintained separately from registration because they vary depending upon your stack. This article covers the final step in deploying your VM: registration. If you need to go back, the best place to start is the downloads page which has links to instructions for each path you might take e.g. launching on AWS, downloading for VMware, etc...

 

Register

This basic registration is used to egress or terminate services in your LAN or Cloud network.

These instructions assume

  1. you have copied the one-time registration key from the NF console to your notes or clipboard, and
  2. you are currently logged in to the VM as "ziggy". You will either log in with the default password "ziggy" or the SSH pubkey you specified when creating the VM. 

Run as user "ziggy" on your Edge Router VM:

$ sudo -E router-registration [one time registration key]
# TO VERIFY ROUTER STATUS AS RUNNING
$ zt-router-status

You will see "Registration complete" when registration is complete.

Advanced/Manual Registration

The router registration, when used in a single Interface environment, will default to use either the local IP address used by the VM or the external IP address provided by https://www.ipify.org/. This is determined by the flag under the customer hosted router called “ENABLE LINK LISTERNER”.

 

link_listener.png

When Disabled 

  • Default - Will use the local IP assigned to interface and will only listen on port 443 for EDGE connections from local subnet.

When Enabled

  • Will use the external IP and will listen on 443 for EDGE connection from anywhere
  • Will use the external IP and will listen on port 80 for FABRIC connections from anywhere.

 

Manual configuration(Multi Interface)

Used with multi Interface configurations or to override the defaults, you can use the flags “-e”, “-b” & "-i" to specify an IP Address or DNS name you want to use for the router configuration regardless of what is auto discovered.

-e, --edge: This is the IP address or DNS name that will be used by the router configuration “Edge” connection advertisement.

-b, --fabric: This is the IP address or DNS name that will be used by the router configuration “Fabric” & is only available if the router is “Link Listener Enabled”

-i, --tunnel_ip: This is the IP used as the local tunnel interface.  This IP must be something assigned to a local interface. 

 

Example 1(most common): , "fqdn.internal.com" is the domain name that only resolves internally & LAN interface with 192.168.1.1.

$ sudo -E router-registration \
--edge fqdn.internal.com \
--tunnel_ip 192.168.1.1 [one time registration key]

 

Example 2: "fqdn.example.com" is the domain name that resolves in global DNS to the IPv4 address where your Edge Router is listening on 443/tcp for incoming transit links & LAN interface with 192.168.1.

$ sudo -E router-registration \
--edge fqdn.example.com \
--tunnel_ip 192.168.1.1 [one time registration key]

 

In this example, "fqdn.example.com" is the domain name that resolves in global DNS to the IPv4 address where your Edge Router is listening on 443/tcp for edge and 80/tcp & LAN interface with 192.168.1.1

$ sudo -E router-registration \
--edge fqdn.example.com \
--fabric fqdn.example.com \
--tunnel_ip 192.168.1.1 [one time registration key]

Note: Although usually the same, the values for edge & fabric can be different.

 

Registering from behind a proxy

Registration is possible from behind a proxy when using a non-authenticated proxy that uses the CONNECT method. (HTTP/HTTPS).

To register from behind a proxy you need to specify the proxy before running the registration command:

$ export HTTPS_PROXY=http://mylocalproxyaddress.com:3128

After setting the correct value for the proxy, you can run the registration command as shown in the above examples.

To setup the ER to also use the proxy, you can specify additional parameters to the registration command:

$ sudo -E router-registration [one time registration key] --proxyAddress mylocalproxyaddress \
--proxyPort 3128
--proxyType http

ProxyPort & ProxyType are optional fileds & are defaulted to the above values.

 

 

Troubleshooting Registration

You may wish to verify the router daemon's status

$ zt-router-status

Please run these commands to print the application logs and attach to your support request or email to support@netfoundry.io to create a support request.

$ zt-log-zip

For specific instructions for your VM stack please reference the downloads page which has links to instructions for each path you might take e.g. launching on AWS, downloading for VMware, etc.... 

See the Support Hub article: Troubleshoot client and gateway registration errors.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.