Unverified Commit e49bd2e3 authored by Drew Bailey's avatar Drew Bailey Committed by GitHub
Browse files

Events/docs (#9100)


* /v1/event/stream docs

* events sidebar

* wip server config

* make ids match

* fix typo

* add server config opts

* Update website/pages/api-docs/events.mdx
Co-authored-by: default avatarSeth Hoenig <shoenig@hashicorp.com>

* Update website/pages/api-docs/events.mdx
Co-authored-by: default avatarSeth Hoenig <shoenig@hashicorp.com>

* address feedback
Co-authored-by: default avatarSeth Hoenig <shoenig@hashicorp.com>
parent 2b11e52f
Showing with 643 additions and 0 deletions
+643 -0
......@@ -18,6 +18,7 @@ export default [
'client',
'deployments',
'evaluations',
'events',
'jobs',
'namespaces',
'nodes',
......
This diff is collapsed.
......@@ -54,6 +54,9 @@ server {
this server will handle. This can be used to restrict the evaluations that
worker threads will dequeue for processing.
- `enable_event_broker` `(bool: true)` - Specifies if this server will generate
events for its event stream.
- `encrypt` `(string: "")` - Specifies the secret key to use for encryption of
Nomad server's gossip network traffic. This key must be 32 bytes that are
base64-encoded. The provided key is automatically persisted to the data
......@@ -65,6 +68,11 @@ server {
[encryption documentation][encryption] for more details on this option
and its impact on the cluster.
- `event_buffer_size` `(int: 100)` - Specifies the number of events generated
by the server to be held in memory. Increasing this value enables new
subscribers to have a larger look back window when initially subscribing.
Decreasing will lower the amount of memory used for the event buffer.
- `node_gc_threshold` `(string: "24h")` - Specifies how long a node must be in a
terminal state before it is garbage collected and purged from the system. This
is specified using a label suffix like "30s" or "1h".
......@@ -90,6 +98,14 @@ server {
deployment must be in the terminal state before it is eligible for garbage
collection. This is specified using a label suffix like "30s" or "1h".
- `durable_event_count` `(int: 100)` - Specifies the number of events to
persist during snapshot generation. This provides a given server's event
stream durability during restarts by persiting a backlog of events to be
repopulated when the server comes back online. Increasing this value provides
a greater history of messages when a server comes online. Decreasing this
value reduces the history of messages but uses less disk i/o during
snapshot creation.
- `csi_volume_claim_gc_threshold` `(string: "1h")` - Specifies the minimum age of
a CSI volume before it is eligible to have its claims garbage collected.
This is specified using a label suffix like "30s" or "1h".
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment