Revise Runner upgrade documentation for clarity - #1934
Merged
fdevans merged 1 commit intoAug 20, 2026
Conversation
Updated documentation on upgrading Runners to clarify the role of Replicas and the upgrade process for various environments, including virtual machines, Docker, and Kubernetes.
fdevans
approved these changes
Aug 20, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Runner upgrade documentation to reflect the Runner Replicas model (Self-Hosted 5.16.0+), clarifying how “upgrading a Runner” works across persistent (manual) and ephemeral (orchestrated) deployments.
Changes:
- Reframes upgrades around replacing/upgrading Replicas (rolling upgrade semantics) and documents expected behavior during version skew.
- Adds distinct, step-by-step procedures for Persistent Replicas (GUI + REST API) vs. Ephemeral Replicas (Docker/Kubernetes/orchestration-driven).
- Adds a clearly separated legacy procedure for Self-Hosted 5.x environments where the Replicas feature is disabled.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updated documentation on upgrading Runners to clarify the role of Replicas and the upgrade process for various environments, including virtual machines, Docker, and Kubernetes.