nix: comments state current behaviour, not history
Rewrite comments and option descriptions under nix/ that narrate how the
code got here ("used to", "new name", "sat at the TOP", "no longer",
renamed/moved narration, attributions) to say what the code does now and
why. Comments and description strings only; no logic changes.
Files in open PR #4970's diff are left alone. Refs #3902
This commit is contained in:
parent
ea63b0d150
commit
1c90619fbb
45 changed files with 331 additions and 411 deletions
|
|
@ -250,10 +250,10 @@ let
|
|||
# IS asserted is narrower and lives in `assertions` below — see
|
||||
# `hiveReaderIdentity`.
|
||||
#
|
||||
# 🩸 The collector's OWN leaf, not `clientCertFile` — the hive's, which four
|
||||
# units used to share. Bao matches a cert-auth role on the CN, so one leaf for
|
||||
# four readers was ONE principal holding the union of four grants: this unit
|
||||
# could read every agent credential in the swarm and Grafana's OIDC client
|
||||
# 🩸 The collector's OWN leaf, not `clientCertFile` — the hive's. Bao
|
||||
# matches a cert-auth role on the CN, so one leaf shared by four readers
|
||||
# would be ONE principal holding the union of four grants: this unit could
|
||||
# read every agent credential in the swarm and Grafana's OIDC client
|
||||
# secret, when what it needs is the one path `storeSecretPath` names.
|
||||
haveClientIdentity =
|
||||
baoDeploy.otelOidcClientCertFile != null && baoDeploy.otelOidcClientKeyFile != null;
|
||||
|
|
@ -396,23 +396,21 @@ in
|
|||
# this is how it authenticates *itself* to a service published behind
|
||||
# the gateway.
|
||||
#
|
||||
# Registering the client is NOT here any more: it has to happen on the
|
||||
# host that runs authelia, and this whole block is gated on the host that
|
||||
# runs the collector. ./glue-swarm-otel-oidc-client.nix is where it moved
|
||||
# to, the same split ./swarm-grafana.nix made for its own client.
|
||||
# Registering the client is NOT here: it has to happen on the host that
|
||||
# runs authelia, and this whole block is gated on the host that runs the
|
||||
# collector. ./glue-swarm-otel-oidc-client.nix does it, the same split
|
||||
# ./swarm-grafana.nix has for its own client.
|
||||
|
||||
# THE delivery unit — one route, in every deployment. The secret authelia
|
||||
# minted arrives out of the swarm secret store, which the publisher on
|
||||
# authelia's host wrote it into, whether authelia is a network away or in
|
||||
# the container next door.
|
||||
#
|
||||
# 🩸 A unit here used to copy the plaintext directly out of authelia's
|
||||
# host tree, reachable only because they share this host's network
|
||||
# namespace — which stopped working the moment authelia moved to another
|
||||
# host, which is the defect this whole change exists to fix. The ruling
|
||||
# that deleted it rather than gave it a remote sibling: the store exists
|
||||
# so a host holds ONE out-of-band secret — its client certificate — and
|
||||
# reads everything else with it. Recorded in docs/swarm/secrets.md.
|
||||
# 🩸 No unit here copies the plaintext directly out of authelia's host
|
||||
# tree: that is reachable only where authelia shares this host's network
|
||||
# namespace, and breaks the moment authelia is on another host. The store
|
||||
# exists so a host holds ONE out-of-band secret — its client certificate —
|
||||
# and reads everything else with it. Recorded in docs/swarm/secrets.md.
|
||||
#
|
||||
# Shaped after ./glue-queue-agent-credential.nix: a cert login that fails
|
||||
# LOUDLY, since every state it fails on is one a retry fixes, then a read
|
||||
|
|
@ -638,8 +636,8 @@ in
|
|||
'';
|
||||
}
|
||||
{
|
||||
# The blacklist now lives in a shared file, so this module no longer
|
||||
# controls its contents — and a guard whose subject can be edited
|
||||
# The blacklist lives in a shared file, so this module does not
|
||||
# control its contents — and a guard whose subject can be edited
|
||||
# elsewhere has to assert that its own case is still in there. Without
|
||||
# this, deleting one line from `reserved-names.nix` would silently
|
||||
# retire the check below rather than fail anything.
|
||||
|
|
|
|||
Loading…
Reference in a new issue