helm-wait

README

Helm Wait Plugin

This is a Helm plugin allowing to introduce wait conditions, e.g. in CI/CD pipelines before running integration tests, checking if all changes of a Helm install/ugrade step have been applied. It differs from the Helm wait option in that it checks if all pods of a stateful set or deployment have been replaced and are up and running.

The implementation of this plugin is inspired by the Helm Diff plugin and uses large portions of it for computing the diff between revisions of releases, so a lot of credits go to the contributors of that repository.

Usage

Usage:
  wait [command]

Available Commands:
  upgrade     Wait until all the changes of the current release have been applied

Commands:

upgrade:

$ helm wait upgrade -h
This command compares the current revision of the given release with its previous revision
and waits until all changes of the current revision have been applied.

Usage:
  wait upgrade [RELEASE]

Examples:
  helm wait upgrade my-release
  helm wait upgrade my-release --timeout 600

Install

Based on the version in plugin.yaml, release binary will be downloaded from GitHub:

$ helm plugin install https://github.com/Dieler/helm-wait.git

Build

$ git clone https://github.com/dieler/helm-wait.git
$ cd helm-wait
$ make install

The above will install this plugin into your $HELM_PLUGINS directory.

Prerequisites

• You need to have Go 1.21 installed.