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
|
|
@ -142,11 +142,6 @@ in
|
|||
matter for access from outside the host. Flip to `true` when
|
||||
you want the operator's browser or external git clients to
|
||||
hit the forge directly.
|
||||
|
||||
**Breaking change**: this used to default to `true`. If you
|
||||
relied on the old default for external reach, add
|
||||
`services.hyperhive.deploy.forgejo.openFirewall = true;` to your
|
||||
host config before rebuilding.
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
@ -783,7 +778,7 @@ in
|
|||
Group = "forgejo";
|
||||
SyslogIdentifier = "forgejo-sso-source";
|
||||
};
|
||||
# `FORGEJO_CUSTOM` (not `GITEA_CUSTOM` — forgejo renamed it)
|
||||
# `FORGEJO_CUSTOM` (the forgejo-prefixed name, not `GITEA_CUSTOM`)
|
||||
# is how the CLI finds the app.ini upstream's module wrote.
|
||||
#
|
||||
# This unit is also a trust-bundle consumer (declared in the
|
||||
|
|
@ -930,29 +925,25 @@ in
|
|||
# re-mint instead of being silently masked by a stamp that
|
||||
# outlived what it claims exists.
|
||||
if [ ! -s "$token_path" ]; then
|
||||
# `write:admin` added for `swarm-controller::forge::Client::
|
||||
# ensure_agent_user` (the `CreateForgeUser` jobq node) —
|
||||
# Forgejo's `admin_create_user` HTTP endpoint refused every
|
||||
# call with "token does not have at least one of required
|
||||
# scope(s): [write:admin]" without it, an already-deployed
|
||||
# swarm hitting this the moment that node shipped. A host
|
||||
# whose token was minted before this scope was added won't
|
||||
# pick it up automatically — the `[ ! -s "$token_path" ]`
|
||||
# guard above only mints when the file is absent, by design
|
||||
# (see its own comment) — so an existing deployment needs
|
||||
# its token file deleted to force a re-mint with the new
|
||||
# scope.
|
||||
# `write:admin` is required by `swarm-controller::forge::Client::
|
||||
# ensure_agent_user` (the `CreateForgeUser` jobq node):
|
||||
# Forgejo's `admin_create_user` HTTP endpoint refuses a
|
||||
# token without it ("token does not have at least one of
|
||||
# required scope(s): [write:admin]"). A host whose token was
|
||||
# minted without this scope keeps it — the
|
||||
# `[ ! -s "$token_path" ]` guard above only mints when the
|
||||
# file is absent, by design (see its own comment) — so such a
|
||||
# deployment needs its token file deleted to force a re-mint
|
||||
# with the full scope.
|
||||
#
|
||||
# Token name carries a timestamp suffix rather than the
|
||||
# fixed `swarm-controller-boot` this used to be — a real
|
||||
# incident, not a hypothetical: deleting the token *file*
|
||||
# (the remediation above) doesn't delete the token Forgejo
|
||||
# already has under that name, so re-running this unit hit
|
||||
# "Command error: access token name has been used already"
|
||||
# and failed outright. Same fix `hive-c0re::forge::users::
|
||||
# mint_token` already uses for its own agent tokens, for
|
||||
# the identical reason — a monotonic suffix means a re-mint
|
||||
# can never collide with whatever this account already has.
|
||||
# Token name carries a timestamp suffix rather than a fixed
|
||||
# name: deleting the token *file* (the remediation above)
|
||||
# doesn't delete the token Forgejo already has under that
|
||||
# name, so re-running this unit would fail with "Command
|
||||
# error: access token name has been used already". Same
|
||||
# approach `hive-c0re::forge::users::mint_token` uses for its
|
||||
# own agent tokens — a monotonic suffix means a re-mint can
|
||||
# never collide with whatever this account already has.
|
||||
out=$(forgejo admin user generate-access-token \
|
||||
--username ${lib.escapeShellArg swarmControllerForgeUser} \
|
||||
--token-name "swarm-controller-boot-$(date +%s)" \
|
||||
|
|
|
|||
|
|
@ -30,9 +30,10 @@ let
|
|||
effectiveRootUrl = if cfg.rootUrl != null then cfg.rootUrl else defaultRootUrl;
|
||||
in
|
||||
{
|
||||
# Forge moved under `swarm` when the swarm-global services were
|
||||
# consolidated. One rename for the namespace: the subtree comes with it,
|
||||
# so existing hives keep evaluating and get one warning naming both paths.
|
||||
# Forge lives under `swarm`, beside the other swarm-global services. One
|
||||
# rename for the top-level `services.hyperhive.forge` namespace: the
|
||||
# subtree comes with it, so existing hives keep evaluating and get one
|
||||
# warning naming both paths.
|
||||
imports = [
|
||||
(lib.mkRenamedOptionModule
|
||||
[ "services" "hyperhive" "forge" ]
|
||||
|
|
|
|||
Loading…
Reference in a new issue