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:
- Launching or downloading the latest VM,
- Logging in to the VM
- 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
You will see "Registration complete" when registration is complete.
These instructions assume
- You have copied the one-time registration key from the NF console to your notes or clipboard, and
- You are currently logged in to the VM.
Run the following on your Edge Router VM:
$ sudo router-registration [one time registration key]
$ sudo systemctl status ziti-router.service
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
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 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 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 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.
Troubleshooting Registration
You may wish to verify the router daemon's status
$ sudo systemctl status ziti-router.service
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.
$ cat /etc/motd | tee ziti-router-$(date +%Y%m%d%H).log
$ sudo journalctl -o cat --no-pager -xeu ziti-router.service | tee -a ziti-router-$(date +%Y%m%d%H).log
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.
Comments
0 comments