Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

de-hyphenate old mentions of ziti-router as 'ziti router' #1968

Merged
merged 4 commits into from
Apr 30, 2024
Merged

de-hyphenate old mentions of ziti-router as 'ziti router' #1968

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
57f95d6
de-hyphenate old mentions of ziti-router as 'ziti router'
qrkourier Apr 22, 2024
23651ca
revert typos
qrkourier Apr 22, 2024
1a57b62
fix typo
qrkourier Apr 22, 2024
8e5afa2
de-hyphenate more ziti-router recurrences
qrkourier Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/001-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ connectivity, and endpoint enrollment.

## Ziti Router

The Ziti Router binary (ziti-router) is deployed multiple times to stand up multiple ingress and egress
points for a Ziti overlay network. Each router has its own identity and must be enrolled with the controller.
A Ziti environment requires one or more routers.
The Ziti Router is deployed multiple times to stand up multiple ingress and egress points for a Ziti overlay network.
Each router has its own identity and must be enrolled with the controller. A Ziti environment requires one or more
routers.

If the Ziti Edge features are enabled, routers may optionally be enrolled as an "edge router". Edge routers allow Ziti
SDK enabled applications, Ziti Applications, to access services or host services that have been configured within Ziti
as overlay services.
If the Ziti Edge features are enabled, routers may optionally be enrolled as an "edge router". Edge routers allow Ziti
SDK enabled applications, Ziti Applications, to access services or host services that have been configured within Ziti
as overlay services.

## Ziti Applications

Expand Down
4 changes: 2 additions & 2 deletions doc/transwarp_b1/transwarp_b1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ The metrics instrument (and the other `dilithium` instruments) can be used with

This example will be configured similarly to the pure Dilithium example above. There are two routers, each in an AWS VPC in different regions separated by geography. One of the routers provides a link listener, configured to use `transwarptls:`.

Here's the relevant logging output from the `ziti-router` process:
Here's the relevant logging output from the `ziti router` process:

```
[ 0.002] INFO foundation/transport/transwarptls.Listen: westworld3 profile = [
Expand Down Expand Up @@ -512,7 +512,7 @@ Here's the relevant logging output from the `ziti-router` process:
[ 0.002] INFO fabric/router.(*Router).startXlinkListeners: started Xlink listener with binding [transport] advertising [transwarptls:54.167.243.24:6000]
```

Here's the relevant log output when starting the second `ziti-router`, configured without a link listener. This output represents it dialing the `transwarptls:` link connection to the first router:
Here's the relevant log output when starting the second `ziti router`, configured without a link listener. This output represents it dialing the `transwarptls:` link connection to the first router:

