Skip to content

Update consul-k8s cli status command docs #1310

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Dec 3, 2025
+156 −24
Merged

Update consul-k8s cli status command docs #1310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f7a7df2
update consul-k8s cli status command docs
LordAbhishek Nov 16, 2025
5b72667
replicating the docs changes for other versions too
LordAbhishek Nov 18, 2025
06ad454
Merge branch 'main' into abhishek/consul-k8s-cli-status-docs
LordAbhishek Dec 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 39 additions & 6 deletions content/consul/v1.17.x/content/docs/k8s/k8s-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -906,7 +906,7 @@ cluster.consul-dataplane.circuit_breakers.high.rq_retry_open: 0

### `status`

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.
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.

```shell-session
$ consul-k8s status
Expand All @@ -920,14 +920,32 @@ $ consul-k8s status
==> Consul-K8s Status Summary
NAME | NAMESPACE | STATUS | CHARTVERSION | APPVERSION | REVISION | LAST UPDATED
---------+-----------+----------+--------------+------------+----------+--------------------------
consul | consul | deployed | 0.41.1 | 1.11.4 | 1 | 2022/03/10 07:48:58 MST
consul | consul | deployed | 1.8.0 | 1.11.4 | 1 | 2025/09/29 01:45:33 IST

==> Config:
client:
enabled: true
replicas: 1
connectInject:
enabled: true
controller:
enabled: true
global:
dataCenter: galaxy
image: hashicorp/consul:1.21
imageEnvoy: envoyproxy/envoy:v1.20.2
metrics:
defaultEnableMerging: true
defaultEnabled: true
enabled: true
name: consul
prometheus:
enabled: true
server:
replicas: 1
ui:
service:
port:
http: 8500
type: LoadBalancer
enableGatewayMetrics: true
global:
metrics:
Expand All @@ -943,8 +961,23 @@ $ consul-k8s status
service:
enabled: true

✓ Consul servers healthy (1/1)
✓ Consul clients healthy (3/3)
==> Status Of Helm Hooks:

==> Consul Clients status:
NAME | READY | AGE | CONTAINERS | IMAGES
---------------+--------+--------+----------------+-----------------------
consul-client | 1/1 | 4m0s | consul | hashicorp/consul:1.21

==> Consul Servers status:
NAME | READY | AGE | CONTAINERS | IMAGES
---------------+--------+--------+----------------+-----------------------
consul-server | 1/1 | 4m0s | consul | hashicorp/consul:1.21

==> Consul Deployments status:
NAME | READY | AGE | CONTAINERS | IMAGES
-------------------------------+--------+--------+--------------------------------------------------------+-------------------------------------
consul-connect-injector | 1/1 | 4m0s | sidecar-injector | hashicorp/consul-k8s-control-plane:1.8.0
consul-webhook-cert-manager | 1/1 | 4m0s | webhook-cert-manager | hashicorp/consul-k8s-control-plane:1.8.0
```

### `troubleshoot`
Expand Down
45 changes: 39 additions & 6 deletions content/consul/v1.18.x/content/docs/k8s/k8s-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -906,7 +906,7 @@ cluster.consul-dataplane.circuit_breakers.high.rq_retry_open: 0

### `status`

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.
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.

```shell-session
$ consul-k8s status
Expand All @@ -920,14 +920,32 @@ $ consul-k8s status
==> Consul-K8s Status Summary
NAME | NAMESPACE | STATUS | CHARTVERSION | APPVERSION | REVISION | LAST UPDATED
---------+-----------+----------+--------------+------------+----------+--------------------------
consul | consul | deployed | 0.41.1 | 1.11.4 | 1 | 2022/03/10 07:48:58 MST
consul | consul | deployed | 1.8.0 | 1.11.4 | 1 | 2025/09/29 01:45:33 IST

==> Config:
client:
enabled: true
replicas: 1
connectInject:
enabled: true
controller:
enabled: true
global:
dataCenter: galaxy
image: hashicorp/consul:1.21
imageEnvoy: envoyproxy/envoy:v1.20.2
metrics:
defaultEnableMerging: true
defaultEnabled: true
enabled: true
name: consul
prometheus:
enabled: true
server:
replicas: 1
ui:
service:
port:
http: 8500
type: LoadBalancer
enableGatewayMetrics: true
global:
metrics:
Expand All @@ -943,8 +961,23 @@ $ consul-k8s status
service:
enabled: true

✓ Consul servers healthy (1/1)
✓ Consul clients healthy (3/3)
==> Status Of Helm Hooks:

==> Consul Clients status:
NAME | READY | AGE | CONTAINERS | IMAGES
---------------+--------+--------+----------------+-----------------------
consul-client | 1/1 | 4m0s | consul | hashicorp/consul:1.21

==> Consul Servers status:
NAME | READY | AGE | CONTAINERS | IMAGES
---------------+--------+--------+----------------+-----------------------
consul-server | 1/1 | 4m0s | consul | hashicorp/consul:1.21

==> Consul Deployments status:
NAME | READY | AGE | CONTAINERS | IMAGES
-------------------------------+--------+--------+--------------------------------------------------------+-------------------------------------
consul-connect-injector | 1/1 | 4m0s | sidecar-injector | hashicorp/consul-k8s-control-plane:1.8.0
consul-webhook-cert-manager | 1/1 | 4m0s | webhook-cert-manager | hashicorp/consul-k8s-control-plane:1.8.0
```

