Skip to main content

Overview

View and manage Kubernetes clusters in your Qovery organization.

Commands

List Clusters

List all clusters in current organization:
qovery cluster list

Cluster Status

Get detailed cluster status:
qovery cluster status --cluster "cluster-id"

Cluster Info

Get cluster information:
qovery cluster info --cluster "cluster-id"

Download Kubeconfig

Download kubeconfig file for kubectl access:
qovery cluster kubeconfig --cluster-id "cluster-id"
This command generates a kubeconfig file that allows you to connect to your cluster using kubectl.

Open Debug Pod

Launch an interactive debug pod with kubectl pre-configured:
qovery cluster debug-pod \
  --organization-id "org-id" \
  --cluster-id "cluster-id"
This opens a debug shell inside your cluster with kubectl access, perfect for troubleshooting.

Options

FlagDescription
--clusterCluster ID or name
--organizationOrganization ID or name
--outputOutput format (table, json, yaml)
--helpShow help

Examples

List All Clusters

# Set organization context
qovery context set --organization "My Org"

# List clusters
qovery cluster list

# Example output:
# NAME           REGION        CLOUD     STATUS    VERSION
# prod-us-east   us-east-1     AWS       Running   1.28
# staging-eu     eu-west-1     AWS       Running   1.27

Check Cluster Status

# Get detailed status
qovery cluster status --cluster "prod-us-east"

# Get JSON output
qovery cluster status \
  --cluster "prod-us-east" \
  --format json

View Cluster Details

# Get cluster info
qovery cluster info --cluster "prod-us-east"

Get kubectl Access

# Download kubeconfig file
qovery cluster kubeconfig --cluster-id "abc123"

# Set kubectl to use the downloaded config
export KUBECONFIG=./kubeconfig-abc123.yaml

# Test connection
kubectl get nodes

Open Debug Pod for Troubleshooting

# Launch debug pod
qovery cluster debug-pod \
  --organization-id "org-abc123" \
  --cluster-id "cluster-abc123"

# Inside the debug pod, you can run kubectl commands:
# kubectl get pods --all-namespaces
# kubectl logs <pod-name> -n <namespace>
# exit

Cluster Status Values

StatusDescription
RUNNINGCluster is operational
DEPLOYINGCluster is being deployed
WARNINGCluster has warnings
ERRORCluster has errors
DELETINGCluster is being deleted

Tips

Use cluster commands to verify cluster health before deploying applications.
Check cluster status regularly to ensure your infrastructure is healthy.
Use qovery cluster kubeconfig to get full kubectl access to your cluster for advanced operations.
The debug-pod command is perfect for quick troubleshooting without needing to configure kubectl locally.