Feature Branch: consul-k8s Envoy Debugging

[t-eckert]

Changes proposed in this PR

This feature is based on CSL-196 Consul K8s CLI Envoy Troubleshooting (HashiCorp internal).

Multiple branches will be merged into this branch before the feature is complete. As these parts of the overall feature are merged in, they will be checked off below.

• A PortForward struct which enables the CLI to port forward localhost to Kubernetes Pods.
  • Code to open a port forward connection.
  • Unit tests to cover the behavior of the PortForward struct.
• A command, consul-k8s proxy list, to list all Pods which are running Envoy proxies managed by Consul.
  • Code to fetch all Pods running Envoy proxies managed by Consul and list them.
  • Unit tests to cover the list behavior.
  • End-to-end unit tests to cover the list behavior.
• A command, consul-k8s proxy read podname, to print a summary of the Envoy configuration for the sidecar running on the given Kubernetes Pod (podname).
  • Code to fetch and display Envoy configuration for a sidecar in a Kubernetes Pod.
  • Code to filter tables by sections.
  • Unit tests to cover the read behavior.
  • End-to-end unit tests to cover the read behavior.
  • Code to fetch and display Envoy configuration for pods set up with multiport config.
  • Code to filter output by FQDN, port, and address.
• An acceptance test for using the envoy debugging features.

How I've tested this PR

• Port forwarding code is covered by unit tests. It is implicitly covered by acceptance tests which exercise the read command as that command uses the port forwarding code.
• The list command is covered by unit tests and acceptance tests.
• The read command is covered by unit tests and acceptance tests.

How I expect reviewers to test this PR

• Running unit tests for the CLI:

  cd cli/ && go test ./...

• Running acceptance tests for the CLI. These will be run automatically by the CI system.

Installing the CLI from this branch for testing

The version of the CLI on this branch may be installed by cloning the repository and checking out the cli/envoy-debugging branch.

git clone https://github.com/hashicorp/consul-k8s
cd consul-k8s/
git checkout cli/envoy-debugging
cd cli/
go install .
alias consul-k8s=cli

Checklist

• Tests added
• CHANGELOG entry added

  HashiCorp engineers only, community PRs should not add a changelog entry.
  Entries should use present tense (e.g. Add support for...)

[thisisnotashwin]

Good work!! reminder to squash and merge to PR!!