docs: document Git backend unavailability behaviour and stale-cache fallback#3246
Open
won-seoop wants to merge 1 commit into
Open
docs: document Git backend unavailability behaviour and stale-cache fallback#3246won-seoop wants to merge 1 commit into
won-seoop wants to merge 1 commit into
Conversation
…allback Adds a new "Behavior When the Git Backend Is Unavailable" section to the Git Backend reference page, addressing the scenarios raised in spring-cloud#572. The section covers four distinct scenarios in a summary table: * Initial startup with no prior clone and an unreachable Git remote * Transient remote outage after at least one successful clone/fetch (stale-cache fallback — previously undocumented) * force-pull: true combined with an unreachable remote * cloneOnStart: true when Git is unreachable at startup Also adds a NOTE recommending that operators monitor WARN log output and enable/alert on the Health Indicator, because the stale-cache fallback is silent from a client perspective. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
What
Closes #572.
Adds a new "Behavior When the Git Backend Is Unavailable" section to the Git Backend reference page.
Changes
A summary table covering four distinct scenarios:
force-pull: true+ Git unreachablecloneOnStart: true+ Git unreachable at startupAlso includes a NOTE advising operators to monitor WARN log output and enable the Health Indicator, because the stale-cache fallback is completely transparent to clients.
Motivation
The existing docs explain
cloneOnStart,force-pull, andrefreshRatein isolation but do not describe what happens to clients when the remote Git server becomes unreachable at various points in the lifecycle. In particular the "stale fallback" path — where the server silently serves an older cached configuration — was completely undocumented and has confused many users.🤖 Generated with Claude Code