Merge pull request #297 from openziti/v0.4-update_self_hosting_guide

mention router config stanza order
This commit is contained in:
Ken Bingham 2023-04-12 14:32:54 -04:00 committed by GitHub
commit 4a2b69c1f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 3 deletions

View File

@ -30,7 +30,7 @@ events:
You'll want to adjust the `events/jsonLogger/handler/path` to wherever you would like to send these events for ingestion into `zrok`. There are additional OpenZiti options that control file rotation. Be sure to consult the OpenZiti docs to tune these settings to be appropriate for your environment.
By default the OpenZiti events infrastructure reports and batches events in 1 minute buckets. 1 minute is too large of an interval to provide a snappy `zrok` metrics experience. So, let's increase the frequency to every 5 seconds. Add this to the `network` stanza of your OpenZiti controller:
By default, the OpenZiti events infrastructure reports and batches events in 1 minute buckets. 1 minute is too large of an interval to provide a snappy `zrok` metrics experience. So, let's increase the frequency to every 5 seconds. Add this to the `network` stanza of your OpenZiti controller's configuration:
```yaml
network:
@ -38,9 +38,10 @@ network:
metricsReportInterval: 5s
```
And you'll want to add this stanza to the router configuration for every router on your OpenZiti network:
And you'll want to add this stanza to the tail-end of the router configuration for every router on your OpenZiti network:
```yaml
# this must be the last router configuration stanza
metrics:
reportInterval: 5s
intervalAgeThreshold: 5s

View File

@ -47,7 +47,7 @@ endpoint:
#
email:
host: smtp.server.com
port: 587
port: 587 # this must be a STARTTLS port, not the TLS port (465)
username: ""
password: ""
from: ziggy@zrok.io