Skip to content

Document agent update modes, update rings, the minimum version, and the server's release copy - #191

Merged
mastacontrola merged 1 commit into
masterfrom
docs/agent-update-modes
Sep 11, 2026
Merged

mastacontrola merged 1 commit into
masterfrom
docs/agent-update-modes

Conversation

@mastacontrola

Copy link
Copy Markdown
Member

The agent docs now describe agent updates as they work after FOGProject/fogproject#1759 and fog-agent v0.1.8. Before this change, they said that no latest exists, that an empty FOG_AGENT_DESIRED_VERSION turns updates off, and that the agent settings are under General Settings and FOG Client. All three statements are now false.

management/web/agent-self-update

  • Update modes. Off, Pinned and Latest, and the rule that a host's own Desired Agent Version wins over each mode. An upgraded server that had a pinned version becomes Pinned.
  • Update rings. FOG_AGENT_UPDATE_RINGS, the host's Agent Update Ring, and the rule that a blank ring is the last ring. Ring delays count from when the server first saw a release, so the first sync starts every clock. A rollout with rings is described step by step.
  • Minimum version. FOG_AGENT_MIN_VERSION is a floor in every mode, Off included. The settings page and the host page refuse a version below it. A source build is not changed.
  • Where agents get the release. The FOGAgentReleaseSync service, /opt/fog/agent/versions, FOG_AGENT_KEEP_VERSIONS, and when the service is idle. Agents 0.1.8 and later take the manifest and the file from the server, and fall back to the origin once. The mirror section no longer says that a mirror serves a site with no internet access, because each file comes from the address inside the signed manifest.
  • A host does not update. The four things to examine.
  • Settings. The six FOG_AGENT_* update settings and the four service settings, with their new categories.

Other pages

  • management/web/fog-agent: the self-update row, the new Agent Update Ring host field, and the settings table with the categories from schema 438. The agent-only settings are in FOG Agent, and directory placement is in FOG Agent - Directory Placement.
  • kb/reference/fog-agent-reference: the trust paragraph, the payload route, and a timing row for the release sync.
  • installation/client/install-fog-agent: "Upgrading" names the update mode instead of a version.

Verification

  • npm run docs:build: 223 files, no errors.
  • node scripts/check-anchors.mjs: 0 broken anchor links.
  • node scripts/check-version-split.mjs: consistent.
  • The built HTML of the four pages has no literal [[. The new anchors #update-modes and #update-rings exist, and the links from the other pages resolve to them.
  • The facts come from the merged code on working-1.6: schema step 438, Releases.php, HostManagement.php and FOGConfigurationPage.php. The fallback detail comes from fog-agent's protocol-v1.md. On the lab server, host 239 updated from 0.1.7 to 0.1.8 in Latest mode, ring 0.

🤖 Generated with Claude Code

https://claude.ai/code/session_013Sbto9eLVhLiCPyGERUZ27

…he server's release copy

FOG 1.6 schema 438 and fog-agent 0.1.8 changed how agents update. The
docs said that no latest exists, that an empty FOG_AGENT_DESIRED_VERSION
turns updates off, and that the agent settings are in General Settings
and FOG Client. All three are now false.

Agent Self-Update now describes the Off, Pinned and Latest modes, update
rings, FOG_AGENT_MIN_VERSION, the FOGAgentReleaseSync service and its
cache, the agent's fallback to the origin, and what to examine when a
host does not update. The FOG Agent page, the reference and the install
guide get the new host field, the new settings categories, the payload
route and the release sync timing.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013Sbto9eLVhLiCPyGERUZ27
@mastacontrola
mastacontrola merged commit 2bb0485 into master Sep 11, 2026
@mastacontrola
mastacontrola deleted the docs/agent-update-modes branch September 11, 2026 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant