Merge pull request #563 from openziti/quickstart_doc_update

Updating quickstart with recent quickstart variable changes.

docusaurus/docs/guides/Local_Gateway/EdgeRouter.md

@@ -26,7 +26,7 @@ For the demonstration, we will setup the network like below:
 Please complete the following steps before continue with this demo.
 - An open-ziti network should be created already. If not, please follow this quickstart [Host OpenZiti Anywhere](/docs/learn/quickstarts/network/hosted/) guide to setup open-ziti network first.
 - Ziti Controller IP
-- Ziti Controller Fabric Port: On the controller, issue this command **echo $ZITI_CTRL_LISTENER_PORT**
+- Ziti Controller Fabric Port: On the controller, issue this command **echo $ZITI_CTRL_ADVERTISED_PORT**
 - Ziti Controller Management Port: On the controller, issue this command **echo $ZITI_CTRL_EDGE_ADVERTISED_PORT**
 - Ziti Controller Passwd: On the controller, issue this command **echo $ZITI_PWD**
 - Created two *routers* already. The routers should be running on **Ubuntu 22.04**.
@@ -48,7 +48,7 @@ Here is information I gathered from **Prerequisite** step:
 ```
 root@LocalGWDemoNC:~# curl -s eth0.me
 68.183.139.122  <--- Controller IP
-root@LocalGWDemoNC:~# echo $ZITI_CTRL_LISTENER_PORT
+root@LocalGWDemoNC:~# echo $ZITI_CTRL_ADVERTISED_PORT
 8440  <--- Controller Fabric Port
 root@LocalGWDemoNC:~# echo $ZITI_CTRL_EDGE_ADVERTISED_PORT
 8441  <--- Controller Management Port

docusaurus/docs/guides/Local_Gateway/EdgeTunnel.md

@@ -375,7 +375,7 @@ Get all the required information from controller:
 ```
 root@LocalGWDemoNC:~# curl -s eth0.me
 68.183.139.122  <--- Controller IP
-root@LocalGWDemoNC:~# echo $ZITI_CTRL_LISTENER_PORT
+root@LocalGWDemoNC:~# echo $ZITI_CTRL_ADVERTISED_PORT
 8440  <--- Controller Fabric Port
 root@LocalGWDemoNC:~# echo $ZITI_CTRL_EDGE_ADVERTISED_PORT
 8441  <--- Controller Management Port

docusaurus/docs/learn/quickstarts/network/hosted.md

@@ -56,12 +56,12 @@ export EXTERNAL_DNS="acme.example.com"
 ```bash
 export EXTERNAL_IP="$(curl -s eth0.me)"       
 export ZITI_EDGE_CONTROLLER_IP_OVERRIDE="${EXTERNAL_IP}"
-export ZITI_EDGE_ROUTER_IP_OVERRIDE="${EXTERNAL_IP}"
+export ZITI_ROUTER_IP_OVERRIDE="${EXTERNAL_IP}"
 export ZITI_CTRL_EDGE_ADVERTISED_ADDRESS="${EXTERNAL_DNS}"
 export ZITI_ROUTER_ADVERTISED_ADDRESS="${EXTERNAL_DNS}"
-export ZITI_CTRL_LISTENER_PORT=8440
+export ZITI_CTRL_ADVERTISED_PORT=8440
 export ZITI_CTRL_EDGE_ADVERTISED_PORT=8441
-export ZITI_EDGE_ROUTER_PORT=8442
+export ZITI_ROUTER_PORT=8442
 ```
 
 ### Run `expressInstall`
@@ -81,7 +81,7 @@ is useful to make sure the controller can restart automatically should you shutd
 
 ```bash
 createControllerSystemdFile
-createRouterSystemdFile "${ZITI_EDGE_ROUTER_NAME}"
+createRouterSystemdFile "${ZITI_ROUTER_NAME}"
 ```
 
 Example output:
@@ -90,7 +90,7 @@ Example output:
 $ createControllerSystemdFile
 Controller systemd file written to: /home/ubuntu/.ziti/quickstart/ip-172-31-23-18/ip-172-31-23-18-edge-controller.service
 