```
[ 0.630] INFO fabric/router/handler_ctrl.(*dialHandler).handle: received link connect request
Expand Down
4 changes: 2 additions & 2 deletions etc/edge.router.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ v: 3
#
# The 'cert', 'server_cert', and 'ca' files will be overwritten with the results of the enrollment process.
#
# When running the ziti-router the files/values in this section will be read and used. The 'cert' value will be used
# When running the ziti router the files/values in this section will be read and used. The 'cert' value will be used
# as the client certificate to connect to the controller. The 'server_cert' is used for all servers/listeners. The
# 'ca' value is used to populate an internally Trusted CA pool.
identity:
Expand Down Expand Up @@ -56,7 +56,7 @@ metrics:
reportInterval: 15s
messageQueueSize: 10

# By having an 'edge' section defined, the ziti-router will attempt to parse the edge configuration. Removing this
# By having an 'edge' section defined, the ziti router will attempt to parse the edge configuration. Removing this
# section, commenting out, or altering the name of the section will cause the router to no longer operate as an Edge
# Router.
edge:
Expand Down
4 changes: 2 additions & 2 deletions etc/edge.router_wss.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ v: 3
#
# The 'cert', 'server_cert', and 'ca' files will be overwritten with the results of the enrollment process.
#
# When running the ziti-router the files/values in this section will be read and used. The 'cert' value will be used
# When running the ziti router the files/values in this section will be read and used. The 'cert' value will be used
# as the client certificate to connect to the controller. The 'server_cert' is used for all servers/listeners. The
# 'ca' value is used to populate an internally Trusted CA pool.
identity:
Expand All @@ -36,7 +36,7 @@ link:
dialers:
- binding: transport

# By having an 'edge' section defined, the ziti-router will attempt to parse the edge configuration. Removing this
# By having an 'edge' section defined, the ziti router will attempt to parse the edge configuration. Removing this
# section, commenting out, or altering the name of the section will cause the router to no longer operate as an Edge
# Router.
edge:
Expand Down
4 changes: 2 additions & 2 deletions etc/tmpl/edge.router.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ v: 3
#
# The 'cert', 'server_cert', and 'ca' files will be overwritten with the results of the enrollment process.
#
# When running the ziti-router the files/values in this section will be read and used. The 'cert' value will be used
# When running the ziti router the files/values in this section will be read and used. The 'cert' value will be used
# as the client certificate to connect to the controller. The 'server_cert' is used for all servers/listeners. The
# 'ca' value is used to populate an internally Trusted CA pool.
identity:
Expand Down Expand Up @@ -45,7 +45,7 @@ link:
advertise: tls:127.0.0.1:${LINK_LISTENER_PORT}


# By having an 'edge' section defined, the ziti-router will attempt to parse the edge configuration. Removing this
# By having an 'edge' section defined, the ziti router will attempt to parse the edge configuration. Removing this
# section, commenting out, or altering the name of the section will cause the router to no longer operate as an Edge
# Router.
edge:
Expand Down
5 changes: 2 additions & 3 deletions quickstart/docker/image/run-router-external.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,10 @@ if [ ! -f ${ZITI_ROUTER_ADVERTISED_ADDRESS}.jwt ]; then
"${ZITI_BIN_DIR}/ziti" edge create edge-router "${ZITI_ROUTER_ADVERTISED_ADDRESS}" -o "${ZITI_HOME}/${ZITI_ROUTER_ADVERTISED_ADDRESS}.jwt" -t -a "${ZITI_ROUTER_ROLES}"
sleep 1
echo "---------- Enrolling edge-router ${ZITI_ROUTER_ADVERTISED_ADDRESS}...."
"${ZITI_BIN_DIR}/ziti-router" enroll "${ZITI_HOME}/${ZITI_ROUTER_ADVERTISED_ADDRESS}.yaml" --jwt "${ZITI_HOME}/${ZITI_ROUTER_ADVERTISED_ADDRESS}.jwt"
"${ZITI_BIN_DIR}/ziti" router enroll "${ZITI_HOME}/${ZITI_ROUTER_ADVERTISED_ADDRESS}.yaml" --jwt "${ZITI_HOME}/${ZITI_ROUTER_ADVERTISED_ADDRESS}.jwt"
echo ""
fi
fi

# Run the router
"${ZITI_BIN_DIR}/ziti-router" run "${ZITI_HOME}/${ZITI_ROUTER_ADVERTISED_ADDRESS}.yaml" > "${ZITI_HOME}/ziti-${ZITI_ROUTER_ADVERTISED_ADDRESS}.log"

"${ZITI_BIN_DIR}/ziti" router run "${ZITI_HOME}/${ZITI_ROUTER_ADVERTISED_ADDRESS}.yaml" > "${ZITI_HOME}/ziti-${ZITI_ROUTER_ADVERTISED_ADDRESS}.log"
4 changes: 2 additions & 2 deletions tests/ats-edge-tunneler.router.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ v: 3
#
# The 'cert', 'server_cert', and 'ca' files will be overwritten with the results of the enrollment process.
#
# When running the ziti-router the files/values in this section will be read and used. The 'cert' value will be used
# When running the ziti router the files/values in this section will be read and used. The 'cert' value will be used
# as the client certificate to connect to the controller. The 'server_cert' is used for all servers/listeners. The
# 'ca' value is used to populate an internally Trusted CA pool.
identity:
Expand All @@ -32,7 +32,7 @@ identity:
ctrl:
endpoint: tls:127.0.0.1:6262

# By having an 'edge' section defined, the ziti-router will attempt to parse the edge configuration. Removing this
# By having an 'edge' section defined, the ziti router will attempt to parse the edge configuration. Removing this
# section, commenting out, or altering the name of the section will cause the router to no longer operate as an Edge
# Router.
edge:
Expand Down
4 changes: 2 additions & 2 deletions tests/ats-edge.router.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ v: 3
#
# The 'cert', 'server_cert', and 'ca' files will be overwritten with the results of the enrollment process.
#
# When running the ziti-router the files/values in this section will be read and used. The 'cert' value will be used
# When running the ziti router the files/values in this section will be read and used. The 'cert' value will be used
# as the client certificate to connect to the controller. The 'server_cert' is used for all servers/listeners. The
# 'ca' value is used to populate an internally Trusted CA pool.
identity:
Expand All @@ -32,7 +32,7 @@ identity:
ctrl:
endpoint: tls:127.0.0.1:6262

# By having an 'edge' section defined, the ziti-router will attempt to parse the edge configuration. Removing this
# By having an 'edge' section defined, the ziti router will attempt to parse the edge configuration. Removing this
# section, commenting out, or altering the name of the section will cause the router to no longer operate as an Edge
# Router.
edge:
Expand Down
2 changes: 1 addition & 1 deletion tests/ats-transit.router.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ v: 3
#
# The 'cert', 'server_cert', and 'ca' files will be overwritten with the results of the enrollment process.
#
# When running the ziti-router the files/values in this section will be read and used. The 'cert' value will be used
# When running the ziti router the files/values in this section will be read and used. The 'cert' value will be used
# as the client certificate to connect to the controller. The 'server_cert' is used for all servers/listeners. The
# 'ca' value is used to populate an internally Trusted CA pool.
identity:
Expand Down
2 changes: 1 addition & 1 deletion tests/testdata/config/router-1.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ v: 3
#
# The 'cert', 'server_cert', and 'ca' files will be overwritten with the results of the enrollment process.
#
# When running the ziti-router the files/values in this section will be read and used. The 'cert' value will be used
# When running the ziti router the files/values in this section will be read and used. The 'cert' value will be used
# as the client certificate to connect to the controller. The 'server_cert' is used for all servers/listeners. The
# 'ca' value is used to populate an internally Trusted CA pool.
identity:
Expand Down
2 changes: 1 addition & 1 deletion tests/testdata/config/router-2.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ v: 3
#
# The 'cert', 'server_cert', and 'ca' files will be overwritten with the results of the enrollment process.
#
# When running the ziti-router the files/values in this section will be read and used. The 'cert' value will be used
# When running the ziti router the files/values in this section will be read and used. The 'cert' value will be used
# as the client certificate to connect to the controller. The 'server_cert' is used for all servers/listeners. The
# 'ca' value is used to populate an internally Trusted CA pool.
identity:
Expand Down
2 changes: 1 addition & 1 deletion ziti/cmd/agentcli/agent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ func NewAgentCmd(p common.OptionsProvider) *cobra.Command {
routerCmd := &cobra.Command{
Use: "router",
Aliases: []string{"r"},
Short: "Interact with a ziti-router process using the IPC agent",
Short: "Interact with a ziti router process using the IPC agent",
Run: func(cmd *cobra.Command, args []string) {
cmdhelper.CheckErr(cmd.Help())
},
Expand Down
6 changes: 3 additions & 3 deletions ziti/router/run.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,13 @@ func run(cmd *cobra.Command, args []string) {

config, err := router.LoadConfig(args[0])
if err != nil {
startLogger.WithError(err).Error("error loading ziti-router config")
startLogger.WithError(err).Error("error loading ziti router config")
panic(err)
}
config.SetFlags(getFlags(cmd))

startLogger = startLogger.WithField("routerId", config.Id.Token)
startLogger.Info("starting ziti-router")
startLogger.Info("starting ziti router")

r := router.Create(config, version.GetCmdBuildInfo())

Expand Down Expand Up @@ -141,7 +141,7 @@ func waitForShutdown(r *router.Router) {
fmt.Println("=== STACK DUMP CLOSE ===")
}

pfxlog.Logger().Info("shutting down ziti-router")
pfxlog.Logger().Info("shutting down ziti router")

if err := r.Shutdown(); err != nil {
pfxlog.Logger().WithError(err).Info("error encountered during shutdown")
Expand Down
2 changes: 1 addition & 1 deletion zititest/models/db-creation/configs/router.yml.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ listeners:
# (required) The public hostname and port combination that Ziti SDKs should connect on. Previously this was in the chanIngress section.
advertise: {{ .Host.PublicIp }}:6262

# By having an 'edge' section defined, the ziti-router will attempt to parse the edge configuration. Removing this
# By having an 'edge' section defined, the ziti router will attempt to parse the edge configuration. Removing this
# section, commenting out, or altering the name of the section will cause the router to no longer operate as an Edge
# Router.
edge:
Expand Down
2 changes: 1 addition & 1 deletion zititest/models/db-ctrl-test/configs/router.yml.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ listeners:
# (required) The public hostname and port combination that Ziti SDKs should connect on. Previously this was in the chanIngress section.
advertise: {{ .Host.PublicIp }}:62{{printf "%02d" .Component.ScaleIndex }}

# By having an 'edge' section defined, the ziti-router will attempt to parse the edge configuration. Removing this
# By having an 'edge' section defined, the ziti router will attempt to parse the edge configuration. Removing this
# section, commenting out, or altering the name of the section will cause the router to no longer operate as an Edge
# Router.
edge:
Expand Down
2 changes: 1 addition & 1 deletion zititest/models/db-sdk-hosting-test/configs/router.yml.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ listeners:
# (required) The public hostname and port combination that Ziti SDKs should connect on. Previously this was in the chanIngress section.
advertise: {{ .Host.PublicIp }}:6262

# By having an 'edge' section defined, the ziti-router will attempt to parse the edge configuration. Removing this
# By having an 'edge' section defined, the ziti router will attempt to parse the edge configuration. Removing this
# section, commenting out, or altering the name of the section will cause the router to no longer operate as an Edge
# Router.
edge:
Expand Down
2 changes: 1 addition & 1 deletion zititest/models/links-test/configs/router.yml.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ listeners:
# (required) The public hostname and port combination that Ziti SDKs should connect on. Previously this was in the chanIngress section.
advertise: {{ .Host.PublicIp }}:62{{printf "%02d" .Component.ScaleIndex }}

# By having an 'edge' section defined, the ziti-router will attempt to parse the edge configuration. Removing this
# By having an 'edge' section defined, the ziti router will attempt to parse the edge configuration. Removing this
# section, commenting out, or altering the name of the section will cause the router to no longer operate as an Edge
# Router.
edge:
Expand Down
2 changes: 1 addition & 1 deletion zititest/models/router-test/configs/router.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
# (required) The public hostname and port combination that Ziti SDKs should connect on. Previously this was in the chanIngress section.
advertise: {{.Host.PublicIp}}:6262

# By having an 'edge' section defined, the ziti-router will attempt to parse the edge configuration. Removing this
# By having an 'edge' section defined, the ziti router will attempt to parse the edge configuration. Removing this
# section, commenting out, or altering the name of the section will cause the router to no longer operate as an Edge
# Router.
edge:
Expand Down
2 changes: 1 addition & 1 deletion zititest/models/sdk-hosting-test/configs/router.yml.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ listeners:
# (required) The public hostname and port combination that Ziti SDKs should connect on. Previously this was in the chanIngress section.
advertise: {{ .Host.PublicIp }}:6262

# By having an 'edge' section defined, the ziti-router will attempt to parse the edge configuration. Removing this
# By having an 'edge' section defined, the ziti router will attempt to parse the edge configuration. Removing this
# section, commenting out, or altering the name of the section will cause the router to no longer operate as an Edge
# Router.
edge:
Expand Down
2 changes: 1 addition & 1 deletion zititest/models/smoke/configs/router.yml.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ listeners:
# (required) The public hostname and port combination that Ziti SDKs should connect on. Previously this was in the chanIngress section.
advertise: {{ .Host.PublicIp }}:6262

# By having an 'edge' section defined, the ziti-router will attempt to parse the edge configuration. Removing this
# By having an 'edge' section defined, the ziti router will attempt to parse the edge configuration. Removing this
# section, commenting out, or altering the name of the section will cause the router to no longer operate as an Edge
# Router.
edge:
Expand Down
2 changes: 1 addition & 1 deletion zititest/models/stall/configs/router.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ listeners:
# (required) The public hostname and port combination that Ziti SDKs should connect on. Previously this was in the chanIngress section.
advertise: {{ .Host.PublicIp }}:6262

# By having an 'edge' section defined, the ziti-router will attempt to parse the edge configuration. Removing this
# By having an 'edge' section defined, the ziti router will attempt to parse the edge configuration. Removing this
# section, commenting out, or altering the name of the section will cause the router to no longer operate as an Edge
# Router.
edge:
Expand Down
2 changes: 1 addition & 1 deletion zititest/models/zrok-test/configs/router.yml.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ listeners:
# (required) The public hostname and port combination that Ziti SDKs should connect on. Previously this was in the chanIngress section.
advertise: {{ .Host.PublicIp }}:62{{printf "%02d" .Component.ScaleIndex }}

# By having an 'edge' section defined, the ziti-router will attempt to parse the edge configuration. Removing this
# By having an 'edge' section defined, the ziti router will attempt to parse the edge configuration. Removing this
# section, commenting out, or altering the name of the section will cause the router to no longer operate as an Edge
# Router.
edge:
Expand Down