feat: `prepare` and `cleanup` release event hooks #349

mumoshu · 2018-09-19T09:50:54Z

Resolves #295
Resolves #330
Resolves #329 (Supports templating of only releases[].hooks[].command and args right now
Resolves #324

davidovich · 2018-09-19T13:13:24Z

README.md

@@ -593,6 +593,61 @@ mysetting: |

 The possibility is endless. Try importing values from your golang app, bash script, jsonnet, or anything!

+## Hooks
+
+Hook is an per-release extension point of helmfile that is composed of:


What about this formulation?

A helmfile hook is a per-release extension point that is composed of:

Sounds great!

davidovich · 2018-09-19T13:14:27Z

README.md

+- `args`
+
+helmfile triggers various `events` while it is running.
+One `events` are triggered, associated `hooks` are executed, by running the `command` with `args`. 


s/One/Once/

davidovich · 2018-09-19T13:26:23Z

README.md

+  chart: mychart
+  # *snip*
+  hooks:
+  - events: ["prepare", "cleanup"]


Is there a technical reason you didn't go with this the structure proposed in #330?:

hooks: preChartLoad: # register as many commands as you want to this hook - command: {{` ./chartify -e {{ .Environment.Name }} {{ .Chart }} `}}

I see that you would want to register the same command for a specific hook, but that seems to be over generic (I believe it is more common to have differing calls on each event, than the same call on multiple events).

YAML anchors could come handy if you have the same command on multiple events.

The preChartLoad schema is verifiable at load time.

Good catch! Indeed my intention was to make it even more generic with (hopefully) comparable complexity to the third option in my proposal.

I believe it is more common to have differing calls on each event, than the same call on multiple events

I think so too. My intention here was to provide the most DRY way to support this use-case:

To be able to use the same script to implement multiple hooks the name of the hook should also be passed along.

See #295 (comment) for more context.

The preChartLoad schema is verifiable at load time.

Good point! I was thinking to add validation for unsupported events. That is, events: ["foo"] results in an error like unsupported event to hook: foo.

And I wasn't sure if "eventsare the only possible hook target in helmfile. Googling around, the termhook` seems to be used for NOT only for expressing extension points associated to events. For example, something like "action hook" can be considered:

hooks: - actions: ["lint"] command: ...

An event hook reacts on specific event and doesn't have ability to return data from the hook to helmfile.

An action hook, on the other hand, could be used for passing data from the hook to helmfile, in an output format helmfile expects for the specific action. In the above example, the lint action hook can return a specifically formatted json to add lint results that are integrated into the original output of helmfile lint.

Explicitly wording hook targets as events prevents ambiguity and creates future possibility like this.

davidovich · 2018-09-19T13:33:05Z

small nit: (title contains a typo: faet) and one issue will not be closed: Resolevs #324

davidovich · 2018-09-19T13:58:54Z

README.md

+
+Run `helmfile --environment staging sync` and see it results in helmfile running `kustomize build foo-kustomize/overlays/staging > foo/templates/all.yaml`.
+
+Viola! You can mix helm releases that are backed by remote charts, local charts, and even kustomize overlays.


s/Viola/Voilà/

Good catch! Thanks. Fixed in the latest commit.

davidovich · 2018-09-19T14:03:08Z

helmexec/runner.go


 // Execute a shell command
 func (shell ShellRunner) Execute(cmd string, args []string) ([]byte, error) {
 	preparedCmd := exec.Command(cmd, args...)
+	if shell.Dir != "" {
+		preparedCmd.Dir = shell.Dir


What do you think about setting preparedCmd.Dir unconditionally? It's default value is the empty string.

I believe we shouldn't, because we use it to run helm commands and it assumes Dir unspecified today.

What I meant is that the condition is not necessary:

if shell.Dir is empty, assign (it won't change the default of preparedCmd which is empty)
if shell.Dir is not empty, assign (as you you in the condition)

Ah makes sense! I'll fix it asap. Thanks for your review!

helmexec/runner.go

davidovich · 2018-09-19T14:27:07Z

state/hook.go

+		allargs := []string{}
+		allargs = append(allargs, command[1:]...)
+		allargs = append(allargs, args...)
+		bytes, err := state.runner.Execute(command[0], allargs)


command is a slice, but only the first one is executed. How does that work if the user specifies multiple commands ?

command: ["echo", "helm"] args: ["hello", "world", "list"]

What do you think about these UIs?:

command: ["command", "arg1", "arg2"]

or

commands: - cmd: "helm" args: "list"

Trailing items in the command array is considerd args. I made it so to make it consistent with k8s pod spec, hoping it is easy to remember along with it.

OK, but the podSpec is meant to override CMD and ENTRYPOINTS of containers. Not sure the model applies. Your call :-)

Good point! Maybe blindly trying to make it consistent with pod spec doesn't make sense. I'll just make it a singular value. Thanks a lot for your comments 👍

davidovich · 2018-09-19T15:04:24Z

I believe this change could benefit from additional tests.

mumoshu · 2018-09-20T02:36:29Z

@davidovich I've added tests and some tweaks. Would you mind confirming? Thanks!

davidovich · 2018-09-20T02:52:49Z

Will have a look tomorrow morning Le mer. 19 sept. 2018 à 22:36, KUOKA Yusuke <notifications@github.com> a écrit :

…

@davidovich <https://github.com/davidovich> I've added tests and some tweaks. Would you mind confirming? Thanks! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#349 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABX6cuEWk-7ps693ETdIOCIxAtz_FlNPks5ucv8tgaJpZM4Wvzqj> .

davidovich

Only one comment on the readme

LGTM!

davidovich · 2018-09-20T11:06:41Z

README.md

+  # *snip*
+  hooks:
+  - events: ["prepare", "cleanup"]
+    command: ["echo"]


Upon your latest changes, I believe this is not an array anymore, what do you think?

Good catch! I'll fix it asap.

Resolves roboll#295 Resolves roboll#330 Resolves roboll#329 (Supports templating of only `releases[].hooks[].command` and `args` right now Resolves roboll#324

mumoshu · 2018-09-21T01:35:25Z

@davidovich Thanks a lot for your review ☺️

mumoshu force-pushed the prepare-cleanup-release-evt-hooks branch from 0ab9eef to 5856c64 Compare September 19, 2018 09:52

davidovich reviewed Sep 19, 2018

View reviewed changes

mumoshu force-pushed the prepare-cleanup-release-evt-hooks branch from 5856c64 to f6a9576 Compare September 19, 2018 13:52

davidovich reviewed Sep 19, 2018

View reviewed changes

mumoshu changed the title ~~faet: prepare and cleanup release event hooks~~ feat: prepare and cleanup release event hooks Sep 19, 2018

mumoshu force-pushed the prepare-cleanup-release-evt-hooks branch from f6a9576 to 8886038 Compare September 19, 2018 14:07

davidovich reviewed Sep 19, 2018

View reviewed changes

mumoshu force-pushed the prepare-cleanup-release-evt-hooks branch from 8886038 to 5e528c0 Compare September 20, 2018 02:32

davidovich approved these changes Sep 20, 2018

View reviewed changes

feat: prepare and cleanup release event hooks

5c67644

Resolves roboll#295 Resolves roboll#330 Resolves roboll#329 (Supports templating of only `releases[].hooks[].command` and `args` right now Resolves roboll#324

mumoshu force-pushed the prepare-cleanup-release-evt-hooks branch from 5e528c0 to 5c67644 Compare September 21, 2018 01:22

mumoshu merged commit b9de22b into roboll:master Sep 21, 2018

mumoshu deleted the prepare-cleanup-release-evt-hooks branch September 21, 2018 01:35

This was referenced Sep 21, 2018

Use values/secrets from within a remote chart #324

Closed

Proposal: Package helmfile.yaml along with charts and values files #195

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: `prepare` and `cleanup` release event hooks #349

feat: `prepare` and `cleanup` release event hooks #349

mumoshu commented Sep 19, 2018 •

edited

Loading

davidovich Sep 19, 2018

mumoshu Sep 19, 2018

davidovich Sep 19, 2018

davidovich Sep 19, 2018

mumoshu Sep 19, 2018

mumoshu Sep 19, 2018

davidovich commented Sep 19, 2018

davidovich Sep 19, 2018

mumoshu Sep 19, 2018

davidovich Sep 19, 2018

mumoshu Sep 19, 2018

davidovich Sep 19, 2018

mumoshu Sep 19, 2018 •

edited

Loading

davidovich Sep 19, 2018

mumoshu Sep 19, 2018

davidovich Sep 19, 2018

mumoshu Sep 20, 2018

davidovich commented Sep 19, 2018

mumoshu commented Sep 20, 2018

davidovich commented Sep 20, 2018 via email

davidovich left a comment

davidovich Sep 20, 2018

mumoshu Sep 21, 2018

mumoshu commented Sep 21, 2018


		Run `helmfile --environment staging sync` and see it results in helmfile running `kustomize build foo-kustomize/overlays/staging > foo/templates/all.yaml`.

		Viola! You can mix helm releases that are backed by remote charts, local charts, and even kustomize overlays.

feat: prepare and cleanup release event hooks #349

feat: prepare and cleanup release event hooks #349

Conversation

mumoshu commented Sep 19, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidovich commented Sep 19, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mumoshu Sep 19, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidovich commented Sep 19, 2018

mumoshu commented Sep 20, 2018

davidovich commented Sep 20, 2018 via email

davidovich left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mumoshu commented Sep 21, 2018

feat: `prepare` and `cleanup` release event hooks #349

feat: `prepare` and `cleanup` release event hooks #349

mumoshu commented Sep 19, 2018 •

edited

Loading

mumoshu Sep 19, 2018 •

edited

Loading