From 9cc0cff07fa071bfeb2d864162113740d7120948 Mon Sep 17 00:00:00 2001 From: Felipe Santos Date: Fri, 16 Dec 2022 07:03:08 -0300 Subject: [PATCH] Clarify postsync hooks docs (#585) Signed-off-by: Felipe Santos Signed-off-by: Felipe Santos --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 1501cc88..46b56f00 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1243,7 +1243,7 @@ Currently supported `events` are: Hooks associated to `prepare` events are triggered after each release in your helmfile is loaded from YAML, before execution. `prepare` hooks are triggered on the release as long as it is not excluded by the helmfile selector(e.g. `helmfile -l key=value`). -Hooks associated to `presync` events are triggered before each release is installed or upgraded on the remote cluster. +Hooks associated to `presync` events are triggered before each release is synced (installed or upgraded) on the cluster. This is the ideal event to execute any commands that may mutate the cluster state as it will not be run for read-only operations like `lint`, `diff` or `template`. `preapply` hooks are triggered before a release is uninstalled, installed, or upgraded as part of `helmfile apply`. @@ -1253,7 +1253,7 @@ This is the ideal event to hook into when you are going to use `helmfile apply` `postuninstall` hooks are triggered immediately after successful uninstall of a release while running `helmfile apply`, `helmfile sync`, `helmfile delete`, `helmfile destroy`. -`postsync` hooks are triggered after each release is synced(installed, updated, or uninstalled) to/from the cluster, regardless of the sync was successful or not. +`postsync` hooks are triggered after each release is synced (installed or upgraded) on the cluster, regardless if the sync was successful or not. This is the ideal place to execute any commands that may mutate the cluster state as it will not be run for read-only operations like `lint`, `diff` or `template`. `cleanup` hooks are triggered after each release is processed.