From 6206dd2f7d4bbfc90fef2ca057a6c33bbcb48783 Mon Sep 17 00:00:00 2001 From: Kenneth Bingham Date: Mon, 25 Mar 2024 11:11:12 -0400 Subject: [PATCH] improve config generator var descriptions --- ziti/constants/constants.go | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/ziti/constants/constants.go b/ziti/constants/constants.go index 4dab1ca91..e433ea825 100644 --- a/ziti/constants/constants.go +++ b/ziti/constants/constants.go @@ -74,21 +74,21 @@ const ( PkiCtrlCAVarName = "ZITI_PKI_CTRL_CA" PkiCtrlCAVarDescription = "Path to the controller's bundle of trusted root CAs" CtrlBindAddressVarName = "ZITI_CTRL_BIND_ADDRESS" - CtrlBindAddressVarDescription = "The address on which the controller will listen on for router control plane connections" + CtrlBindAddressVarDescription = "The address where the controller will listen for router control plane connections" CtrlAdvertisedAddressVarName = "ZITI_CTRL_ADVERTISED_ADDRESS" CtrlAdvertisedAddressVarDescription = "The address routers will use to connect to the controller" CtrlAdvertisedPortVarName = "ZITI_CTRL_ADVERTISED_PORT" - CtrlAdvertisedPortVarDescription = "The port routers will use to connect to the controller" + CtrlAdvertisedPortVarDescription = "TCP port routers will use to connect to the controller" CtrlEdgeBindAddressVarName = "ZITI_CTRL_EDGE_BIND_ADDRESS" - CtrlEdgeBindAddressVarDescription = "The address on which the controller will listen on for API connections" + CtrlEdgeBindAddressVarDescription = "The address where the controller will listen for edge API connections" CtrlEdgeAdvertisedAddressVarName = "ZITI_CTRL_EDGE_ADVERTISED_ADDRESS" - CtrlEdgeAdvertisedAddressVarDescription = "The publicly addressable controller address value" + CtrlEdgeAdvertisedAddressVarDescription = "The controller's edge API address; defaults to ZITI_CTRL_ADVERTISED_ADDRESS" CtrlEdgeAltAdvertisedAddressVarName = "ZITI_CTRL_EDGE_ALT_ADVERTISED_ADDRESS" - CtrlEdgeAltAdvertisedAddressVarDescription = "The publicly addressable, alternative controller address value. Overrides ZITI_CTRL_EDGE_ADVERTISED_ADDRESS" + CtrlEdgeAltAdvertisedAddressVarDescription = "The controller's edge API alternative address; defaults ZITI_CTRL_EDGE_ADVERTISED_ADDRESS" CtrlEdgeAdvertisedPortVarName = "ZITI_CTRL_EDGE_ADVERTISED_PORT" - CtrlEdgeAdvertisedPortVarDescription = "The publicly addressable controller port value" + CtrlEdgeAdvertisedPortVarDescription = "TCP port of the controller's edge API" CtrlDatabaseFileVarName = "ZITI_CTRL_DATABASE_FILE" - CtrlDatabaseFileVarDescription = "Path to the controller database file" + CtrlDatabaseFileVarDescription = "Path to the controller's database file" PkiSignerCertVarName = "ZITI_PKI_SIGNER_CERT" PkiSignerCertVarDescription = "Path to the controller's edge signer CA cert" PkiSignerKeyVarName = "ZITI_PKI_SIGNER_KEY" @@ -106,27 +106,27 @@ const ( CtrlPkiEdgeCAVarName = "ZITI_PKI_EDGE_CA" CtrlPkiEdgeCAVarDescription = "Path to the controller's web identity root CA cert" PkiAltServerCertVarName = "ZITI_PKI_ALT_SERVER_CERT" - PkiAltServerCertVarDescription = "Path to the controller's root identity alternative server certificate. Requires ZITI_PKI_ALT_SERVER_KEY" + PkiAltServerCertVarDescription = "Path to the controller's root identity alternative server certificate; requires ZITI_PKI_ALT_SERVER_KEY" PkiAltServerKeyVarName = "ZITI_PKI_ALT_SERVER_KEY" PkiAltServerKeyVarDescription = "Path to the controller's root identity alternative private key. Requires ZITI_PKI_ALT_SERVER_CERT" ZitiEdgeRouterNameVarName = "ZITI_ROUTER_NAME" - ZitiEdgeRouterNameVarDescription = "A filename prefix for the router's key and certs" + ZitiEdgeRouterNameVarDescription = "A filename prefix for the router's key and certs; overriden by ziti create config --routerName" ZitiEdgeRouterPortVarName = "ZITI_ROUTER_PORT" - ZitiEdgeRouterPortVarDescription = "TCP port on which the router will listen for edge connections" + ZitiEdgeRouterPortVarDescription = "TCP port where the router listens for edge connections from endpoints" ZitiRouterIdentityCertVarName = "ZITI_ROUTER_IDENTITY_CERT" - ZitiRouterIdentityCertVarDescription = "Path in which to write the router's client certificate during enrollment" + ZitiRouterIdentityCertVarDescription = "Path to the router's client certificate" ZitiRouterIdentityServerCertVarName = "ZITI_ROUTER_IDENTITY_SERVER_CERT" - ZitiRouterIdentityServerCertVarDescription = "Path in which to write the router's server certificate during enrollment" + ZitiRouterIdentityServerCertVarDescription = "Path to the router's server certificate" ZitiRouterIdentityKeyVarName = "ZITI_ROUTER_IDENTITY_KEY" - ZitiRouterIdentityKeyVarDescription = "Path to generate the router's private key unless it exists" + ZitiRouterIdentityKeyVarDescription = "Path to the router's private key" ZitiRouterIdentityCAVarName = "ZITI_ROUTER_IDENTITY_CA" - ZitiRouterIdentityCAVarDescription = "Path to write the router's bundle of trusted root CA certs during enrollment" + ZitiRouterIdentityCAVarDescription = "Path to the router's bundle of trusted root CA certs" 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" + ZitiEdgeRouterIPOverrideVarDescription = "Additional IP SAN of the router; defaults to ZITI_ROUTER_ADVERTISED_ADDRESS" ZitiEdgeRouterAdvertisedAddressVarName = "ZITI_ROUTER_ADVERTISED_ADDRESS" - ZitiEdgeRouterAdvertisedAddressVarDescription = "The advertised address of the router" + ZitiEdgeRouterAdvertisedAddressVarDescription = "The router's advertised address and DNS SAN" ZitiEdgeRouterListenerBindPortVarName = "ZITI_ROUTER_LISTENER_BIND_PORT" - ZitiEdgeRouterListenerBindPortVarDescription = "The port a public router will advertise on" + ZitiEdgeRouterListenerBindPortVarDescription = "TCP port where the router will listen for and advertise links to other routers; defaults to ZITI_ROUTER_PORT" ZitiEdgeRouterResolverVarName = "ZITI_ROUTER_TPROXY_RESOLVER" ZitiEdgeRouterResolverVarDescription = "The bind URI to listen for DNS requests in tproxy mode" ZitiEdgeRouterDnsSvcIpRangeVarName = "ZITI_ROUTER_DNS_IP_RANGE" @@ -142,5 +142,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_ADDRESS" + ZitiRouterCsrSansDnsVarDescription = "Additional DNS SAN of the router; defaults to ZITI_ROUTER_ADVERTISED_ADDRESS" )