Update debug/dump cmd with Cluster-Environment-Name header #2672
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -40,8 +40,14 @@ This endpoint can be used on both the db nodes as well as the coordinator/query | |
|
|
||
| To use this, simply run the following on either the M3DB debug listen port or the regular port on M3Coordinator. | ||
|
|
||
| You may need to include the following headers: | ||
|
|
||
| --8<-- | ||
|
There was a problem hiding this comment. What's this mean? Renders weirdly when I click the markdown view. There was a problem hiding this comment. yea it's as mkdocs thing, that will embed other pages. we do something similar for https://m3db.github.io/m3/operational_guide/placement_configuration/ |
||
| docs/common/headers_placement_namespace.md | ||
| --8<-- | ||
|
|
||
| ``` | ||
| curl -H "Cluster-Environment-Name: [set if not default]" <m3db_or_m3coordinator_ip>:<port>/debug/dump > <tmp_zip_file.zip> | ||
|
|
||
| # unzip the file | ||
| unzip <tmp_zip_file.zip> | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add something along the lines of "if the placement you are interested in is under a separate
envthan the service you are downloading the dump from, you may need to set theCluster-Environment-Nameheader"There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Never mind! The fallback behavior isn't consistent.