-$ createRouterSystemdFile "${ZITI_EDGE_ROUTER_NAME}"
+$ createRouterSystemdFile "${ZITI_ROUTER_NAME}"
 Router systemd file written to: /home/ubuntu/.ziti/quickstart/ip-172-31-23-18/ip-172-31-23-18-edge-router.service
 ```
 
@@ -122,7 +122,7 @@ After the `systemd` service units are generated, you can then install them by ru
 
 ```bash
 sudo cp "${ZITI_HOME}/${ZITI_CTRL_NAME}.service" /etc/systemd/system/ziti-controller.service
-sudo cp "${ZITI_HOME}/${ZITI_EDGE_ROUTER_NAME}.service" /etc/systemd/system/ziti-router.service
+sudo cp "${ZITI_HOME}/${ZITI_ROUTER_NAME}.service" /etc/systemd/system/ziti-router.service
 sudo systemctl daemon-reload
 sudo systemctl enable --now ziti-controller
 sudo systemctl enable --now ziti-router
@@ -133,7 +133,7 @@ Example output:
 ```bash
 $ sudo cp "${ZITI_HOME}/${ZITI_CTRL_NAME}.service" /etc/systemd/system/ziti-controller.service
 
-$ sudo cp "${ZITI_HOME}/${ZITI_EDGE_ROUTER_NAME}.service" /etc/systemd/system/ziti-router.service
+$ sudo cp "${ZITI_HOME}/${ZITI_ROUTER_NAME}.service" /etc/systemd/system/ziti-router.service
 
 $ sudo systemctl daemon-reload
 

docusaurus/docs/learn/quickstarts/network/local-no-docker.md

@@ -95,7 +95,7 @@ $ startRouter
 Express Edge Router started as process id: 1296. log located at: /home/vagrant/.ziti/quickstart/bullseye/bullseye-edge-router.log
 ```
 
-You can verify the edge router is listening by finding the value of `$ZITI_ROUTER_ADVERTISED_ADDRESS:$ZITI_EDGE_ROUTER_PORT`.
+You can verify the edge router is listening by finding the value of `$ZITI_ROUTER_ADVERTISED_ADDRESS:$ZITI_ROUTER_PORT`.
 Again, this will default to using `$(hostname -s)` as the host name and port 3022.
 
 ### Stopping the Controller and Router
@@ -163,7 +163,7 @@ Please realize that if you change these variables each of the "hostname" variabl
 * ZITI_CTRL_EDGE_ADVERTISED_ADDRESS
 * ZITI_CTRL_EDGE_ADVERTISED_PORT
 * ZITI_ROUTER_ADVERTISED_ADDRESS
-* ZITI_EDGE_ROUTER_PORT
+* ZITI_ROUTER_PORT
 
 Here is an example which allows you to put all the files into a folder called: `${HOME}/.ziti/quickstart/newfolder`, uses
 a host named 'localhost', and uses ports 8800 for the edge controller and 9090 for the edge router:
@@ -173,7 +173,7 @@ ZITI_NETWORK="newfolder"; \
 ZITI_CTRL_EDGE_ADVERTISED_ADDRESS=localhost; \
 ZITI_CTRL_EDGE_ADVERTISED_PORT=8800; \
 ZITI_ROUTER_ADVERTISED_ADDRESS=localhost; \
-ZITI_EDGE_ROUTER_PORT=9090; \
+ZITI_ROUTER_PORT=9090; \
 source ziti-cli-functions.sh; expressInstall
 ```
 

docusaurus/docs/learn/quickstarts/network/local-with-docker.md

@@ -116,9 +116,9 @@ default port used by edge routers.
 
 ```bash
 docker run \
-  -e ZITI_EDGE_ROUTER_NAME=ziti-edge-router-1 \
-  -e ZITI_EDGE_ROUTER_ROLES=public \
-  -e ZITI_EDGE_ROUTER_ADVERTISED_HOST=ziti-edge-router-1 \
+  -e ZITI_ROUTER_NAME=ziti-edge-router-1 \
+  -e ZITI_ROUTER_ROLES=public \
+  -e ZITI_ROUTER_ADVERTISED_HOST=ziti-edge-router-1 \
   --network myFirstZitiNetwork \
   --network-alias ziti-edge-router-1 \
   -p 3022:3022 \
