mirror of
https://github.com/openziti/ziti.git
synced 2026-10-11 15:10:59 +00:00
Andrew Martinez
113 lines
3.5 KiB
Markdown
113 lines
3.5 KiB
Markdown
# HA Setup for Development
|
|
|
|
**NOTE: HA is in alpha. Expect bugs. Bug reports are appreciated**
|
|
|
|
To set up a local three node HA cluster, do the following.
|
|
|
|
## Create The Necessary PKI
|
|
|
|
Either run the `create-pki.sh` script found in the folder, or follow the steps in
|
|
the [HA PKI Guide](./dev-setup-ha-pki.md)
|
|
|
|
## Running the Controllers
|
|
|
|
1. The controller configuration files have relative paths, so make sure you're running things from
|
|
this directory.
|
|
2. Start all three controllers
|
|
1. `ziti controller run ctrl1.yml`
|
|
2. `ziti controller run ctrl2.yml`
|
|
3. `ziti controller run ctrl3.yml`
|
|
4. All three are configured with `minClusterSize` of 3, so they will wait to be joined to a raft
|
|
cluster
|
|
5. The ctrl1.yml config file has the other two controllers as bootstrap members, so when it
|
|
starts the first controller will start trying form the raft cluster.
|
|
3. Initialize the edge using the agent
|
|
1. `ziti agent controller init -p <pid of any controller> admin admin 'Default Admin'`
|
|
2. You can of course use different values if you desire
|
|
|
|
You should now have a three node cluster running. You can log into each controller individually.
|
|
|
|
1. `ziti edge login localhost:1280`
|
|
2. `ziti edge -i ctrl2 login localhost:1380`
|
|
3. `ziti edge -i ctrl3 login localhost:1480`
|
|
|
|
You could then create some model data on any controller:
|
|
|
|
```
|
|
# This will create the client side identity and policies
|
|
ziti demo setup echo client
|
|
|
|
# This will create the server side identity and policies
|
|
ziti demo setup echo single-sdk-hosted
|
|
```
|
|
|
|
Any view the results on any controller
|
|
|
|
```
|
|
ziti edge login localhost:1280
|
|
ziti edge ls services
|
|
|
|
ziti edge login -i ctrl2 localhost:1380
|
|
ziti edge -i ctrl2 ls services
|
|
|
|
ziti edge login -i ctrl3 localhost:1480
|
|
ziti edge -i ctrl3 ls services
|
|
```
|
|
|
|
## Running HA Go SDKs & Edge Routers (Temp Feature Flags)
|
|
|
|
Both the Go SDK and Edge Routers have temporary feature flags gating HA support. To use either with HA deployed
|
|
controllers they must be configured to detect the HA status of the network as well as associated capabilities that
|
|
will exist in non-HA deployments.
|
|
|
|
These feature flags exist to prevent background processing in controllers, routers, and SDKs from impacting existing
|
|
networks. Some of these features enable HA, but also provide benefits for improvements that may be delivered before
|
|
a general HA release.
|
|
|
|
### Edge Routers
|
|
|
|
Edge Router configuration files must be augmented to have a top level field `ha` with a subfield of `enabled` set
|
|
to `true`.
|
|
|
|
```
|
|
ha:
|
|
enabled: true
|
|
```
|
|
|
|
### Go SDK
|
|
|
|
The Go SDK can be configured either through code or a file. If using a file, edit the file to have the field `enableHa`
|
|
set to `true`.
|
|
|
|
#### Example (file):
|
|
|
|
```
|
|
{
|
|
"ztAPI": "https://127.0.0.1:1280/edge/client/v1",
|
|
"ztAPIs": null,
|
|
"configTypes": [
|
|
"test-config-1"
|
|
],
|
|
"id": {
|
|
"key": "pem:-----BEGIN RSA PRIVATE KEY-----\nMI...0=\n-----END RSA PRIVATE KEY-----\n",
|
|
"cert": "pem:-----BEGIN CERTIFICATE-----\nMI...g==\n-----END CERTIFICATE-----\n",
|
|
"ca": "pem:-----BEGIN CERTIFICATE-----\nMI...=\n-----END CERTIFICATE-----\n"
|
|
},
|
|
"enableHa": true
|
|
}
|
|
```
|
|
|
|
Within an SDK configuration ensure the field `EnableHA` is included and set to `true`
|
|
|
|
#### Example (go code):
|
|
```
|
|
idConfig := &identity.Config{
|
|
// ...config
|
|
}
|
|
|
|
ztxCfg := ziti.NewConfig("https://localhost:1280", idConfig)
|
|
ztxCfg.EnableHa = true
|
|
ztx, _ := ziti.NewContext(ztxCfg)
|
|
```
|
|
Enabling HA support allows routers to detect
|
|
controller support for a distributed data model that is synchronized with the control plan. |