-
Notifications
You must be signed in to change notification settings - Fork 4.6k
new docs for consul and consul-k8s troubleshoot command #16284
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
Changes from 1 commit
ba5560c
0f3a7cb
effdb9b
5107823
2e666f1
72cff79
74cc172
a4cf828
e4cac9d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| --- | ||
| layout: commands | ||
| page_title: 'Commands: Troubleshoot' | ||
| description: | | ||
| The `consul troubleshoot` provides tools to troubleshoot Consul's service mesh configuration. | ||
| --- | ||
|
|
||
| # Consul Troubleshooting | ||
|
|
||
| Command: `consul troubleshoot` | ||
|
|
||
| Use the `troubleshoot` command to diagnose Consul service mesh configuration or network issues. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```text | ||
| Usage: consul troubleshoot <subcommand> [options] | ||
|
|
||
| # ... | ||
|
|
||
| Subcommands: | ||
|
malizz marked this conversation as resolved.
|
||
|
|
||
| Subcommands: | ||
|
|
||
| proxy Troubleshoots service mesh issues from the current envoy instance | ||
| upstreams Get upstream envoy identifiers for the current envoy instance | ||
|
malizz marked this conversation as resolved.
Outdated
|
||
| ``` | ||
|
|
||
| For more information, examples, and usage about a subcommand, click on the name | ||
| of the subcommand in the sidebar or one of the links below: | ||
|
|
||
| - [proxy](/consul/commands/troubleshoot/proxy) | ||
| - [upstreams](/consul/commands/troubleshoot/upstreams) | ||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,59 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| layout: commands | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page_title: 'Commands: Troubleshoot Proxy' | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| The `consul troubleshoot proxy` diagnoses Consul service mesh configuration and network issues to an upstream. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
malizz marked this conversation as resolved.
Outdated
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Consul Troubleshoot Proxy | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Command: `consul troubleshoot proxy` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
malizz marked this conversation as resolved.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Usage | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Usage: `consul troubleshoot proxy (-upstream-ip <ip>|-upstream-envoy-id <envoy-id>) [options] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
malizz marked this conversation as resolved.
Outdated
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| #### Command Options | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `-envoy-admin-endpoint=<value>` - Envoy Admin endpoint address for the local Envoy instance. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Defaults to `127.0.0.1:19000`. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `-upstream-ip=<value>` - The IP address of the upstream transparent proxy. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
malizz marked this conversation as resolved.
Outdated
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `-upstream-envoy-id=<value>` - The Envoy identifier of the upstream service to be troubleshooted. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Examples | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Troubleshoot Consul service mesh configuration and network issues from the current Envoy instance. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ```shell-session hideClipboard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
malizz marked this conversation as resolved.
Outdated
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ consul troubleshoot proxy -upstream-ip 10.4.6.160 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ==> Validation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ certificates are valid | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ Envoy has 0 rejected configurations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ Envoy has detected 0 connection failure(s) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ listener for upstream "backend" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ route for upstream "backend" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ cluster "backend.default.dc1.internal..consul" for upstream "backend" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ healthy endpoints for cluster "backend.default.dc1.internal.e08fa6d6-e91e-dfe0-f6e1-ba097a828e31.consul" for upstream "backend" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ cluster "backend2.default.dc1.internal..consul" for upstream "backend" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ! no healthy endpoints for cluster "backend2.default.dc1.internal.e08fa6d6-e91e-dfe0-f6e1-ba097a828e31.consul" for upstream "backend" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Troubleshoot Consul service mesh configuration and network issues from the current Envoy instance to the given upstream Envoy identifier. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ```shell-session | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ consul-k8s troubleshoot proxy -upstream-envoy-id db | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ==> Validation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ certificates are valid | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ Envoy has 0 rejected configurations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ Envoy has detected 0 connection failure(s) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ! no listener for upstream "db" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ! no route for upstream "backend" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ! no cluster "db.default.dc1.internal.e08fa6d6-e91e-dfe0-f6e1-ba097a828e31.consul" for upstream "db" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ! no healthy endpoints for cluster "db.default.dc1.internal.e08fa6d6-e91e-dfe0-f6e1-ba097a828e31.consul" for upstream "db" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
The phrasing of "from the current Envoy instance to the given upstream Envoy identifier" was confusing to me. I understand it as troubleshooting issues between these two points. Is that description correct?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,36 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| layout: commands | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page_title: 'Commands: Troubleshoot Upstreams' | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| The `consul troubleshoot upstream` lists the available upstreams in the Consul service mesh from the current service. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Consul Troubleshoot Upstreams | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Command: `consul troubleshoot upstreams` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
malizz marked this conversation as resolved.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Usage | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Usage: `consul troubleshoot upstreams [options] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| #### Command Options | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `-envoy-admin-endpoint=<value>` - Envoy Admin endpoint address for the local Envoy instance. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Defaults to `127.0.0.1:19000`. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+16
to
+22
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Examples | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Display all transparent proxy upstreams in Consul service mesh from the current Envoy instance. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
malizz marked this conversation as resolved.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ```shell-session hideClipboard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ consul troubleshoot upstreams | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ==> Upstreams (explicit upstreams only) (0) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ==> Upstreams IPs (transparent proxy only) (1) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| [10.4.6.160 240.0.0.3] true map[backend.default.dc1.internal.e08fa6d6-e91e-dfe0-f6e1-ba097a828e31.consul backend2.default.dc1.internal.e08fa6d6-e91e-dfe0-f6e1-ba097a828e31.consul] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| If you don't see your upstream address or cluster for a transparent proxy upstream: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Check intentions: Tproxy upstreams are configured based on intentions, make sure you have configured intentions to allow traffic to your upstream. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - You can also check that the right cluster is being dialed by running a DNS lookup for the upstream you are dialing (i.e dig backend.svc.consul). If the address you get from that is missing from the Upstream IPs your proxy may be misconfigured. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is the output of the cli, I will send another PR to update it and reflect this change in the output. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -33,6 +33,7 @@ You can use the following commands with `consul-k8s`. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [`proxy list`](#proxy-list): List all Pods running proxies managed by Consul. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [`proxy read`](#proxy-read): Inspect the Envoy configuration for a given Pod. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [`status`](#status): Check the status of a Consul installation on Kubernetes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [`troubleshoot`](#troubleshoot): Troubleshoot Consul service mesh and networking issues from a given pod. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [`uninstall`](#uninstall): Uninstall Consul deployment. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [`upgrade`](#upgrade): Upgrade Consul on Kubernetes from an existing installation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [`version`](#version): Print the version of the Consul on Kubernetes CLI. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
@@ -490,6 +491,115 @@ $ consul-k8s status | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ Consul clients healthy (3/3) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### `troubleshoot` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| The `troubleshoot` command exposes two subcommand for troubleshooting Consul | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| service mesh and network issues from a given pod. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [`troubleshoot upstreams`](#troubleshoot-upstreams): List all Envoy upstreams in Consul service mesh from the given pod. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [`troubleshoot proxy`](#troubleshoot-proxy): Troubleshoot Consul service mesh configuration and network issues from the given pod to the given upstream. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### `troubleshoot upstreams` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ```shell-session | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ consul-k8s troubleshoot upstreams -pod <pod> <OPTIONS> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | Flag | Description | Default | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | ------------------------------------ | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | <nobr>`-namespace`, `-n`</nobr> | `String` The Kubernetes namespace to list proxies in. | Current [kubeconfig](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) namespace. | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | <nobr>`-envoy-admin-endpoint`</nobr> | `String` Envoy sidecar address and port | `127.0.0.1:19000` | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| #### Example Commands | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Display all transparent proxy upstreams in Consul service mesh from the given pod. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ```shell-session | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ consul-k8s troubleshoot upstreams -pod frontend-767ccfc8f9-6f6gx | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ==> Upstreams (explicit upstreams only) (0) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ==> Upstreams IPs (transparent proxy only) (1) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| [10.4.6.160 240.0.0.3] true map[backend.default.dc1.internal.e08fa6d6-e91e-dfe0-f6e1-ba097a828e31.consul backend2.default.dc1.internal.e08fa6d6-e91e-dfe0-f6e1-ba097a828e31.consul] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| If you don't see your upstream address or cluster for a transparent proxy upstream: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Check intentions: Tproxy upstreams are configured based on intentions, make sure you have configured intentions to allow traffic to your upstream. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - You can also check that the right cluster is being dialed by running a DNS lookup for the upstream you are dialing (i.e dig backend.svc.consul). If the address you get from that is missing from the Upstream IPs your proxy may be misconfigured. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same as above. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Display all explicit upstreams in Consul service mesh from the given pod. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
malizz marked this conversation as resolved.
Outdated
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ```shell-session | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ consul-k8s troubleshoot upstreams -pod client-767ccfc8f9-6f6gx | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
malizz marked this conversation as resolved.
Outdated
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ==> Upstreams (explicit upstreams only) (1) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| server | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| counting | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ==> Upstreams IPs (transparent proxy only) (0) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| If you don't see your upstream address or cluster for a transparent proxy upstream: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Check intentions: Tproxy upstreams are configured based on intentions, make sure you have configured intentions to allow traffic to your upstream. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - You can also check that the right cluster is being dialed by running a DNS lookup for the upstream you are dialing (i.e dig backend.svc.consul). If the address you get from that is missing from the Upstream IPs your proxy may be misconfigured. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
malizz marked this conversation as resolved.
Outdated
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### `troubleshoot proxy` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ```shell-session | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ consul-k8s troubleshoot proxy -pod <pod> -upstream-ip <ip> <OPTIONS> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ consul-k8s troubleshoot proxy -pod <pod> -upstream-envoy-id <envoy-id> <OPTIONS> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | Flag | Description | Default | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | ------------------------------------ | ----------------------------------------------------------| ---------------------------------------------------------------------------------------------------------------------- | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | <nobr>`-namespace`, `-n`</nobr> | `String` The Kubernetes namespace to list proxies in. | Current [kubeconfig](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) namespace. | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | <nobr>`-envoy-admin-endpoint`</nobr> | `String` Envoy sidecar address and port | `127.0.0.1:19000` | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | <nobr>`-upstream-ip`</nobr> | `String` The IP address of the upstream transparent proxy | | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | <nobr>`-upstream-envoy-id`</nobr> | `String` The Envoy identifier of the upstream | | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| #### Example Commands | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Troubleshoot Consul service mesh configuration and network issues from the given pod to the given upstream IP. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
malizz marked this conversation as resolved.
Outdated
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ```shell-session | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ consul-k8s troubleshoot proxy -pod frontend-767ccfc8f9-6f6gx -upstream-ip 10.4.6.160 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
malizz marked this conversation as resolved.
Outdated
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ==> Validation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ certificates are valid | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ Envoy has 0 rejected configurations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ Envoy has detected 0 connection failure(s) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ listener for upstream "backend" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ route for upstream "backend" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ cluster "backend.default.dc1.internal..consul" for upstream "backend" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ healthy endpoints for cluster "backend.default.dc1.internal.e08fa6d6-e91e-dfe0-f6e1-ba097a828e31.consul" for upstream "backend" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ cluster "backend2.default.dc1.internal..consul" for upstream "backend" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ! no healthy endpoints for cluster "backend2.default.dc1.internal.e08fa6d6-e91e-dfe0-f6e1-ba097a828e31.consul" for upstream "backend" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Troubleshoot Consul service mesh configuration and network issues from the given pod to the given upstream Envoy identifier. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
malizz marked this conversation as resolved.
Outdated
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ```shell-session | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ consul-k8s troubleshoot proxy -pod frontend-767ccfc8f9-6f6gx -upstream-envoy-id db | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ==> Validation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ certificates are valid | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ Envoy has 0 rejected configurations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ✓ Envoy has detected 0 connection failure(s) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ! no listener for upstream "db" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ! no route for upstream "backend" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ! no cluster "db.default.dc1.internal.e08fa6d6-e91e-dfe0-f6e1-ba097a828e31.consul" for upstream "db" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ! no healthy endpoints for cluster "db.default.dc1.internal.e08fa6d6-e91e-dfe0-f6e1-ba097a828e31.consul" for upstream "db" found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### `uninstall` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| The `uninstall` command removes Consul from Kubernetes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Uh oh!
There was an error while loading. Please reload this page.