Skip to content

Commit 1a83948

Browse files
LordAbhishekLordAbhishek
authored
Update consul-k8s cli status command docs (#1310)
Docs change for PR: hashicorp/consul-k8s#4790 Code changes: 1. Updated the status command to output the consul client & deployments status in tabular format, along with the existing status. 2. Updated the consul server status to output in tabular format in terminal, too. Please go to the `Preview` tab and select the appropriate template: * [HCP services](?expand=1&template=hcp_pull_request_template.md) * [Terraform Enterprise](?expand=1&template=ptfe_release_pull_request_template.md)
1 parent dcd211a commit 1a83948

File tree

4 files changed

+156
-24
lines changed

4 files changed

+156
-24
lines changed

‎content/consul/v1.17.x/content/docs/k8s/k8s-cli.mdx‎

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -906,7 +906,7 @@ cluster.consul-dataplane.circuit_breakers.high.rq_retry_open: 0
906906

907907
### `status`
908908

909-
The `status` command provides an overall status summary of the Consul on Kubernetes installation. It also provides the configuration that was used to deploy Consul K8s and information about the health of Consul servers and clients. This command does not take in any flags.
909+
The `status` command provides an overall status summary of the Consul on Kubernetes installation. It also provides the configuration that was used to deploy Consul K8s and information about Consul servers, clients and deployments. This command does not take in any flags.
910910

911911
```shell-session
912912
$ consul-k8s status
@@ -920,14 +920,32 @@ $ consul-k8s status
920920
==> Consul-K8s Status Summary
921921
NAME | NAMESPACE | STATUS | CHARTVERSION | APPVERSION | REVISION | LAST UPDATED
922922
---------+-----------+----------+--------------+------------+----------+--------------------------
923-
consul | consul | deployed | 0.41.1 | 1.11.4 | 1 | 2022/03/10 07:48:58 MST
923+
consul | consul | deployed | 1.8.0 | 1.11.4 | 1 | 2025/09/29 01:45:33 IST
924924
925925
==> Config:
926+
client:
927+
enabled: true
928+
replicas: 1
926929
connectInject:
927930
enabled: true
931+
controller:
932+
enabled: true
933+
global:
934+
dataCenter: galaxy
935+
image: hashicorp/consul:1.21
936+
imageEnvoy: envoyproxy/envoy:v1.20.2
928937
metrics:
929-
defaultEnableMerging: true
930-
defaultEnabled: true
938+
enabled: true
939+
name: consul
940+
prometheus:
941+
enabled: true
942+
server:
943+
replicas: 1
944+
ui:
945+
service:
946+
port:
947+
http: 8500
948+
type: LoadBalancer
931949
enableGatewayMetrics: true
932950
global:
933951
metrics:
@@ -943,8 +961,23 @@ $ consul-k8s status
943961
service:
944962
enabled: true
945963
946-
✓ Consul servers healthy (1/1)
947-
✓ Consul clients healthy (3/3)
964+
==> Status Of Helm Hooks:
965+
966+
==> Consul Clients status:
967+
NAME | READY | AGE | CONTAINERS | IMAGES
968+
---------------+--------+--------+----------------+-----------------------
969+
consul-client | 1/1 | 4m0s | consul | hashicorp/consul:1.21
970+
971+
==> Consul Servers status:
972+
NAME | READY | AGE | CONTAINERS | IMAGES
973+
---------------+--------+--------+----------------+-----------------------
974+
consul-server | 1/1 | 4m0s | consul | hashicorp/consul:1.21
975+
976+
==> Consul Deployments status:
977+
NAME | READY | AGE | CONTAINERS | IMAGES
978+
-------------------------------+--------+--------+--------------------------------------------------------+-------------------------------------
979+
consul-connect-injector | 1/1 | 4m0s | sidecar-injector | hashicorp/consul-k8s-control-plane:1.8.0
980+
consul-webhook-cert-manager | 1/1 | 4m0s | webhook-cert-manager | hashicorp/consul-k8s-control-plane:1.8.0
948981
```
949982

950983
### `troubleshoot`

‎content/consul/v1.18.x/content/docs/k8s/k8s-cli.mdx‎

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -906,7 +906,7 @@ cluster.consul-dataplane.circuit_breakers.high.rq_retry_open: 0
906906

907907
### `status`
908908

909-
The `status` command provides an overall status summary of the Consul on Kubernetes installation. It also provides the configuration that was used to deploy Consul K8s and information about the health of Consul servers and clients. This command does not take in any flags.
909+
The `status` command provides an overall status summary of the Consul on Kubernetes installation. It also provides the configuration that was used to deploy Consul K8s and information about Consul servers, clients and deployments. This command does not take in any flags.
910910

911911
```shell-session
912912
$ consul-k8s status
@@ -920,14 +920,32 @@ $ consul-k8s status
920920
==> Consul-K8s Status Summary
921921
NAME | NAMESPACE | STATUS | CHARTVERSION | APPVERSION | REVISION | LAST UPDATED
922922
---------+-----------+----------+--------------+------------+----------+--------------------------
923-
consul | consul | deployed | 0.41.1 | 1.11.4 | 1 | 2022/03/10 07:48:58 MST
923+
consul | consul | deployed | 1.8.0 | 1.11.4 | 1 | 2025/09/29 01:45:33 IST
924924
925925
==> Config:
926+
client:
927+
enabled: true
928+
replicas: 1
926929
connectInject:
927930
enabled: true
931+
controller:
932+
enabled: true
933+
global:
934+
dataCenter: galaxy
935+
image: hashicorp/consul:1.21
936+
imageEnvoy: envoyproxy/envoy:v1.20.2
928937
metrics:
929-
defaultEnableMerging: true
930-
defaultEnabled: true
938+
enabled: true
939+
name: consul
940+
prometheus:
941+
enabled: true
942+
server:
943+
replicas: 1
944+
ui:
945+
service:
946+
port:
947+
http: 8500
948+
type: LoadBalancer
931949
enableGatewayMetrics: true
932950
global:
933951
metrics:
@@ -943,8 +961,23 @@ $ consul-k8s status
943961
service:
944962
enabled: true
945963
946-
✓ Consul servers healthy (1/1)
947-
✓ Consul clients healthy (3/3)
964+
==> Status Of Helm Hooks:
965+
966+
==> Consul Clients status:
967+
NAME | READY | AGE | CONTAINERS | IMAGES
968+
---------------+--------+--------+----------------+-----------------------
969+
consul-client | 1/1 | 4m0s | consul | hashicorp/consul:1.21
970+
971+
==> Consul Servers status:
972+
NAME | READY | AGE | CONTAINERS | IMAGES
973+
---------------+--------+--------+----------------+-----------------------
974+
consul-server | 1/1 | 4m0s | consul | hashicorp/consul:1.21
975+
976+
==> Consul Deployments status:
977+
NAME | READY | AGE | CONTAINERS | IMAGES
978+
-------------------------------+--------+--------+--------------------------------------------------------+-------------------------------------
979+
consul-connect-injector | 1/1 | 4m0s | sidecar-injector | hashicorp/consul-k8s-control-plane:1.8.0
980+
consul-webhook-cert-manager | 1/1 | 4m0s | webhook-cert-manager | hashicorp/consul-k8s-control-plane:1.8.0
948981
```
949982

950983
### `troubleshoot`

‎content/consul/v1.19.x/content/docs/k8s/k8s-cli.mdx‎

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -906,7 +906,7 @@ cluster.consul-dataplane.circuit_breakers.high.rq_retry_open: 0
906906

907907
### `status`
908908

909-
The `status` command provides an overall status summary of the Consul on Kubernetes installation. It also provides the configuration that was used to deploy Consul K8s and information about the health of Consul servers and clients. This command does not take in any flags.
909+
The `status` command provides an overall status summary of the Consul on Kubernetes installation. It also provides the configuration that was used to deploy Consul K8s and information about Consul servers, clients and deployments. This command does not take in any flags.
910910

911911
```shell-session
912912
$ consul-k8s status
@@ -920,14 +920,32 @@ $ consul-k8s status
920920
==> Consul-K8s Status Summary
921921
NAME | NAMESPACE | STATUS | CHARTVERSION | APPVERSION | REVISION | LAST UPDATED
922922
---------+-----------+----------+--------------+------------+----------+--------------------------
923-
consul | consul | deployed | 0.41.1 | 1.11.4 | 1 | 2022/03/10 07:48:58 MST
923+
consul | consul | deployed | 1.8.0 | 1.11.4 | 1 | 2025/09/29 01:45:33 IST
924924
925925
==> Config:
926+
client:
927+
enabled: true
928+
replicas: 1
926929
connectInject:
927930
enabled: true
931+
controller:
932+
enabled: true
933+
global:
934+
dataCenter: galaxy
935+
image: hashicorp/consul:1.21
936+
imageEnvoy: envoyproxy/envoy:v1.20.2
928937
metrics:
929-
defaultEnableMerging: true
930-
defaultEnabled: true
938+
enabled: true
939+
name: consul
940+
prometheus:
941+
enabled: true
942+
server:
943+
replicas: 1
944+
ui:
945+
service:
946+
port:
947+
http: 8500
948+
type: LoadBalancer
931949
enableGatewayMetrics: true
932950
global:
933951
metrics:
@@ -943,8 +961,23 @@ $ consul-k8s status
943961
service:
944962
enabled: true
945963
946-
✓ Consul servers healthy (1/1)
947-
✓ Consul clients healthy (3/3)
964+
==> Status Of Helm Hooks:
965+
966+
==> Consul Clients status:
967+
NAME | READY | AGE | CONTAINERS | IMAGES
968+
---------------+--------+--------+----------------+-----------------------
969+
consul-client | 1/1 | 4m0s | consul | hashicorp/consul:1.21
970+
971+
==> Consul Servers status:
972+
NAME | READY | AGE | CONTAINERS | IMAGES
973+
---------------+--------+--------+----------------+-----------------------
974+
consul-server | 1/1 | 4m0s | consul | hashicorp/consul:1.21
975+
976+
==> Consul Deployments status:
977+
NAME | READY | AGE | CONTAINERS | IMAGES
978+
-------------------------------+--------+--------+--------------------------------------------------------+-------------------------------------
979+
consul-connect-injector | 1/1 | 4m0s | sidecar-injector | hashicorp/consul-k8s-control-plane:1.8.0
980+
consul-webhook-cert-manager | 1/1 | 4m0s | webhook-cert-manager | hashicorp/consul-k8s-control-plane:1.8.0
948981
```
949982

950983
### `troubleshoot`

‎content/consul/v1.22.x/content/docs/reference/cli/consul-k8s.mdx‎

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1380,7 +1380,7 @@ cluster.consul-dataplane.circuit_breakers.high.rq_retry_open: 0
13801380

13811381
### `status`
13821382

1383-
The `status` command provides an overall status summary of the Consul on Kubernetes installation. It also provides the configuration that was used to deploy Consul K8s and information about the health of Consul servers and clients. This command does not take in any flags.
1383+
The `status` command provides an overall status summary of the Consul on Kubernetes installation. It also provides the configuration that was used to deploy Consul K8s and information about Consul servers, clients and deployments. This command does not take in any flags.
13841384

13851385
```shell-session
13861386
$ consul-k8s status
@@ -1394,14 +1394,32 @@ $ consul-k8s status
13941394
==> Consul-K8s Status Summary
13951395
NAME | NAMESPACE | STATUS | CHARTVERSION | APPVERSION | REVISION | LAST UPDATED
13961396
---------+-----------+----------+--------------+------------+----------+--------------------------
1397-
consul | consul | deployed | 0.41.1 | 1.11.4 | 1 | 2022/03/10 07:48:58 MST
1397+
consul | consul | deployed | 1.8.0 | 1.11.4 | 1 | 2025/09/29 01:45:33 IST
13981398
13991399
==> Config:
1400+
client:
1401+
enabled: true
1402+
replicas: 1
14001403
connectInject:
14011404
enabled: true
1405+
controller:
1406+
enabled: true
1407+
global:
1408+
dataCenter: galaxy
1409+
image: hashicorp/consul:1.21
1410+
imageEnvoy: envoyproxy/envoy:v1.20.2
14021411
metrics:
1403-
defaultEnableMerging: true
1404-
defaultEnabled: true
1412+
enabled: true
1413+
name: consul
1414+
prometheus:
1415+
enabled: true
1416+
server:
1417+
replicas: 1
1418+
ui:
1419+
service:
1420+
port:
1421+
http: 8500
1422+
type: LoadBalancer
14051423
enableGatewayMetrics: true
14061424
global:
14071425
metrics:
@@ -1417,8 +1435,23 @@ $ consul-k8s status
14171435
service:
14181436
enabled: true
14191437
1420-
✓ Consul servers healthy (1/1)
1421-
✓ Consul clients healthy (3/3)
1438+
==> Status Of Helm Hooks:
1439+
1440+
==> Consul Clients status:
1441+
NAME | READY | AGE | CONTAINERS | IMAGES
1442+
---------------+--------+--------+----------------+-----------------------
1443+
consul-client | 1/1 | 4m0s | consul | hashicorp/consul:1.21
1444+
1445+
==> Consul Servers status:
1446+
NAME | READY | AGE | CONTAINERS | IMAGES
1447+
---------------+--------+--------+----------------+-----------------------
1448+
consul-server | 1/1 | 4m0s | consul | hashicorp/consul:1.21
1449+
1450+
==> Consul Deployments status:
1451+
NAME | READY | AGE | CONTAINERS | IMAGES
1452+
-------------------------------+--------+--------+--------------------------------------------------------+-------------------------------------
1453+
consul-connect-injector | 1/1 | 4m0s | sidecar-injector | hashicorp/consul-k8s-control-plane:1.8.0
1454+
consul-webhook-cert-manager | 1/1 | 4m0s | webhook-cert-manager | hashicorp/consul-k8s-control-plane:1.8.0
14221455
```
14231456

14241457
### `troubleshoot`

0 commit comments

Comments
 (0)