### `troubleshoot`
Expand Down
45 changes: 39 additions & 6 deletions content/consul/v1.19.x/content/docs/k8s/k8s-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -906,7 +906,7 @@ cluster.consul-dataplane.circuit_breakers.high.rq_retry_open: 0

### `status`

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.
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.

```shell-session
$ consul-k8s status
Expand All @@ -920,14 +920,32 @@ $ consul-k8s status
==> Consul-K8s Status Summary
NAME | NAMESPACE | STATUS | CHARTVERSION | APPVERSION | REVISION | LAST UPDATED
---------+-----------+----------+--------------+------------+----------+--------------------------
consul | consul | deployed | 0.41.1 | 1.11.4 | 1 | 2022/03/10 07:48:58 MST
consul | consul | deployed | 1.8.0 | 1.11.4 | 1 | 2025/09/29 01:45:33 IST

==> Config:
client:
enabled: true
replicas: 1
connectInject:
enabled: true
controller:
enabled: true
global:
dataCenter: galaxy
image: hashicorp/consul:1.21
imageEnvoy: envoyproxy/envoy:v1.20.2
metrics:
defaultEnableMerging: true
defaultEnabled: true
enabled: true
name: consul
prometheus:
enabled: true
server:
replicas: 1
ui:
service:
port:
http: 8500
type: LoadBalancer
enableGatewayMetrics: true
global:
metrics:
Expand All @@ -943,8 +961,23 @@ $ consul-k8s status
service:
enabled: true

✓ Consul servers healthy (1/1)
✓ Consul clients healthy (3/3)
==> Status Of Helm Hooks:

==> Consul Clients status:
NAME | READY | AGE | CONTAINERS | IMAGES
---------------+--------+--------+----------------+-----------------------
consul-client | 1/1 | 4m0s | consul | hashicorp/consul:1.21

==> Consul Servers status:
NAME | READY | AGE | CONTAINERS | IMAGES
---------------+--------+--------+----------------+-----------------------
consul-server | 1/1 | 4m0s | consul | hashicorp/consul:1.21

==> Consul Deployments status:
NAME | READY | AGE | CONTAINERS | IMAGES
-------------------------------+--------+--------+--------------------------------------------------------+-------------------------------------
consul-connect-injector | 1/1 | 4m0s | sidecar-injector | hashicorp/consul-k8s-control-plane:1.8.0
consul-webhook-cert-manager | 1/1 | 4m0s | webhook-cert-manager | hashicorp/consul-k8s-control-plane:1.8.0
```

### `troubleshoot`
Expand Down
45 changes: 39 additions & 6 deletions content/consul/v1.22.x/content/docs/reference/cli/consul-k8s.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1096,7 +1096,7 @@ cluster.consul-dataplane.circuit_breakers.high.rq_retry_open: 0

### `status`

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.
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.

```shell-session
$ consul-k8s status
Expand All @@ -1110,14 +1110,32 @@ $ consul-k8s status
==> Consul-K8s Status Summary
NAME | NAMESPACE | STATUS | CHARTVERSION | APPVERSION | REVISION | LAST UPDATED
---------+-----------+----------+--------------+------------+----------+--------------------------
consul | consul | deployed | 0.41.1 | 1.11.4 | 1 | 2022/03/10 07:48:58 MST
consul | consul | deployed | 1.8.0 | 1.11.4 | 1 | 2025/09/29 01:45:33 IST

==> Config:
client:
enabled: true
replicas: 1
connectInject:
enabled: true
controller:
enabled: true
global:
dataCenter: galaxy
image: hashicorp/consul:1.21
imageEnvoy: envoyproxy/envoy:v1.20.2
metrics:
defaultEnableMerging: true
defaultEnabled: true
enabled: true
name: consul
prometheus:
enabled: true
server:
replicas: 1
ui:
service:
port:
http: 8500
type: LoadBalancer
enableGatewayMetrics: true
global:
metrics:
Expand All @@ -1133,8 +1151,23 @@ $ consul-k8s status
service:
enabled: true

✓ Consul servers healthy (1/1)
✓ Consul clients healthy (3/3)
==> Status Of Helm Hooks:

==> Consul Clients status:
NAME | READY | AGE | CONTAINERS | IMAGES
---------------+--------+--------+----------------+-----------------------
consul-client | 1/1 | 4m0s | consul | hashicorp/consul:1.21

==> Consul Servers status:
NAME | READY | AGE | CONTAINERS | IMAGES
---------------+--------+--------+----------------+-----------------------
consul-server | 1/1 | 4m0s | consul | hashicorp/consul:1.21

==> Consul Deployments status:
NAME | READY | AGE | CONTAINERS | IMAGES
-------------------------------+--------+--------+--------------------------------------------------------+-------------------------------------
consul-connect-injector | 1/1 | 4m0s | sidecar-injector | hashicorp/consul-k8s-control-plane:1.8.0
consul-webhook-cert-manager | 1/1 | 4m0s | webhook-cert-manager | hashicorp/consul-k8s-control-plane:1.8.0
```

### `troubleshoot`
Expand Down
Loading