fix(peering): clearer error when peering is disabled - #23752
Open
locker95 wants to merge 1 commit into
Open
Conversation
When peering.enabled=false, peering list and other peering RPCs now return "peering is disabled" so operators see the reason instead of a generic failure. Add a CLI regression test for consul peering list. Fixes hashicorp#14896 Signed-off-by: Dean Chen <862469039@qq.com>
github-actions
Bot
added
the
theme/cli
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
1 participant
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.
Description
When a cluster is configured with
peering.enabled = false, operators runningconsul peering listused to get a vague failure and had to dig into logs to understand why.This change makes the peering RPC layer return a clear
peering is disablederror for all peering endpoints when peering is turned off. The CLI already surfaces the RPC error as:So the reason is now explicit and matches the wording requested in the issue.
Testing & Reproduction steps
peering is disabledrather than a bareError listing peerings.Unit / integration coverage:
TestPeeringService_PeeringDisabled(updated expected message)TestListCommand_PeeringDisabled(new CLI regression test)Links
Fixes #14896
PR Checklist
PCI review checklist
I have documented a clear reason for, and description of, the change I am making.
If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.
If applicable, I've documented the impact of any changes to security controls.
Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.