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 as "ziggy"
- 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...
This basic registration is used to egress or terminate services in your LAN or Cloud network.
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 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 router-registration [one time registration key]
# TO VERIFY ROUTER STATUS AS RUNNING
You will see "Registration complete" when registration is complete.
Advanced Registration Parameters
These are not typically necessary when only accessing services in your LAN or Cloud. The preferred way to provide listeners for your network is to create hosted Edge Routers which are always listening and always internet-reachable. Optionally, you may configure your Edge Router to advertise listeners. This may be necessary in special cases where an intermediate hosted Edge Router is prohibitive for some reason.
This may only be necessary when you require ingress to the NetFoundry Network from hosts on the same network. The preferred way to provide edge listeners for your network is to create hosted Edge Routers which are always listening and always internet-reachable. Choose enable Link Listener when creating the Edge Router in the Console.
When you configure Edge Listener you will see the following output in /opt/netfoundry/ziti/ziti-router/config.yml file: