Add consul-k8s cli debug command docs #1308
Open
Conversation
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
Contributor
Vercel Previews Deployed
|
LordAbhishek
changed the title
LordAbhishek
changed the title
Contributor
Broken Link CheckerNo broken links found! 🎉 |
aimeeu
requested changes
Nov 17, 2025
Contributor
aimeeu
left a comment
aimeeu
left a comment
There was a problem hiding this comment.
Thanks for the update! I left some suggestions so that the text complies with the Education style guide.
|
|
||
| - [`config`](#config): Interact with helm configuration. | ||
| - [`config read`](#config-read): Read helm configuration of a Consul installation. | ||
| - [`debug`](#debug): Collect configs, logs, and other data from a Consul on Kubernetes deployment in a archive/dir. |
Contributor
There was a problem hiding this comment.
Suggested change
| - [`debug`](#debug): Collect configs, logs, and other data from a Consul on Kubernetes deployment in a archive/dir. | |
| - [`debug`](#debug): Collect configs, logs, and other data from a Consul on Kubernetes deployment in an archive directory. |
Author
There was a problem hiding this comment.
updated it to "in an archive." directory is not required.
|
|
||
| ### `debug` | ||
|
|
||
| The debug command collect configs, logs, and other data from a Consul on Kubernetes deployment in a archive/dir. |
Contributor
There was a problem hiding this comment.
Suggested change
| The debug command collect configs, logs, and other data from a Consul on Kubernetes deployment in a archive/dir. | |
| The debug command collect configs, logs, and other data from a Consul on Kubernetes deployment into an archive directory. |
Author
There was a problem hiding this comment.
updated it to "in an archive." directory is not required.
content/consul/v1.22.x/content/docs/reference/cli/consul-k8s.mdx
Outdated
Show resolved
Hide resolved
content/consul/v1.22.x/content/docs/reference/cli/consul-k8s.mdx
Outdated
Show resolved
Hide resolved
content/consul/v1.22.x/content/docs/reference/cli/consul-k8s.mdx
Outdated
Show resolved
Hide resolved
content/consul/v1.22.x/content/docs/reference/cli/consul-k8s.mdx
Outdated
Show resolved
Hide resolved
content/consul/v1.22.x/content/docs/reference/cli/consul-k8s.mdx
Outdated
Show resolved
Hide resolved
content/consul/v1.22.x/content/docs/reference/cli/consul-k8s.mdx
Outdated
Show resolved
Hide resolved
content/consul/v1.22.x/content/docs/reference/cli/consul-k8s.mdx
Outdated
Show resolved
Hide resolved
content/consul/v1.22.x/content/docs/reference/cli/consul-k8s.mdx
Outdated
Show resolved
Hide resolved
LordAbhishek
force-pushed
the
abhishek/consul-k8s-cli-debug-docs
branch
from
f897b93 to
869a3c4
Compare
aimeeu
approved these changes
Nov 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Docs change for PR: hashicorp/consul-k8s#4800
Changes:
Added
consul-k8s debugcommand to consul-k8s cli.The command will capture helm config, CRDs and its resources, consul-injected sidecar pods, consul-components(statefulsets, daemonsets, deployments, sidecars) pod logs and Envoy admin endpoint data for all the proxies(gateways and sidecars) and create archive of them.