This repository was archived by the owner on Dec 17, 2025. It is now read-only.
docs: update flow + diagrams + developer guide#2128
Open
kalvinparker wants to merge 6 commits into
Open
Conversation
…tion - Introduced `--registry-ca` and `--registry-ca-validate` flags for configuring TLS verification with private registries. - Implemented in-memory token caching with expiration handling. - Updated documentation to reflect new CLI options and usage examples. - Added tests for token cache concurrency and expiry behavior.
…sts and docs changes
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds detailed documentation for Watchtower's update flow and developer guide.
Summary
This PR adds developer-focused documentation that describes the end-to-end update flow, the function-level call chain, and the full data-shape mappings used by Watchtower. It also includes diagrams (PlantUML source + rendered SVG) and a small developer guide with commands to run tests and render diagrams locally.
Files added
docs/update-flow.md— high-level flow, mermaid sequence diagram, security notes.docs/update-flow-detailed.md— function-level call chain, file references, and full data-shape listings for maintainers.docs/diagrams/update-flow.puml— PlantUML source for sequence diagram.docs/assets/images/update-flow.svg— rendered SVG diagram (from PlantUML).docs/developer-guide.md— local developer guide:go test, containerized-racesteps, and PlantUML render instructions.Why
internal/actions.Updateorchestrates container discovery, digest checking, token auth and restart/cleanup flows.--registry-ca,--registry-ca-validate) and developer testing steps.Testing / Verification
These are docs-only additions. To validate locally:
Checklist
mkdocs buildormkdocs serveand inspect the new pages underdocs/.Suggested reviewers / labels
@containrrr/maintainers).documentation,docs.Notes
gh pr createsteps previously provided. If you prefer, I can also generate a git patch file for manual application.