Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport of Update consul-k8s CLI docs with Envoy Debugging into release/1.13.x #14100

Conversation

hc-github-team-consul-core
Copy link
Collaborator

Backport

This PR is auto-generated from #13860 to be assessed for backporting due to the inclusion of the label backport/1.13.

The below text is copied from the body of the original PR.


Description

With the upcoming release of Consul on Kubernetes 0.47.0, the consul-k8s CLI will gain two new commands:

  • proxy list for listing the names of all Pods running Envoy proxies managed by Consul.
  • proxy read <PODNAME> for inspecting the Envoy configuration of a given Pod.

This PR updates the commands page for the consul-k8s CLI with documentation for the new commands.

In addition, this PR makes some changes to existing documentation with the intent of improving clarity:

  • Change of wording of the intro section.
  • Addition of descriptive text to the table of contents.
  • Removal of the "Required" column from flag tables. All flags are optional.

Links

PR Checklist

* [ ] updated test coverage (No code added)

  • external facing docs updated
  • not a security concern

@hc-github-team-consul-core hc-github-team-consul-core requested a review from a team as a code owner August 9, 2022 20:19
@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/consul-1.13/update-consul-k8s-cli-docs/legally-next-jaguar branch from 9712804 to d75e796 Compare August 9, 2022 20:19
@hc-github-team-consul-core hc-github-team-consul-core merged commit 92634d6 into release/1.13.x Aug 9, 2022
@hc-github-team-consul-core hc-github-team-consul-core deleted the backport/consul-1.13/update-consul-k8s-cli-docs/legally-next-jaguar branch August 9, 2022 20:19
@github-actions github-actions bot added the type/docs Documentation needs to be created/updated/clarified label Aug 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant