Add controller clustering reference documentation #1032
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
dovholuknf
previously approved these changes
Feb 4, 2025
qrkourier
reviewed
Feb 5, 2025
| @@ -164,6 +166,9 @@ Each dialer currently supports a number of [shared options](conventions.md#xgres | |||
| The `edge` section contains configuration that pertain to edge functionality. This section must be | |||
| present to enable edge functionality (e.g. listening for edge SDK connections, tunnel binding modes). | |||
|
|
|||
| - `db` - (optional, `<path-to-config-file>.proto.gzip`) - Configures where the router data model will be snapshotted to | |||
There was a problem hiding this comment.
Suggested change
| - `db` - (optional, `<path-to-config-file>.proto.gzip`) - Configures where the router data model will be snapshotted to | |
| - `db` - (optional, default: `<path-to-config-file>.proto.gzip`) - path to file name where the router data model will be written as a gzipped snapshot |
I'm attempting to clarify between a path to a dir where the snapshot is written vs. a path to a file name
Add controller clustering bootstrapping doc
qrkourier
reviewed
Feb 6, 2025
| would be: | ||
|
|
||
| ``` | ||
| spiffe://example.com/controller/ctrl1 |
There was a problem hiding this comment.
Suggested change
| spiffe://example.com/controller/ctrl1 | |
| spiffe://ziti.example.com/controller/ctrl1 |
for consistency throughout the examples in this doc
| spiffe://<trust domain>/controller/<controller id> | ||
| ``` | ||
|
|
||
| So if your trust domain is `example.com` and your controller id is `ctrl1`, then your SPIFFE id |
There was a problem hiding this comment.
Suggested change
| So if your trust domain is `example.com` and your controller id is `ctrl1`, then your SPIFFE id | |
| So if your trust domain is `ziti.example.com` and your controller id is `ctrl1`, then your SPIFFE id |
|
|
||
| ```yaml | ||
| cluster: | ||
| dataDir: /path/to/data/dir |
There was a problem hiding this comment.
Suggested change
| dataDir: /path/to/data/dir | |
| dataDir: /var/lib/ziti/controller |
Slight preference for FHS in examples, and I'm certain the average reader will do the right thing with an arbitrary example too. ZET also uses /var/lib/ziti.
|
|
||
| ```yaml | ||
| ctrl: | ||
| listener: tls:0.0.0.0:6262 |
There was a problem hiding this comment.
Suggested change
| listener: tls:0.0.0.0:6262 | |
| listener: tls:0.0.0.0:1280 |
consistent ports for ctrl1
| ctrl: | ||
| listener: tls:0.0.0.0:6262 | ||
| options: | ||
| advertiseAddress: tls:ctrl1.ziti.example.com:6262 |
There was a problem hiding this comment.
Suggested change
| advertiseAddress: tls:ctrl1.ziti.example.com:6262 | |
| advertiseAddress: tls:ctrl1.ziti.example.com:1280 |
consistent ports for ctrl1
| ```buttonless title="Output" | ||
| [ 3.323] WARNING ziti/controller/server.(*Controller).checkEdgeInitialized: the | ||
| Ziti Edge has not been initialized, no default admin exists. Add this node to a | ||
| cluster using 'ziti agent cluster add tls:localhost:6262' against an existing |
There was a problem hiding this comment.
Suggested change
| cluster using 'ziti agent cluster add tls:localhost:6262' against an existing | |
| cluster using 'ziti agent cluster add tls:localhost:1280' against an existing |
consistent ports for ctrl1
Add controller clustering operations page.
qrkourier
previously approved these changes
Feb 6, 2025
Add controller cluster data model page
Add controller clustering migration doc
Add Controller HA reference material. Fixes #929
plorenz
changed the title
dovholuknf
approved these changes
Feb 7, 2025
qrkourier
reviewed
Feb 7, 2025
|
|
||
| #### Location | ||
|
|
||
| By defaul the endpoints file will be named `endpoints` and will be placed |
There was a problem hiding this comment.
Suggested change
| By defaul the endpoints file will be named `endpoints` and will be placed | |
| By default, the endpoints file will be named `endpoints` and will be placed |
| By defaul the endpoints file will be named `endpoints` and will be placed | ||
| in the same directory as the router config file. | ||
|
|
||
| However, the file can be customized using a config file settings. |
There was a problem hiding this comment.
Suggested change
| However, the file can be customized using a config file settings. | |
| Customize the path of the endpoints file in the config file. |
|
|
||
| # Controller Topology | ||
|
|
||
| his document discusses cluster size and member placement. |
There was a problem hiding this comment.
Suggested change
| his document discusses cluster size and member placement. | |
| This document discusses cluster size and member placement. |
|
|
||
| The functionality that controllers provide to clients doesn't require any specific number of controllers. | ||
| A network manager will want to scale the number controllers based on client demand and may want to | ||
| place additional controllers geographically close to clusters of clients for better performance. |
There was a problem hiding this comment.
Suggested change
| place additional controllers geographically close to clusters of clients for better performance. | |
| place additional controllers geographically close to clients for better performance. |
Possibly confusing to imply that clients have clusters in the same sense as controllers
|
|
||
| **Requirements** | ||
|
|
||
| 1. The network should be able to withstand the loss of one voting member |
There was a problem hiding this comment.
Suggested change
| 1. The network should be able to withstand the loss of one voting member | |
| 1. The network should be able to withstand the loss of one voting member. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.