✦ For everyone, free.

Practical knowledge for real and everyday life

Home

Release Status

Release Status shows a Helm release's current state, indicating if it's deployed, updated, or failed.

Release Status represents the current state of a Helm release within a Kubernetes cluster. It provides detailed information about the deployment and health of the release, indicating whether the release is deployed correctly, pending, failed, or in any other state. This status helps operators and automated systems assess the lifecycle phase and operational condition of the release.

Overview of Release Status

The Release Status is a snapshot of the Helm chart deployment's condition, capturing the phase of the release from installation through upgrades or rollbacks, and eventual deletion. It reflects the success or failure of the release process and ongoing stability.

Key facets typically included in the Release Status are:

  • The release name and namespace
  • The version of the chart deployed
  • The app version of the software being managed
  • The timestamp of the last deployment or update
  • The current lifecycle state (status)
  • A description or message providing context or error details
  • Information about deployed Kubernetes resources

Common Release Status Values

deployed

Indicates that the Helm release was successfully installed or upgraded and is currently active and running. All associated Kubernetes resources are expected to be in a ready or stable state.

failed

Signals that an error occurred during installation, upgrade, or rollback. The release is not considered healthy, and the failure message often contains details about the cause, such as resource conflicts, missing dependencies, or validation errors.

pending-install / pending-upgrade / pending-rollback

Represents transitional phases while Helm is processing the release operation:

  • pending-install: The release installation is in progress but not yet complete.
  • pending-upgrade: An upgrade operation is underway.
  • pending-rollback: A rollback to a previous release version is in progress.

These statuses indicate that the release is not yet stable.

uninstalling

Specifies that the release is being deleted from the cluster and Kubernetes resources are being removed.

superseded

Used for releases that have been replaced by a newer version after an upgrade but still retained in Helm's history for rollback purposes.

unknown

Indicates that Helm cannot determine the release status, possibly due to issues communicating with the cluster or missing release data.

Components of Release Status Output

When querying the status of a release via the Helm CLI (helm status <release-name>) or through Helm APIs, the output typically includes several sections:

General Information

  • Name: The release name.
  • Namespace: Kubernetes namespace where the release is deployed.
  • Status: The current release status (e.g., deployed, failed).
  • Revision: The revision number of the release, incremented with each update.
  • Updated: Timestamp of the last update to the release.
  • Chart: The name and version of the Helm chart deployed.
  • App Version: The version of the application contained within the chart.

Notes

This section may contain instructions or messages from the chart maintainer, such as how to access the deployed service or next steps after deployment.

Kubernetes Resources

A summary of Kubernetes objects managed by the release, including Deployments, Services, ConfigMaps, Secrets, etc., often with their current state (e.g., running, pending, failed).

Hooks

Information about Helm hooks invoked during the release lifecycle (e.g., pre-install, post-upgrade), including their execution status.

Role of Release Status in Helm Operations

Release Status is crucial for:

  • Monitoring and troubleshooting: Quickly identifying whether a release is healthy or requires intervention.
  • Automation and CI/CD pipelines: Triggering subsequent steps based on success or failure.
  • Rollbacks and rollouts: Determining whether to revert to a previous release version.
  • Audit and history tracking: Understanding deployment history and changes over time.

Example of Helm Release Status Output

$ helm status my-release
NAME: my-release
LAST DEPLOYED: 2024-06-01 12:34:56.789012345 +0000 UTC
NAMESPACE: default
STATUS: deployed
REVISION: 3
NOTES:
1. Get the application URL by running these commands:
  export SERVICE_IP=$(kubectl get svc --namespace default my-service -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
  echo "Visit http://$SERVICE_IP:8080"

RESOURCES:
==> v1/Service
NAME            TYPE       CLUSTER-IP     EXTERNAL-IP   PORT(S)          AGE
my-release-svc  ClusterIP  10.96.0.1      <none>        80/TCP           5m

==> v1/Deployment
NAME               READY  UP-TO-DATE  AVAILABLE  AGE
my-release-deploy  3/3    3           3          5m

Summary of Key Points

  • Release Status is the definitive indicator of a Helm release's condition in a Kubernetes environment.
  • It encompasses detailed metadata, lifecycle state, resource health, and diagnostic messages.
  • Status values such as deployed, failed, pending, and uninstalling describe the release timeline and health.
  • The status output helps operators and automation systems manage application deployments effectively.
  • Understanding Release Status is critical for ensuring reliable, observable, and maintainable deployments using Helm.

Related content