diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f97a75c5..3b1e84010 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## What's New +### Deprecated Binary Removal This release removes the following deprecated binaries from the release archives. * `ziti-controller` - replaced by `ziti controller` @@ -10,6 +11,62 @@ This release removes the following deprecated binaries from the release archives The release archives now only contain the `ziti` executable. This executable is now at the root of the archive instead of nested under a `ziti` directory. +### Ziti CLI Demo Consolidation + +The ziti CLI functions under `ziti learn`, namely `ziti learn demo` and `ziti learn tutorial` have been consolidated under `ziti demo`. + +### Continued Quickstart Changes + +The quickstart continues to evolve. A breaking change has occurred as numerous environment variables used to customize the quickstart +have changed again. A summary of changes is below + +* All `ZITI_EDGE_ROUTER_` variables have been changed to just `ZITI_ROUTER_`. + * `ZITI_EDGE_ROUTER_NAME` -> `ZITI_ROUTER_NAME` + * `ZITI_EDGE_ROUTER_PORT` -> `ZITI_ROUTER_PORT` + * `ZITI_EDGE_ROUTER_ADVERTISED_HOST` -> `ZITI_ROUTER_ADVERTISED_HOST` + * `ZITI_EDGE_ROUTER_IP_OVERRIDE` -> `ZITI_ROUTER_IP_OVERRIDE` + * `ZITI_EDGE_ROUTER_ENROLLMENT_DURATION` -> `ZITI_ROUTER_ENROLLMENT_DURATION` + * `ZITI_EDGE_ROUTER_ADVERTISED_HOST` -> `ZITI_ROUTER_ADVERTISED_HOST` + * `ZITI_EDGE_ROUTER_LISTENER_BIND_PORT` -> `ZITI_ROUTER_LISTENER_BIND_PORT` +* Additional variables have been added to support "alternative addresses" and "alternative PKI", for example + to support using Let's Encrypt certificates easily in the quickstarts. +* New variables were introduced to allow automatic generation of the `alt_server_certs` section. Both variables + must be supplied for the variables to impact the configurations. + * `ZITI_PKI_ALT_SERVER_CERT` - "Alternative server certificate. Must be specified with ZITI_PKI_ALT_SERVER_KEY" + * `ZITI_PKI_ALT_SERVER_KEY` - "Key to use with the alternative server certificate. Must be specified with ZITI_PKI_ALT_SERVER_CERT" +* New variables were introduced to allow one to override and customize the CSR section of routers which is used during enrollment. + * `ZITI_ROUTER_CSR_C` - "The country (C) to use for router CSRs" + * `ZITI_ROUTER_CSR_ST` - "The state/province (ST) to use for router CSRs" + * `ZITI_ROUTER_CSR_L` - "The locality (L) to use for router CSRs" + * `ZITI_ROUTER_CSR_O` - "The organization (O) to use for router CSRs" + * `ZITI_ROUTER_CSR_OU` - "The organization unit to use for router CSRs" + * `ZITI_ROUTER_CSR_SANS_DNS` - "The DNS name used in the CSR request" +* Net variable `ZITI_CTRL_EDGE_BIND_ADDRESS` allows controlling the IP the edge API uses + + +## Component Updates and Bug Fixes + +* github.com/openziti/channel/v2: [v2.0.81 -> v2.0.84](https://github.com/openziti/channel/compare/v2.0.81...v2.0.84) +* github.com/openziti/edge: [v0.24.348 -> v0.24.364](https://github.com/openziti/edge/compare/v0.24.348...v0.24.364) + * [Issue #1543](https://github.com/openziti/edge/issues/1543) - controller ca normalization can go into infinite loop on startup with bad certs + +* github.com/openziti/edge-api: [v0.25.29 -> v0.25.30](https://github.com/openziti/edge-api/compare/v0.25.29...v0.25.30) +* github.com/openziti/fabric: [v0.23.39 -> v0.23.45](https://github.com/openziti/fabric/compare/v0.23.39...v0.23.45) +* github.com/openziti/foundation/v2: [v2.0.26 -> v2.0.28](https://github.com/openziti/foundation/compare/v2.0.26...v2.0.28) +* github.com/openziti/identity: [v1.0.57 -> v1.0.59](https://github.com/openziti/identity/compare/v1.0.57...v1.0.59) +* github.com/openziti/runzmd: [v1.0.26 -> v1.0.28](https://github.com/openziti/runzmd/compare/v1.0.26...v1.0.28) +* github.com/openziti/sdk-golang: [v0.20.67 -> v0.20.78](https://github.com/openziti/sdk-golang/compare/v0.20.67...v0.20.78) +* github.com/openziti/storage: [v0.2.8 -> v0.2.11](https://github.com/openziti/storage/compare/v0.2.8...v0.2.11) +* github.com/openziti/transport/v2: [v2.0.91 -> v2.0.93](https://github.com/openziti/transport/compare/v2.0.91...v2.0.93) +* github.com/openziti/metrics: [v1.2.27 -> v1.2.30](https://github.com/openziti/metrics/compare/v1.2.27...v1.2.30) +* github.com/openziti/secretstream: [v0.1.9 -> v0.1.10](https://github.com/openziti/secretstream/compare/v0.1.9...v0.1.10) +* github.com/openziti/ziti: [v0.28.4 -> v0.29.0](https://github.com/openziti/ziti/compare/v0.28.4...v0.29.0) + * [Issue #1180](https://github.com/openziti/ziti/issues/1180) - Add ability to debug failed smoketests + * [Issue #1169](https://github.com/openziti/ziti/issues/1169) - Consolidate demo and tutorial under demo + * [Issue #1168](https://github.com/openziti/ziti/issues/1168) - Remove ziti-controller, ziti-router and ziti-tunnel executables from build + * [Issue #1158](https://github.com/openziti/ziti/issues/1158) - Add iperf tests to ziti smoketest + + # Release 0.28.4 ## Component Updates and Bug Fixes diff --git a/ziti/constants/constants.go b/ziti/constants/constants.go index aae90f321..931dee7f4 100644 --- a/ziti/constants/constants.go +++ b/ziti/constants/constants.go @@ -68,13 +68,13 @@ const ( PkiCtrlCAVarName = "ZITI_PKI_CTRL_CA" PkiCtrlCAVarDescription = "Path to Identity CA for Ziti Controller" CtrlBindAddressVarName = "ZITI_CTRL_BIND_ADDRESS" - CtrlBindAddressVarDescription = "The address on which the controller will listen on for control plane connections." + CtrlBindAddressVarDescription = "The address on which the controller will listen on for control plane connections" CtrlAdvertisedAddressVarName = "ZITI_CTRL_ADVERTISED_ADDRESS" CtrlAdvertisedAddressVarDescription = "The address routers will use to connect to the Ziti Controller" CtrlAdvertisedPortVarName = "ZITI_CTRL_ADVERTISED_PORT" CtrlAdvertisedPortVarDescription = "The port routers will use to connect to the Ziti Controller" CtrlEdgeBindAddressVarName = "ZITI_CTRL_EDGE_BIND_ADDRESS" - CtrlEdgeBindAddressVarDescription = "The address on which the edge controller will listen on for API connections." + CtrlEdgeBindAddressVarDescription = "The address on which the edge controller will listen on for API connections" CtrlEdgeAdvertisedAddressVarName = "ZITI_CTRL_EDGE_ADVERTISED_ADDRESS" CtrlEdgeAdvertisedAddressVarDescription = "The publicly addressable controller address value" CtrlEdgeAltAdvertisedAddressVarName = "ZITI_CTRL_EDGE_ALT_ADVERTISED_ADDRESS" @@ -98,9 +98,9 @@ const ( CtrlPkiEdgeCAVarName = "ZITI_PKI_EDGE_CA" CtrlPkiEdgeCAVarDescription = "Path to Identity CA for Ziti Edge Controller" PkiAltServerCertVarName = "ZITI_PKI_ALT_SERVER_CERT" - PkiAltServerCertVarDescription = "Alternative server certificate for the edge controller. Must be specified with ZITI_PKI_ALT_SERVER_KEY" + PkiAltServerCertVarDescription = "Alternative server certificate to use. Must be specified with ZITI_PKI_ALT_SERVER_KEY" PkiAltServerKeyVarName = "ZITI_PKI_ALT_SERVER_KEY" - PkiAltServerKeyVarDescription = "Key to use with the alternative server certificate for the Ziti Edge Controller. Must be specified with ZITI_PKI_ALT_SERVER_CERT" + PkiAltServerKeyVarDescription = "Key to use with the alternative server cert. Must be specified with ZITI_PKI_ALT_SERVER_CERT" ZitiEdgeRouterNameVarName = "ZITI_ROUTER_NAME" ZitiEdgeRouterNameVarDescription = "The Edge Router Name" ZitiEdgeRouterPortVarName = "ZITI_ROUTER_PORT"