Updating ZITI_ROUTER_ADVERTISED_HOST to use ZITI_ROUTER_ADVERTISED_AD…

…DRESS to match other similarly named objects closes #1225 Signed-off-by: gberl002 <[email protected]>
openziti · Aug 9, 2023 · 6e7f3d0 · 6e7f3d0
1 parent 1ad9925
commit 6e7f3d0
Show file tree

Hide file tree

Showing 11 changed files with 20 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@
 * github.com/openziti/ziti: [v0.29.0 -> v0.29.1](https://github.com/openziti/ziti/compare/v0.29.0...v0.29.1)
   * [Issue #1212](https://github.com/openziti/ziti/issues/1212) - Fixed getZiti function on Mac/ZSH
   * [Issue #1220](https://github.com/openziti/ziti/issues/1220) - Fixed getZiti function not respecting user input for custom path
+  * [Issue #1225](https://github.com/openziti/ziti/issues/1225) - Updated ZITI_ROUTER_ADVERTISED_HOST to use the more common naming convention of ZITI_ROUTER_ADVERTISED_ADDRESS
 
 # Release 0.29.0
 

diff --git a/quickstart/docker/.env b/quickstart/docker/.env
@@ -21,7 +21,7 @@ ZITI_ROUTER_ENROLLMENT_DURATION=10080
 
 # router address/port information
 #ZITI_ROUTER_NAME=ziti-edge-router
-#ZITI_ROUTER_ADVERTISED_HOST=ziti-edge-router
+#ZITI_ROUTER_ADVERTISED_ADDRESS=ziti-edge-router
 #ZITI_ROUTER_PORT=8442
 #ZITI_ROUTER_IP_OVERRIDE=10.10.10.10
 #ZITI_ROUTER_LISTENER_BIND_PORT=8444

diff --git a/quickstart/docker/docker-compose.yml b/quickstart/docker/docker-compose.yml
@@ -67,7 +67,7 @@ services:
       - ZITI_CTRL_EDGE_ADVERTISED_ADDRESS=${ZITI_CTRL_EDGE_ADVERTISED_ADDRESS:-ziti-edge-controller}
       - ZITI_CTRL_EDGE_ADVERTISED_PORT=${ZITI_CTRL_EDGE_ADVERTISED_PORT:-1280}
       - ZITI_ROUTER_NAME=${ZITI_ROUTER_NAME:-ziti-edge-router}
-      - ZITI_ROUTER_ADVERTISED_HOST=${ZITI_ROUTER_ADVERTISED_HOST:-ziti-edge-router}
+      - ZITI_ROUTER_ADVERTISED_ADDRESS=${ZITI_ROUTER_ADVERTISED_ADDRESS:-ziti-edge-router}
       - ZITI_ROUTER_PORT=${ZITI_ROUTER_PORT:-3022}
       - ZITI_ROUTER_LISTENER_BIND_PORT=${ZITI_ROUTER_LISTENER_BIND_PORT:-10080}
       - ZITI_ROUTER_ROLES=public
@@ -94,7 +94,7 @@ services:
       - ZITI_CTRL_EDGE_ADVERTISED_ADDRESS=${ZITI_CTRL_EDGE_ADVERTISED_ADDRESS:-ziti-edge-controller}
       - ZITI_CTRL_EDGE_ADVERTISED_PORT=${ZITI_CTRL_EDGE_ADVERTISED_PORT:-1280}
       - ZITI_ROUTER_NAME=${ZITI_ROUTER_NAME:-ziti-edge-router-wss}
-      - ZITI_ROUTER_ADVERTISED_HOST=${ZITI_ROUTER_ADVERTISED_HOST:-ziti-edge-router-wss}
+      - ZITI_ROUTER_ADVERTISED_ADDRESS=${ZITI_ROUTER_ADVERTISED_ADDRESS:-ziti-edge-router-wss}
       - ZITI_ROUTER_PORT=${ZITI_ROUTER_WSS_PORT:-3023}
       - ZITI_ROUTER_LISTENER_BIND_PORT=${ZITI_ROUTER_LISTENER_BIND_PORT:-10081}
       - ZITI_ROUTER_ROLES=public
@@ -120,7 +120,7 @@ services:
       - ZITI_CTRL_EDGE_ADVERTISED_ADDRESS=${ZITI_CTRL_EDGE_ADVERTISED_ADDRESS:-ziti-edge-controller}
       - ZITI_CTRL_EDGE_ADVERTISED_PORT=${ZITI_CTRL_EDGE_ADVERTISED_PORT:-1280}
       - ZITI_ROUTER_NAME=ziti-fabric-router-br
-      - ZITI_ROUTER_ADVERTISED_HOST=ziti-fabric-router-br
+      - ZITI_ROUTER_ADVERTISED_ADDRESS=ziti-fabric-router-br
       - ZITI_ROUTER_ROLES="fabric-only"
     networks:
       - zitiblue
@@ -142,7 +142,7 @@ services:
       - ZITI_CTRL_EDGE_ADVERTISED_ADDRESS=${ZITI_CTRL_EDGE_ADVERTISED_ADDRESS:-ziti-edge-controller}
       - ZITI_CTRL_EDGE_ADVERTISED_PORT=${ZITI_CTRL_EDGE_ADVERTISED_PORT:-1280}
       - ZITI_ROUTER_NAME=ziti-private-red
-      - ZITI_ROUTER_ADVERTISED_HOST=ziti-private-red
+      - ZITI_ROUTER_ADVERTISED_ADDRESS=ziti-private-red
       - ZITI_ROUTER_ROLES=zitired
     networks:
       - zitired
@@ -163,7 +163,7 @@ services:
       - ZITI_CTRL_EDGE_ADVERTISED_ADDRESS=${ZITI_CTRL_EDGE_ADVERTISED_ADDRESS:-ziti-edge-controller}
       - ZITI_CTRL_EDGE_ADVERTISED_PORT=${ZITI_CTRL_EDGE_ADVERTISED_PORT:-1280}
       - ZITI_ROUTER_NAME=ziti-private-blue
-      - ZITI_ROUTER_ADVERTISED_HOST=ziti-private-blue
+      - ZITI_ROUTER_ADVERTISED_ADDRESS=ziti-private-blue
       - ZITI_ROUTER_ROLES=zitiblue
     networks:
       - zitiblue

diff --git a/quickstart/docker/image/ziti-cli-functions.sh b/quickstart/docker/image/ziti-cli-functions.sh
@@ -340,7 +340,7 @@ function setupEnvironment {
   if [[ "${ZITI_ROUTER_NAME-}" == "" ]]; then export ZITI_ROUTER_NAME="${ZITI_NETWORK}-edge-router"; else echo "ZITI_ROUTER_NAME overridden: ${ZITI_ROUTER_NAME}"; fi
   if [[ "${ZITI_ROUTER_PORT-}" == "" ]]; then export ZITI_ROUTER_PORT="3022"; else echo "ZITI_ROUTER_PORT overridden: ${ZITI_ROUTER_PORT}"; fi
   if [[ "${ZITI_ROUTER_LISTENER_BIND_PORT-}" == "" ]]; then export ZITI_ROUTER_LISTENER_BIND_PORT="10080"; else echo "ZITI_ROUTER_LISTENER_BIND_PORT overridden: ${ZITI_ROUTER_LISTENER_BIND_PORT}"; fi
-  if [[ "${EXTERNAL_DNS-}" != "" ]]; then export ZITI_ROUTER_ADVERTISED_HOST="${EXTERNAL_DNS}"; fi
+  if [[ "${EXTERNAL_DNS-}" != "" ]]; then export ZITI_ROUTER_ADVERTISED_ADDRESS="${EXTERNAL_DNS}"; fi
 
   # Set up directories
   mkdir -p "${ZITI_HOME}"

diff --git a/quickstart/docker/simplified-docker-compose.yml b/quickstart/docker/simplified-docker-compose.yml
@@ -59,7 +59,7 @@ services:
       - ZITI_CTRL_EDGE_ADVERTISED_ADDRESS=${ZITI_CTRL_EDGE_ADVERTISED_ADDRESS:-ziti-edge-controller}
       - ZITI_CTRL_EDGE_ADVERTISED_PORT=${ZITI_CTRL_EDGE_ADVERTISED_PORT:-1280}
       - ZITI_ROUTER_NAME=${ZITI_ROUTER_NAME:-ziti-edge-router}
-      - ZITI_ROUTER_ADVERTISED_HOST=${ZITI_ROUTER_ADVERTISED_HOST:-ziti-edge-router}
+      - ZITI_ROUTER_ADVERTISED_ADDRESS=${ZITI_ROUTER_ADVERTISED_ADDRESS:-ziti-edge-router}
       - ZITI_ROUTER_PORT=${ZITI_ROUTER_PORT:-3022}
       - ZITI_ROUTER_LISTENER_BIND_PORT=${ZITI_ROUTER_LISTENER_BIND_PORT:-10080}
       - ZITI_ROUTER_ROLES=public

diff --git a/ziti/cmd/create_config_environment.go b/ziti/cmd/create_config_environment.go
@@ -124,7 +124,7 @@ func NewCmdCreateConfigEnvironment() *cobra.Command {
 				{constants.ZitiRouterIdentityKeyVarName, constants.ZitiRouterIdentityKeyVarDescription, data.Router.IdentityKey},
 				{constants.ZitiRouterIdentityCAVarName, constants.ZitiRouterIdentityCAVarDescription, data.Router.IdentityCA},
 				{constants.ZitiEdgeRouterIPOverrideVarName, constants.ZitiEdgeRouterIPOverrideVarDescription, data.Router.Edge.IPOverride},
-				{constants.ZitiEdgeRouterAdvertisedHostVarName, constants.ZitiEdgeRouterAdvertisedHostVarDescription, data.Router.Edge.AdvertisedHost},
+				{constants.ZitiEdgeRouterAdvertisedAddressVarName, constants.ZitiEdgeRouterAdvertisedAddressVarDescription, data.Router.Edge.AdvertisedHost},
 				{constants.ZitiEdgeRouterCsrCVarName, constants.ZitiEdgeRouterCsrCVarDescription, data.Router.Edge.CsrC},
 				{constants.ZitiEdgeRouterCsrSTVarName, constants.ZitiEdgeRouterCsrSTVarDescription, data.Router.Edge.CsrST},
 				{constants.ZitiEdgeRouterCsrLVarName, constants.ZitiEdgeRouterCsrLVarDescription, data.Router.Edge.CsrL},
@@ -202,7 +202,7 @@ func NewCmdCreateConfigEnvironment() *cobra.Command {
 	sb.WriteString(fmt.Sprintf("%-40s %-50s %s\n", constants.ZitiRouterIdentityKeyVarName, constants.ZitiRouterIdentityKeyVarDescription, data.Router.IdentityKey))
 	sb.WriteString(fmt.Sprintf("%-40s %-50s %s\n", constants.ZitiRouterIdentityCAVarName, constants.ZitiRouterIdentityCAVarDescription, data.Router.IdentityCA))
 	sb.WriteString(fmt.Sprintf("%-40s %-50s %s\n", constants.ZitiEdgeRouterIPOverrideVarName, constants.ZitiEdgeRouterIPOverrideVarDescription, data.Router.Edge.IPOverride))
-	sb.WriteString(fmt.Sprintf("%-40s %-50s %s\n", constants.ZitiEdgeRouterAdvertisedHostVarName, constants.ZitiEdgeRouterAdvertisedHostVarDescription, data.Router.Edge.AdvertisedHost))
+	sb.WriteString(fmt.Sprintf("%-40s %-50s %s\n", constants.ZitiEdgeRouterAdvertisedAddressVarName, constants.ZitiEdgeRouterAdvertisedAddressVarDescription, data.Router.Edge.AdvertisedHost))
 	sb.WriteString(fmt.Sprintf("%-40s %-50s %s\n", constants.ZitiEdgeRouterCsrCVarName, constants.ZitiEdgeRouterCsrCVarDescription, data.Router.Edge.CsrC))
 	sb.WriteString(fmt.Sprintf("%-40s %-50s %s\n", constants.ZitiEdgeRouterCsrSTVarName, constants.ZitiEdgeRouterCsrSTVarDescription, data.Router.Edge.CsrST))
 	sb.WriteString(fmt.Sprintf("%-40s %-50s %s\n", constants.ZitiEdgeRouterCsrLVarName, constants.ZitiEdgeRouterCsrLVarDescription, data.Router.Edge.CsrL))

diff --git a/ziti/cmd/create_config_router_common.go b/ziti/cmd/create_config_router_common.go
@@ -42,10 +42,10 @@ func SetZitiRouterIdentity(r *RouterTemplateValues, routerName string) {
 	}
 
 	// Set advertised host
-	advertisedHost := os.Getenv(constants.ZitiEdgeRouterAdvertisedHostVarName)
+	advertisedAddress := os.Getenv(constants.ZitiEdgeRouterAdvertisedAddressVarName)
 	resolvedHostname, _ := os.Hostname()
-	if advertisedHost != "" {
-		r.Edge.AdvertisedHost = advertisedHost
+	if advertisedAddress != "" {
+		r.Edge.AdvertisedHost = advertisedAddress
 	} else {
 		// If advertised host is not provided, set to IP override, or default to resolved hostname
 		if edgeRouterIPOverride != "" {

diff --git a/ziti/cmd/create_config_router_edge_test.go b/ziti/cmd/create_config_router_edge_test.go
@@ -32,7 +32,7 @@ func TestEdgeRouterAdvertisedAddress(t *testing.T) {
 	require.Equal(t, routerAdvHostIp, data2.Router.Edge.AdvertisedHost, nil)
 
 	// If advertised address set, uses that over IP override or hostname
-	keys["ZITI_ROUTER_ADVERTISED_HOST"] = routerAdvHostDns
+	keys["ZITI_ROUTER_ADVERTISED_ADDRESS"] = routerAdvHostDns
 	keys["ZITI_ROUTER_IP_OVERRIDE"] = routerAdvHostIp
 	_, data3 := createRouterConfig(defaultArgs, routerOpts, keys)
 	require.Equal(t, routerAdvHostDns, data3.Router.Edge.AdvertisedHost, nil)

diff --git a/ziti/cmd/create_config_test.go b/ziti/cmd/create_config_test.go
@@ -60,7 +60,7 @@ func getZitiEnvironmentVariables() []string {
 		"ZITI_ROUTER_IP_OVERRIDE",
 		"ZITI_EDGE_IDENTITY_ENROLLMENT_DURATION",
 		"ZITI_ROUTER_ENROLLMENT_DURATION",
-		"ZITI_ROUTER_ADVERTISED_HOST",
+		"ZITI_ROUTER_ADVERTISED_ADDRESS",
 		"ZITI_ROUTER_LISTENER_BIND_PORT",
 		"ZITI_PKI_ALT_SERVER_CERT",
 		"ZITI_PKI_ALT_SERVER_KEY",

diff --git a/ziti/cmd/helpers/env_helpers.go b/ziti/cmd/helpers/env_helpers.go
@@ -195,7 +195,7 @@ func NormalizePath(input string) string {
 }
 
 func GetRouterAdvertisedAddress() string {
-	return getFromEnv(constants.ZitiEdgeRouterAdvertisedHostVarName, HostnameOrNetworkName)
+	return getFromEnv(constants.ZitiEdgeRouterAdvertisedAddressVarName, HostnameOrNetworkName)
 }
 func GetRouterSans() string {
 	return getFromEnv(constants.ZitiRouterCsrSansDnsVarName, GetRouterAdvertisedAddress)

diff --git a/ziti/constants/constants.go b/ziti/constants/constants.go
@@ -115,8 +115,8 @@ const (
 	ZitiRouterIdentityCAVarDescription               = "Path to Identity CA for Ziti Router"
 	ZitiEdgeRouterIPOverrideVarName                  = "ZITI_ROUTER_IP_OVERRIDE"
 	ZitiEdgeRouterIPOverrideVarDescription           = "Override the default edge router IP with a custom IP, this IP will also be added to the PKI"
-	ZitiEdgeRouterAdvertisedHostVarName              = "ZITI_ROUTER_ADVERTISED_HOST"
-	ZitiEdgeRouterAdvertisedHostVarDescription       = "The advertised host of the router"
+	ZitiEdgeRouterAdvertisedAddressVarName           = "ZITI_ROUTER_ADVERTISED_ADDRESS"
+	ZitiEdgeRouterAdvertisedAddressVarDescription    = "The advertised address of the router"
 	ZitiEdgeRouterListenerBindPortVarName            = "ZITI_ROUTER_LISTENER_BIND_PORT"
 	ZitiEdgeRouterListenerBindPortVarDescription     = "The port a public router will advertise on"
 	ZitiEdgeRouterCsrCVarName                        = "ZITI_ROUTER_CSR_C"
@@ -130,5 +130,5 @@ const (
 	ZitiEdgeRouterCsrOUVarName                       = "ZITI_ROUTER_CSR_OU"
 	ZitiEdgeRouterCsrOUVarDescription                = "The organization unit to use for router CSRs"
 	ZitiRouterCsrSansDnsVarName                      = "ZITI_ROUTER_CSR_SANS_DNS"
-	ZitiRouterCsrSansDnsVarDescription               = "The SANS value to use for the CSR in the internal PKI. If not supplied, defaults to ZITI_ROUTER_ADVERTISED_HOST"
+	ZitiRouterCsrSansDnsVarDescription               = "The SANS value to use for the CSR in the internal PKI. If not supplied, defaults to ZITI_ROUTER_ADVERTISED_ADDRESS"
 )