Document Octopus.Action.Kubernetes.VerboseOutput variable for CLI tool logging #2993
+113
−88
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
|
|
||
| Setting the Octopus variable `Octopus.Action.Kubernetes.OutputKubeConfig` to `True` for any deployment or runbook using a Kubernetes target will cause the generated kube config file to be printed into the logs (with passwords masked). This can be used to verify the configuration file used to connect to the Kubernetes cluster. | ||
|
|
||
| Setting the Octopus variable `Octopus.Action.Kubernetes.VerboseOutput` to `True` will cause successful output from Kubernetes CLI tools (`kubectl`, `helm`, `aws`, `az`, `gcloud`, etc.) to be logged at the Info level instead of Verbose. This is useful when debugging deployments to see the full output of these tools without needing to enable verbose logging for the entire deployment. |
Contributor
There was a problem hiding this comment.
Perhaps we could mention the default logging level if this flag is not set or false? For example, do we only log errors if VerboseOutput is False?
|
|
||
| `Octopus.Action.Kubernetes.VerboseOutput` | ||
|
|
||
| Set to `True` to log successful output from Kubernetes CLI tools (`kubectl`, `helm`, `aws`, `az`, `gcloud`, etc.) at the Info level instead of Verbose. This is useful when debugging deployments to see the full output of these tools without needing to enable verbose logging for the entire deployment. |
Contributor
There was a problem hiding this comment.
Perhaps we could mention the default logging level if this flag is not set or false? For example, do we only log errors if VerboseOutput is False?
Contributor
|
@HuyPhanNguyen I've fixed the Markdown Lint errors. It would be useful to explain what logging level is set if the flag isn't passed, or is |
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.
Add
Octopus.Action.Kubernetes.VerboseOutputvariable to log CLI tool output at Info level for Kubernetes stepsOctopusDeploy/Issues#9786