@@ -134,10 +134,10 @@ If you want to create a second edge router, you'll need to override the router p
 
 ```bash
 docker run \
-  -e ZITI_EDGE_ROUTER_NAME=ziti-edge-router-2 \
-  -e ZITI_EDGE_ROUTER_ROLES=public \
-  -e ZITI_EDGE_ROUTER_PORT=4022 \
-  -e ZITI_EDGE_ROUTER_ADVERTISED_HOST=ziti-edge-router-2 \
+  -e ZITI_ROUTER_NAME=ziti-edge-router-2 \
+  -e ZITI_ROUTER_ROLES=public \
+  -e ZITI_ROUTER_PORT=4022 \
+  -e ZITI_ROUTER_ADVERTISED_HOST=ziti-edge-router-2 \
   --network myFirstZitiNetwork \
   --network-alias ziti-edge-router-2 \
   -p 4022:4022 \

docusaurus/docs/reference/deployments/02-router/02-configuration.md

@@ -19,10 +19,10 @@ This is a network side dialing only router with edge. It does not listen for con
 
 ```bash
 ZITI_CTRL_EDGE_ADVERTISED_ADDRESS=controller01.zitinetwork.example.org
-ZITI_CTRL_LISTENER_PORT=80
+ZITI_CTRL_ADVERTISED_PORT=80
 ZITI_ROUTER_ADVERTISED_HOST="192.168.10.11"
-ZITI_EDGE_ROUTER_IP_OVERRIDE="192.168.10.11"
-ZITI_EDGE_ROUTER_PORT=443
+ZITI_ROUTER_IP_OVERRIDE="192.168.10.11"
+ZITI_ROUTER_PORT=443
 ROUTER_NAME=$ZITI_ROUTER_ADVERTISED_HOST
 ZITI_ROUTER_IDENTITY_CERT="~/.ziti/config/certs/${ROUTER_NAME}.cert"
 ZITI_ROUTER_IDENTITY_SERVER_CERT="~/.ziti/config/certs/${ROUTER_NAME}.server.chain.cert"
@@ -117,10 +117,10 @@ This is a network side dialing only router with edge and tunneler( i.e. gateway
 
 ```bash
 ZITI_CTRL_EDGE_ADVERTISED_ADDRESS=controller01.zitinetwork.example.org
-ZITI_CTRL_LISTENER_PORT=80
+ZITI_CTRL_ADVERTISED_PORT=80
 ZITI_ROUTER_ADVERTISED_HOST="192.168.10.11"
-ZITI_EDGE_ROUTER_IP_OVERRIDE="192.168.10.11"
-ZITI_EDGE_ROUTER_PORT=443
+ZITI_ROUTER_IP_OVERRIDE="192.168.10.11"
+ZITI_ROUTER_PORT=443
 ROUTER_NAME=$ZITI_ROUTER_ADVERTISED_HOST
 ZITI_ROUTER_IDENTITY_CERT="~/.ziti/config/certs/${ROUTER_NAME}.cert"
 ZITI_ROUTER_IDENTITY_SERVER_CERT="~/.ziti/config/certs/${ROUTER_NAME}.server.chain.cert"
@@ -216,10 +216,10 @@ This is a network side dialing and listening router with edge. It listens for co
 
 ```bash
 ZITI_CTRL_EDGE_ADVERTISED_ADDRESS=controller01.zitinetwork.example.org
-ZITI_CTRL_LISTENER_PORT=80
-ZITI_EDGE_ROUTER_NAME=router01.zitinetwork.example.org
-ZITI_EDGE_ROUTER_PORT=443
-ROUTER_NAME=$ZITI_EDGE_ROUTER_NAME
+ZITI_CTRL_ADVERTISED_PORT=80
+ZITI_ROUTER_NAME=router01.zitinetwork.example.org
+ZITI_ROUTER_PORT=443
+ROUTER_NAME=ZITI_ROUTER_NAME
 ZITI_ROUTER_IDENTITY_CERT="~/.ziti/config/certs/${ROUTER_NAME}.cert"
 ZITI_ROUTER_IDENTITY_SERVER_CERT="~/.ziti/config/certs/${ROUTER_NAME}.server.chain.cert"
 ZITI_ROUTER_IDENTITY_KEY="~/.ziti/config/certs/${ROUTER_NAME}.key"