Update consul-k8s cli proxy command docs #1309
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
|
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.
I left some suggestions so that the text follows the Education style guide. Thanks!
content/consul/v1.22.x/content/docs/reference/cli/consul-k8s.mdx
Outdated
Show resolved
Hide resolved
| | Flag | Description | Default | | ||
| | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | ||
| | <nobr>`-namespace`, `-n`</nobr> | `String` Specifies the namespace containing the target Pod. | Current [kubeconfig](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) namespace. | | ||
| | <nobr>`-update-level`, `-u`</nobr> | `String` Specifies the logger (optional) and the level to update. <p>Use the following format to configure the same level for loggers: `-update-level <LEVEL>`.</p> <p>You can also specify a comma-delineated list to configure levels for specific loggers, for example: `-update-level grpc:warning,http:info`.</p> | none | |
Contributor
There was a problem hiding this comment.
Suggested change
| | <nobr>`-update-level`, `-u`</nobr> | `String` Specifies the logger (optional) and the level to update. <p>Use the following format to configure the same level for loggers: `-update-level <LEVEL>`.</p> <p>You can also specify a comma-delineated list to configure levels for specific loggers, for example: `-update-level grpc:warning,http:info`.</p> | none | | |
| | <nobr>`-update-level`, `-u`</nobr> | `String` Specifies the optional logger and the level to update. <p>Use the following format to configure the same level for loggers: `-update-level <LEVEL>`.</p> <p>You can also specify a comma-delimited list to configure levels for specific loggers, such as `-update-level grpc:warning,http:info`.</p> | none | |
Author
There was a problem hiding this comment.
"Specifies the logger (optional) and the level to update." the statement makes more sense as it try to convey that logger is an optional field but the level to update is mandatory field for update-level flag.. this is what command intends to expect.
So i guess.. this part is fine and keeping as it is.
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-proxy-docs
branch
from
19ca0a3 to
1052cd1
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: https://github.com/hashicorp/consul-k8s/pull/4788/
Changes:
Added -capture flag to
proxy logcommand.This will enable user to capture log for given duration and write them to a file in current working dir.
If -update-level flag is provided along with -capture flag, it will set given new log level, capture the log for given duration and reset the log level to existing one post log capture.
Sample command:
consul-k8s proxy log <podname> -capture 1m -update-level debug