vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

docs: clear write-good.Passive hits in docs/swarm/services.md

Browse source
This commit is contained in:
iris 2026-09-20 14:32:39 +02:00
commit 9fd5a7a689
1 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/swarm/services.md
View file

@ -17,7 +17,7 @@ visible difference rather than one more paragraph saying the same thing.
`singleHostSwarm` is the all-on-one-box switch above it: it defaults `singleHostSwarm` is the all-on-one-box switch above it: it defaults
both `deploy.allSwarmServices` and `swarm.ca.autoConfigure` (this host both `deploy.allSwarmServices` and `swarm.ca.autoConfigure` (this host
generates the swarm CA here). Each derived toggle can still be set on its own, generates the swarm CA here). You can still set each derived toggle on its own,
which wins, so "all local except X" needs no further option. which wins, so "all local except X" needs no further option.
**Both default to off**, and that's deliberate: a host can't tell **Both default to off**, and that's deliberate: a host can't tell
@ -46,7 +46,7 @@ the shapes worth naming are the ones they produce:
somewhere. somewhere.
**These are a set, not a ladder with a correct top, and hyperhive **These are a set, not a ladder with a correct top, and hyperhive
supports in-between shapes.** Each derived toggle can be set on its own (see supports in-between shapes.** You can set each derived toggle on its own (see
above), which is what makes "all local except X" a configuration rather above), which is what makes "all local except X" a configuration rather
than an unsupported edge case. Nothing in hyperhive prescribes a than an unsupported edge case. Nothing in hyperhive prescribes a
deployment model, so a doc that treats one shape as the real one and deployment model, so a doc that treats one shape as the real one and
@ -75,8 +75,8 @@ there is one IdP and one auth path.
joining someone else's swarm sets it explicitly. Null means "no SSO joining someone else's swarm sets it explicitly. Null means "no SSO
configured", and consumers say so rather than guessing an address. configured", and consumers say so rather than guessing an address.
swarm-controller writes the users database, not by hand: agents swarm-controller writes the users database, not by hand: hive-c0re
are created and destroyed continuously, so the subject set is dynamic. creates and destroys agents continuously, so the subject set is dynamic.
This module only guarantees the file exists and parses, so authelia This module only guarantees the file exists and parses, so authelia
starts with nobody in it rather than failing to start — a provider with starts with nobody in it rather than failing to start — a provider with
no subjects yet is the correct state before anything has provisioned no subjects yet is the correct state before anything has provisioned
@ -98,8 +98,8 @@ generates and reads each of its keys.
The swarm's telemetry lands in one VictoriaMetrics, and one Grafana The swarm's telemetry lands in one VictoriaMetrics, and one Grafana
reads it, in two containers at `metrics.<swarm-domain>` and reads it, in two containers at `metrics.<swarm-domain>` and
`grafana.<swarm-domain>`. Two containers rather than one so Grafana can `grafana.<swarm-domain>`. Two containers rather than one so you can
be restarted or broken without taking the time-series database with it. restart or break Grafana without taking the time-series database with it.
They derive together: a store with no UI is unreadable and a UI with no They derive together: a store with no UI is unreadable and a UI with no
store is empty. To run one without the other, set it directly: store is empty. To run one without the other, set it directly:
@ -144,8 +144,8 @@ no setting here changes that, so Explore is the log browser for this
swarm. swarm.
| Option | When you'd touch it | | Option | When you'd touch it |
| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `deploy.victorialogs.retentionPeriod` | Default `30d`, far shorter than the metrics store's — logs are bulkier per unit of value and are typically read within days of being written. Raise it if you need to answer questions about last quarter. | | `deploy.victorialogs.retentionPeriod` | Default `30d`, far shorter than the metrics store's — logs are bulkier per unit of value and are typically read within days of ingestion. Raise it if you need to answer questions about last quarter. |
| `swarm.victorialogs.domain` | Only to rename it. | | `swarm.victorialogs.domain` | Only to rename it. |
| `swarm.victorialogs.port` | Only if something else on the services host already claims `9428`. | | `swarm.victorialogs.port` | Only if something else on the services host already claims `9428`. |