feat: state values #647

mumoshu · 2019-06-04T07:21:59Z

This adds values to state files as proposed in #640.

values:
- key1: val1
- defaults.yaml

environments:
  default:
  - values:
    - environments/default.yaml
  production:
  - values:
    - environments/production.yaml

{{ .Valuese.key1 }} evaluates to val1 if and only if it is not overrode via the production or the default env, or command-line args.

Resolves #640

This adds `values` to state files as proposed in #640. ```yaml values: - key1: val1 - defaults.yaml environments: default: - values: - environments/default.yaml production: - values: - environments/production.yaml ``` `{{ .Valuese.key1 }}` evaluates to `val1` if and only if it is not overrode via the production or the default env, or command-line args. Resolves #640

mumoshu · 2019-06-04T07:36:26Z

@sgandon Unit tests are passing, but I'm not confident if it works.

Would you mind trying?

mumoshu · 2019-06-04T07:37:38Z

This is worth being followed-up with documentation updates once confirmed to work.

sgandon · 2019-06-05T06:56:49Z

@mumoshu I'll give it a try.

…gnable to type string Probably since #647 helmfile has been unable to merge nested maps in environment values if they were loaded from files. This fixes it. The relevant test is also enhanced so that no further regression like this happens. Fixes #677

…gnable to type string (#680) Probably since #647 helmfile has been unable to merge nested maps in environment values if they were loaded from files. This fixes it. The relevant test is also enhanced so that no further regression like this happens. Fixes #677

sgandon · 2019-06-13T11:34:07Z

From our initial tests this is working fine.

mumoshu · 2019-06-13T12:30:54Z

@sgandon Great! Thanks for reporting

dudicoco · 2019-12-18T08:31:06Z

Hi, this is a great feature that should be added to the documentation.
In addition, it seems that the exec function is not working within values.
The following is working when put into environment values but not when put into values:

files: {{ exec "sh" (list "-c" "find .. -name release.yaml | jq -R .| jq -s .") }}

mumoshu · 2019-12-18T09:00:08Z

@dudicoco Hey! Thanks for the feedback. Doc issue submitted: #1043

Re exec, what's the exact error you're seeing? It should work as long as you aren't doing fancy things with double-rendering.

dudicoco · 2019-12-18T09:58:35Z

@mumoshu the error is:
in ./helmfile.yaml: error during helmfile.yaml.part.0 parsing: template: stringTemplate:53:8: executing "stringTemplate" at <$.Values.test>: map has no entry for key "test"

Getting this even when performing a simple exec function:

values:
- test: {{ exec "sh" (list "-c" "echo test") }}

mumoshu · 2019-12-18T12:04:13Z

@dudicoco Where's your values section located? Please show me a fuller example so that I can see where things went wrong :)

mumoshu · 2019-12-18T12:10:49Z

Perhaps you're missing ---?

cat <<EOF > helmfile.yaml
values:
- test: {{ exec "sh" (list "-c" "echo test") }}
---
releases:
- name: myapp-{{ .Values.test }}
EOF

$ helmfile build

#  Source: helmfile.yaml

filepath: helmfile.yaml
values:
- test: test
releases:
- name: myapp-test
templates: {}

dudicoco · 2019-12-18T12:22:12Z

Adding --- resolved the issue, thanks!
Can you please explain the rendering behaviour?

mumoshu · 2019-12-18T12:28:26Z

Nice! Glad to hear it worked 😄

Regarding the behavior, this doesn't work:

values:
- test: {{ exec "sh" (list "-c" "echo test") }}
releases:
- name: myapp-{{ .Values.test }}

It's due to a chicken-and-egg problem. To render {{ .Values.test }}, Helmfile needs the value of .Values.test loaded. But to load .Values.test helmfile needs to parse helmfile.yaml as YAML. To parse it as YAML, it firstly renders it as a go template, but to render it you need the value of .Values.test...

mumoshu · 2019-12-18T12:30:09Z

#932 is the long term solution to avoid this (super unintuitive) behavior. I'd appreciate any feedback on the issue so that I am more confident with the solution and start implementing it.

dudicoco · 2019-12-19T08:38:06Z

Thanks for the info @mumoshu, i'll definitely checkout the issue when I get a chance.
As a side note, I noticed that when running helmfile build the helm repo password gets rendered (I've added it as requiredEnv). Is this intentional? I would assume it's best not to include sensitive information in the helmfile build output.

mumoshu · 2019-12-19T09:13:43Z

Yep it's intentional as of today. In near future I'd like to extend #906 to helmfile.yaml and state values, so that helmfile build output only contains references to secrets.

mumoshu · 2019-12-19T09:14:25Z

Thank you for the feedback though! It helps prioritizing what I should do next.

dudicoco · 2019-12-19T16:31:40Z

Thanks @mumoshu.
If I could pick your brain a bit more, I've tried converting the following:

files: {{ exec "sh" (list "-c" "find .. -name release.yaml | jq -R .| jq -s .") }}

To:

files: {{ exec "sh" (list "-c" "find .. -name release.yaml) | splitList "\n" }}

However, I end up with a list with no commas which I can't iterate over with the range function.
Any ideas how to handle this?
Thanks

mumoshu · 2019-12-19T23:32:40Z

I guess you would want this:

files:
{{ $f := range exec "sh" (list "-c" "find .. -name release.yaml) | splitList "\n" }}
- {{ $f }}
{{ end }}

dudicoco · 2019-12-20T06:37:29Z

Unfortunately it doesn't work:
"error during helmfile.yaml.part.0 parsing: template: stringTemplate:33: unexpected in command"

mumoshu · 2019-12-20T07:55:20Z

Sorry but that error doesn't make sense to me without context.

Are you by any chance just missing closing doublequote after release.yaml?

mumoshu · 2019-12-20T07:55:49Z

files:
{{ $i, $f := range exec "sh" (list "-c" "find .. -name release.yaml") | splitList "\n" }}
- {{ $f }}
{{ end }}

dudicoco · 2019-12-22T08:30:39Z

@mumoshu couldn't get it to work with the above, do you need any other information?

mumoshu · 2019-12-22T11:22:49Z

@dudicoco Hey! Would u mind sharing the output from helmfile --log-level=debug build in GitHub Gist?

dudicoco · 2019-12-22T15:37:52Z

processing file "helmfile.yaml" in directory "."
first-pass rendering starting for "helmfile.yaml.part.0": inherited=&{stagin~g map[] map[]}, overrode=<nil>
first-pass uses: &{stagin~g map[] map[]}
first-pass rendering input of "helmfile.yaml.part.0":
 0:
 1: helmDefaults:
 2:   # Additional and global args passed to helm.
 3:   args: []
 4:     # - "--set k=v"
 5:   # Wait for k8s resources.
 6:   wait: true
 7:   # Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks, and waits on pod/pvc/svc/deployment readiness).
 8:   timeout: 300
 9:   # Performs pods restart for the resource if applicable.
10:   recreatePods: false
11:   # Forces resource update through delete/recreate if patch fails.
12:   force: false
13:   # Restores previous state in case of failed release.
14:   atomic: false
15:   # Cleans up any new resources created during a failed release.
16:   cleanupOnFail: false
17:
18: repositories:
19: - name: stable
20:   url: https://kubernetes-charts.storage.googleapis.com
21: - name: incubator
22:   url: https://kubernetes-charts-incubator.storage.googleapis.com
23: - name: ****
24:   url: https://raw.githubusercontent.com/****
25:   username: {{ requiredEnv "GITHUB_USER" }}
26:   password: {{ requiredEnv "GITHUB_TOKEN"}}
27:
28: values:
29: {{ $command := printf "find . -name release-%s.yaml | jq -R .| jq -s ." .Environment.Name }}
30: - files: {{ exec "sh" (list "-c" $command) }}
31: - files2:
32: {{ $i, $f := range exec "sh" (list "-c" "find .. -name release.yaml") | splitList "\n" }}
33: - {{ $f }}
34: {{ end }}
35:
36: environments:
37:   {{ .Environment.Name }}:
38:     values:
39:     - ../global/global-values-{{ .Environment.Name }}.yaml
40:

template syntax error: template: stringTemplate:33: too many declarations in command
first-pass produced: &{stagin~g map[] map[]}
first-pass rendering result of "helmfile.yaml.part.0": {stagin~g map[] map[]}
second-pass rendering failed, input of "helmfile.yaml.part.0":
 0:
 1: helmDefaults:
 2:   # Additional and global args passed to helm.
 3:   args: []
 4:     # - "--set k=v"
 5:   # Wait for k8s resources.
 6:   wait: true
 7:   # Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks, and waits on pod/pvc/svc/deployment readiness).
 8:   timeout: 300
 9:   # Performs pods restart for the resource if applicable.
10:   recreatePods: false
11:   # Forces resource update through delete/recreate if patch fails.
12:   force: false
13:   # Restores previous state in case of failed release.
14:   atomic: false
15:   # Cleans up any new resources created during a failed release.
16:   cleanupOnFail: false
17:
18: repositories:
19: - name: stable
20:   url: https://kubernetes-charts.storage.googleapis.com
21: - name: incubator
22:   url: https://kubernetes-charts-incubator.storage.googleapis.com
23: - name: ****
24:   url: https://raw.githubusercontent.com/****
25:   username: {{ requiredEnv "GITHUB_USER" }}
26:   password: {{ requiredEnv "GITHUB_TOKEN"}}
27:
28: values:
29: {{ $command := printf "find . -name release-%s.yaml | jq -R .| jq -s ." .Environment.Name }}
30: - files: {{ exec "sh" (list "-c" $command) }}
31: - files2:
32: {{ $i, $f := range exec "sh" (list "-c" "find . -name release.yaml") | splitList "\n" }}
33: - {{ $f }}
34: {{ end }}
35:
36: environments:
37:   {{ .Environment.Name }}:
38:     values:
39:     - ../global/global-values-{{ .Environment.Name }}.yaml
40:

err: error during helmfile.yaml.part.0 parsing: template: stringTemplate:33: too many declarations in command
in ./helmfile.yaml: error during helmfile.yaml.part.0 parsing: template: stringTemplate:33: too many declarations in command

mumoshu · 2019-12-22T22:15:57Z

Ah sry it should be range $i, $f := rather than $i, $f := range

dudicoco · 2019-12-23T08:05:17Z

Thanks @mumoshu, it worked!
This is what I ended up with:

values:
{{ $command := printf "find . -name release-%s.yaml" .Environment.Name }}
- files:
  {{ range $i, $f := exec "sh" (list "-c" $command) | splitList " " }}
  - {{ $f }}
  {{ end }}

I think it's an amazing way to both load up all of your helmfiles and template them within your main helmfile.
This is due to the fact that the helmfiles: feature renders each file independently and doesn't allow you to define dependencies (needs) between releases nor does it allow you to template the helmfiles with native go templating.

dudicoco · 2019-12-23T08:17:23Z

Ok I spoke too soon :)
Seems that it doesn't work and I run into the exact same issue - I end up with a single list item:

values:
- files:
  - ./devops/php-myadmin/release.yaml
    ./devops/kibana/release.yaml
    ./devops/filebeat/release.yaml
    ./devops/cerebro/release.yaml

dudicoco · 2019-12-23T08:19:39Z

So the issue seems to be with splitList " ", if I use splitList "\n" I get a proper list but with an empty item at the end which causes an error.

dudicoco · 2019-12-23T08:31:35Z

Solved with the following:

- files:
  {{ range $i, $f := exec "sh" (list "-c" $command) | splitList "\n" }}
  {{ if $f }}
  - {{ $f }}
  {{ end }}
  {{ end }}

mumoshu mentioned this pull request Jun 4, 2019

Introduce State Values(Environment Values + Defaulting) #640

Closed

mumoshu force-pushed the state-values-with-defaulting branch from 157768d to 2beb703 Compare June 4, 2019 07:29

mumoshu force-pushed the state-values-with-defaulting branch from 2beb703 to 4ffb43a Compare June 4, 2019 07:32

mumoshu merged commit 3710f62 into master Jun 4, 2019

mumoshu deleted the state-values-with-defaulting branch June 4, 2019 07:34

mumoshu mentioned this pull request Jun 12, 2019

fix: --state-values-set panic: value of type interface {} is not assignable to type string #680

Merged

mumoshu mentioned this pull request Jun 27, 2019

Can helmfile be used to sync config to multiple clusters in one run? #728

Closed

mumoshu mentioned this pull request Aug 21, 2019

.Values vs .Environment.Values #816

Closed

mumoshu mentioned this pull request Dec 18, 2019

Add doc about state values #1043

Open

mojtabaimani mentioned this pull request Apr 20, 2021

Replace .Environment.Values with .Values linode/apl-core#412

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: state values #647

feat: state values #647

mumoshu commented Jun 4, 2019 •

edited

Loading

mumoshu commented Jun 4, 2019

mumoshu commented Jun 4, 2019

sgandon commented Jun 5, 2019

sgandon commented Jun 13, 2019

mumoshu commented Jun 13, 2019

dudicoco commented Dec 18, 2019 •

edited

Loading

mumoshu commented Dec 18, 2019

dudicoco commented Dec 18, 2019

mumoshu commented Dec 18, 2019

mumoshu commented Dec 18, 2019

dudicoco commented Dec 18, 2019

mumoshu commented Dec 18, 2019

mumoshu commented Dec 18, 2019

dudicoco commented Dec 19, 2019

mumoshu commented Dec 19, 2019

mumoshu commented Dec 19, 2019

dudicoco commented Dec 19, 2019

mumoshu commented Dec 19, 2019 •

edited

Loading

dudicoco commented Dec 20, 2019

mumoshu commented Dec 20, 2019

mumoshu commented Dec 20, 2019

dudicoco commented Dec 22, 2019

mumoshu commented Dec 22, 2019

dudicoco commented Dec 22, 2019

mumoshu commented Dec 22, 2019

dudicoco commented Dec 23, 2019

dudicoco commented Dec 23, 2019

dudicoco commented Dec 23, 2019 •

edited

Loading

dudicoco commented Dec 23, 2019

feat: state values #647

feat: state values #647

Conversation

mumoshu commented Jun 4, 2019 • edited Loading

mumoshu commented Jun 4, 2019

mumoshu commented Jun 4, 2019

sgandon commented Jun 5, 2019

sgandon commented Jun 13, 2019

mumoshu commented Jun 13, 2019

dudicoco commented Dec 18, 2019 • edited Loading

mumoshu commented Dec 18, 2019

dudicoco commented Dec 18, 2019

mumoshu commented Dec 18, 2019

mumoshu commented Dec 18, 2019

dudicoco commented Dec 18, 2019

mumoshu commented Dec 18, 2019

mumoshu commented Dec 18, 2019

dudicoco commented Dec 19, 2019

mumoshu commented Dec 19, 2019

mumoshu commented Dec 19, 2019

dudicoco commented Dec 19, 2019

mumoshu commented Dec 19, 2019 • edited Loading

dudicoco commented Dec 20, 2019

mumoshu commented Dec 20, 2019

mumoshu commented Dec 20, 2019

dudicoco commented Dec 22, 2019

mumoshu commented Dec 22, 2019

dudicoco commented Dec 22, 2019

mumoshu commented Dec 22, 2019

dudicoco commented Dec 23, 2019

dudicoco commented Dec 23, 2019

dudicoco commented Dec 23, 2019 • edited Loading

dudicoco commented Dec 23, 2019

mumoshu commented Jun 4, 2019 •

edited

Loading

dudicoco commented Dec 18, 2019 •

edited

Loading

mumoshu commented Dec 19, 2019 •

edited

Loading

dudicoco commented Dec 23, 2019 •

edited

Loading