Watch
0
0
Fork
You've already forked hyperhive
0

docs: sort the top-level directories into five sections by what the reader wants

Every docs directory moves under 1-getting-started, 2-handbook,
4-implementation or 5-project; the options reference (section 3) comes from
the website and has no directory here. trust-boundary stays whole under the
handbook for now. web-ui, swarm and tools split between handbook and
implementation, and the command-line references move to
2-handbook/reference. Links, path references in code and nix, and the docs
index follow the moves; no page content changes.
This commit is contained in:
iris 2026-11-06 18:30:12 +01:00 • committed by mara
commit 6739bb903d

View file

@ -2,7 +2,7 @@
# `swarm-bao` nixos-container.
#
# Today every credential in ./swarm-*.nix is minted where it is read or copied
# there by a delivery unit (docs/swarm/credentials.md), which ties each secret's
# there by a delivery unit (docs/2-handbook/swarm/credentials.md), which ties each secret's
# lifetime to its container's.
#
# ⚠️ It authenticates hive clients with a CLIENT CERTIFICATE, not with the
@ -159,7 +159,7 @@ let
# The credential that writes the granter's role below. A token and not a
# certificate: cert auth answers a *role*, so nothing can authenticate here
# until some role exists, and whatever creates the first one cannot itself
# use one. An operator places it — ../../docs/getting-started/setup.md.
# use one. An operator places it — ../../docs/1-getting-started/setup.md.
haveBootstrapToken = baoDeploy.bootstrapTokenFile != null;
# Bind the directory, never the file, for the reason `tokenStoreDir` gives
@ -1962,7 +1962,7 @@ in
`bao-bootstrap` policy shipped at
{file}`/etc/hyperhive/bao-bootstrap-policy.hcl`, then delete it once
`swarm-bao-granter-role` has run —
{file}`docs/getting-started/setup.md` has the commands. Setting this is
{file}`docs/1-getting-started/setup.md` has the commands. Setting this is
what renders `swarm-bao-granter-role`; while it is null, a store whose
granter is not set up has no way to set it up.
@ -3713,7 +3713,7 @@ in
};
# A SIBLING rather than more script in the unit above, because that unit's
# name is an operator-facing string: ../../docs/getting-started/setup.md
# name is an operator-facing string: ../../docs/1-getting-started/setup.md
# tells a reader to run `systemctl status swarm-bao-controller-policy`.
# Widening it to two principals would make the name wrong, and renaming it
# would make that instruction wrong.
@ -4085,7 +4085,7 @@ in
*update*) ;;
*)
echo "the granter may not configure auth/oidc yet (capabilities: $caps), so the UI's OIDC login stays off and token login is unchanged." >&2
echo "one-time step, as root on this host (docs/getting-started/setup.md):" >&2
echo "one-time step, as root on this host (docs/1-getting-started/setup.md):" >&2
${lib.concatMapStringsSep "\n" (l: "echo ${lib.escapeShellArg " ${l}"} >&2") granterSetupSteps}
echo "swarm-bao-granter-role re-runs this unit once it succeeds." >&2
exit 0