status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Net 6603 (#19718) 

* Update docs for NET-6603

* json format

* json caps

* Update website/content/docs/k8s/k8s-cli.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

---------

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
This commit is contained in:
Ashesh Vidyut 2023-12-19 03:57:23 +05:30 committed by GitHub
parent 010bf533d1
commit f1dee1a718
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
website/content/docs/k8s/k8s-cli.mdx
View File

@ -161,6 +161,7 @@ $ consul-k8s proxy list <OPTIONS>
| ------------------------------------ | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | ------------------------------------ | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| <nobr>`-all-namespaces`, `-A`</nobr> | `Boolean` List pods in all Kubernetes namespaces. | `false` | | <nobr>`-all-namespaces`, `-A`</nobr> | `Boolean` List pods in all Kubernetes namespaces. | `false` |
| <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>`-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>`-output-format`, `-o`</nobr> | `String` If set to json, outputs the result in json format, else table format | `table`
Refer to the [Global Options](#global-options) for additional options that you can use Refer to the [Global Options](#global-options) for additional options that you can use
when installing Consul on Kubernetes. when installing Consul on Kubernetes.
@ -229,6 +230,46 @@ default client-767ccfc8f9-ggrtx Sidecar
default frontend-676564547c-v2mfq Sidecar default frontend-676564547c-v2mfq Sidecar
``` ```
Display all Pods across all namespaces that run proxies managed by Consul in JSON format
```shell-session
$ consul-k8s proxy list -A -o json
Namespace: All namespaces
[
{
"Name": "frontend-6fd97b8fb5-spqb8",
"Namespace": "default",
"Type": "Sidecar"
},
{
"Name": "nginx-6d7469694f-p5wrz",
"Namespace": "default",
"Type": "Sidecar"
},
{
"Name": "payments-667d87bf95-ktb8n",
"Namespace": "default",
"Type": "Sidecar"
},
{
"Name": "product-api-7c4d77c7c9-g4g2b",
"Namespace": "default",
"Type": "Sidecar"
},
{
"Name": "product-api-db-685c844cb-k5l8f",
"Namespace": "default",
"Type": "Sidecar"
},
{
"Name": "public-api-567d949866-cgksl",
"Namespace": "default",
"Type": "Sidecar"
}
]
```
### `proxy read` ### `proxy read`
The `proxy read` command allows you to inspect the configuration of Envoy proxies running on a given Pod. The `proxy read` command allows you to inspect the configuration of Envoy proxies running on a given Pod.