Commit Graph

188 Commits

Author SHA1 Message Date
koralsky fc634c9ee3
feat: Reset values flag (#602)
Ref https://github.com/helmfile/helmfile/discussions/593

* implemented --reset-values flag overriding .helmDefaults.reuseValues=true
* tests for --reset-values flag
* fixed pkg/app tests
* added tests for both reset & reuse flags given
* added appendValuesControlMode method for --reuse/reset-values flag processing
* updated code comments & docs

Signed-off-by: Karol Ossowski <k@koralsky.pl>
2023-01-17 09:34:37 +09:00
xiaomudk c4eb62388b
Drop Helm v2 support (#613)
Resolves #589

Signed-off-by: xiaomudk <xiaomudk@gmail.com>
2023-01-17 09:24:47 +09:00
dependabot[bot] fdfa520f1b
build(deps): bump gitpython from 3.1.27 to 3.1.30 in /docs (#618)
Bumps [gitpython](https://github.com/gitpython-developers/GitPython) from 3.1.27 to 3.1.30.
- [Release notes](https://github.com/gitpython-developers/GitPython/releases)
- [Changelog](https://github.com/gitpython-developers/GitPython/blob/main/CHANGES)
- [Commits](https://github.com/gitpython-developers/GitPython/compare/3.1.27...3.1.30)

---
updated-dependencies:
- dependency-name: gitpython
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-01-06 09:26:37 +08:00
Yusuke Kuoka 490bb5d147
feat: `inherit` field for release template inheritance (#606)
* feat: `inherit` field for release template inheritance

Ref https://github.com/helmfile/helmfile/issues/435#issuecomment-1364749414

Signed-off-by: Yusuke Kuoka <ykuoka@gmail.com>

* Fix wording

Signed-off-by: Yusuke Kuoka <ykuoka@gmail.com>

* Comment on releaseWithInheritedTemplate

Signed-off-by: Yusuke Kuoka <ykuoka@gmail.com>

* Update Release Template doc with the new `inherit` feature

Signed-off-by: Yusuke Kuoka <ykuoka@gmail.com>

* Fix a typo in code comment

Signed-off-by: Yusuke Kuoka <ykuoka@gmail.com>

Signed-off-by: Yusuke Kuoka <ykuoka@gmail.com>
2022-12-28 10:01:04 +09:00
yxxhero eb810c6c0c
add goreportcard (#595)
Signed-off-by: yxxhero <aiopsclub@163.com>
2022-12-21 23:46:31 +08:00
Yusuke Kuoka 8ec51c2826
doc: Remove HELMFILE_SKIP_INSECURE_TEMPLATE_FUNCTIONS in Helmfile v1 (#590) 2022-12-19 07:38:43 +08:00
Felipe Santos 9cc0cff07f
Clarify postsync hooks docs (#585)
Signed-off-by: Felipe Santos <felipecassiors@gmail.com>

Signed-off-by: Felipe Santos <felipecassiors@gmail.com>
2022-12-16 19:03:08 +09:00
yxxhero 7410316cf9
update postrenderer docs (#580)
Signed-off-by: yxxhero <aiopsclub@163.com>

Signed-off-by: yxxhero <aiopsclub@163.com>
2022-12-15 11:50:18 +08:00
Quan TRAN 73134d8a70 Add documentation on go-getter cache
Signed-off-by: Quan TRAN <account@itscaro.me>
Signed-off-by: yxxhero <aiopsclub@163.com>
2022-12-13 13:12:07 +08:00
xiaomudk 94381c1e17
Fix preapply hooks are not called on no diff when run apply subcommand (#522)
* Fix presync hooks are not called on no diff when run apply subcommand

Signed-off-by: xiaomudk <xiaomudk@gmail.com>

* Update docs/index.md

Co-authored-by: Yusuke Kuoka <ykuoka@gmail.com>
Signed-off-by: xiaomudk <xiaomudk@gmail.com>

Signed-off-by: xiaomudk <xiaomudk@gmail.com>
Co-authored-by: Yusuke Kuoka <ykuoka@gmail.com>
2022-12-10 12:07:26 +09:00
Quan TRAN 398c812e49
Use go-getter with secrets as well (#560)
* Use go-getter with secrets as well

Signed-off-by: Quan TRAN <account@itscaro.me>
2022-12-09 07:46:28 +08:00
yxxhero 181c2f4509
fix ghcr-badge in docs (#539)
Signed-off-by: yxxhero <aiopsclub@163.com>

Signed-off-by: yxxhero <aiopsclub@163.com>
2022-11-25 10:12:11 +09:00
xiaomudk 7844145ee3
Allow helmfile statefile to passed by stdin (#520)
* Allow helmfile statefile to passed by stdin

Signed-off-by: xiaomudk <xiaomudk@gmail.com>
2022-11-22 11:34:05 +08:00
koralsky 1ba83ae722
declare "reuse values" control mode in helmDefaults (#527)
* support for helmDefaults.reuseValues

Signed-off-by: Karol Ossowski <k@koralsky.pl>
2022-11-20 08:47:48 +08:00
Lassi Pölönen 0f44cfacc4
Add the ability to specify a lock file (#432)
Allow configuring the lockfile in the state. This makes it possible for
example maintain a lock per environment.

Signed-off-by: Lassi Pölönen <lassi.polonen@iki.fi>

Signed-off-by: Lassi Pölönen <lassi.polonen@iki.fi>
2022-11-12 08:59:56 +09:00
xiaomudk 6dcde20d7a
Add subcommand init for checks and installs helmfile deps (#389)
* Add subcommand init for checks and installs helmfile deps

Signed-off-by: xiaomudk <xiaomudk@gmail.com>
2022-11-03 14:51:30 +08:00
Nenad Strainovic 3ac0cee50a
Document git for windows env auto-prefix #481 (#487)
* Document git for windows env auto-prefix #481

Signed-off-by: Nenad Strainovic <nenad.strainovic@asseco-see.rs>
2022-10-31 22:24:06 +08:00
Quan TRAN 4c103073bc
Fix OCI example 2022-10-26 21:34:43 +02:00
yxxhero 8f7796b260
feat: optimize version output (#412)
* feat: optimize version output

Signed-off-by: yxxhero <aiopsclub@163.com>

* Update docs/index.md

Signed-off-by: yxxhero <aiopsclub@163.com>

Signed-off-by: yxxhero <aiopsclub@163.com>
Co-authored-by: Yusuke Kuoka <ykuoka@gmail.com>
2022-10-08 14:26:15 +09:00
yxxhero 8f0993a081
doc: update template funcs docs (#414)
Signed-off-by: yxxhero <aiopsclub@163.com>

Signed-off-by: yxxhero <aiopsclub@163.com>
2022-10-08 14:24:32 +09:00
Kevin Leturc 422852dd9a feat: retrieve repository's username/password from environment
Signed-off-by: Kevin Leturc <kevinleturc@users.noreply.github.com>
2022-10-06 16:48:44 +02:00
yxxhero c0a1ec46dc docs: update docs order
Signed-off-by: yxxhero <aiopsclub@163.com>
2022-10-05 10:01:44 +08:00
mugioka a42c14e640 imprv: convert hyphen included in repo name to underbar with gatherOCIUsernamePassword.
Most shells do not support hyphens in environment variables.

However, there are cases where you may want to include hyphens in the repository name.

Therefore, I have included a process in `gatherOCIUsernamePassword` to replace hyphens with underbar.

Signed-off-by: mugioka <okamugi0722@gmail.com>
2022-10-03 14:49:03 +09:00
yxxhero 6862c362b4
Merge pull request #400 from stoned/typo
fix:  docs typo
2022-09-30 18:24:27 +08:00
Stoned Elipot 22f0d7b8a0 typo
Signed-off-by: Stoned Elipot <stoned.elipot@gmail.com>
2022-09-30 11:02:19 +02:00
Kevin Nguyen e9fadfc868 Fix incubator charts location
Signed-off-by: Kevin Nguyen <concuadong89@gmail.com>
2022-09-30 10:42:42 +07:00
Yusuke Kuoka 466661c223 Update towards-1.0.md
A small enhancement to the 1.0 proposal.

Signed-off-by: Yusuke Kuoka <ykuoka@gmail.com>
2022-09-19 23:33:30 +00:00
Yusuke Kuoka 385c3e80ef Add documentation about the new preapply hook
Signed-off-by: Yusuke Kuoka <ykuoka@gmail.com>
2022-09-19 02:28:11 +00:00
Anton Bretting 5b88006e86 Update documentation
Signed-off-by: Anton Bretting <sajfer@gmail.com>
2022-09-19 08:55:44 +09:00
yxxhero a1c8926a86 fix enable-live-output style
Signed-off-by: yxxhero <aiopsclub@163.com>
2022-09-18 20:21:10 +08:00
yxxhero fa8dcc2c8f update CLI Ref
Signed-off-by: yxxhero <aiopsclub@163.com>
2022-09-18 20:18:57 +08:00
yxxhero deca47087f update docs for cli
Signed-off-by: yxxhero <aiopsclub@163.com>
2022-09-11 11:11:53 +08:00
Viktor Oreshkin 9ef075a249 docs: update cli-reference with latest version
Signed-off-by: Viktor Oreshkin <imselfish@stek29.rocks>
2022-09-06 15:37:05 +03:00
Viktor Oreshkin ac0bdb8052 docs: add docs for helmfile list
Signed-off-by: Viktor Oreshkin <imselfish@stek29.rocks>
2022-09-06 15:19:45 +03:00
yxxhero 9284d1764e
Add --interactive option to sync, delete and destroy / Remove --interactive from global options (#328)
* add interactive in sync & remove --interactive in global options

Signed-off-by: yxxhero <aiopsclub@163.com>

* fix unittest

Signed-off-by: yxxhero <aiopsclub@163.com>

* same behave as apply when in interactive

Signed-off-by: yxxhero <aiopsclub@163.com>

Signed-off-by: yxxhero <aiopsclub@163.com>
2022-08-28 10:36:07 +09:00
David Regla cbace3d7af Fix typos in docs
Signed-off-by: David Regla <dreglad@gmail.com>
2022-08-27 16:53:37 -05:00
yxxhero 429e724104
Improve some multi-value flags to accept comma-separated values (#300)
fix cobra issue

Signed-off-by: yxxhero <aiopsclub@163.com>

Signed-off-by: yxxhero <aiopsclub@163.com>
2022-08-18 20:30:30 +09:00
Anatoly Rugalev 75aa0e5a21 Update ArchLinux installation instructions
Signed-off-by: Anatoly Rugalev <anatoly.rugalev@gmail.com>
2022-08-14 01:46:55 +02:00
yxxhero 913a22e9aa
update doccs/index.md about CLI ref (#264)
* update doccs/index.md about CLI ref

Signed-off-by: yxxhero <aiopsclub@163.com>

* update docs/index.md about Getting Started

Signed-off-by: yxxhero <aiopsclub@163.com>
2022-08-03 10:59:44 +09:00
vasicvuk 68d7c5f6a4 Implement readDirEntries method
Signed-off-by: vasicvuk <vuk.vasic@asseco-see.rs>
2022-07-26 16:20:38 +02:00
Tsubasa Nagasawa 7141003106
feat: bump chartify to v0.10.0 to support OCI registry for adhoc dependencies
Signed-off-by: Tsubasa Nagasawa <toversus2357@gmail.com>

This adds OCI registry support for adhoc dependencies.
The users can now add their OCI hosted charts as dependencies to helm releases:

* Bump chartify version to v0.10.0
* Add an example helmfile to advanced usage section
2022-07-18 15:58:39 +09:00
yxxhero 95c444a6cd fix readme.md and index.md for doc link
Signed-off-by: yxxhero <aiopsclub@163.com>
2022-07-14 09:27:16 +08:00
Hervé Le Meur 9e3f0a3ba3
fix(doc): add missing version in the release template example
Signed-off-by: Hervé Le Meur <hlemeur@cloudbees.com>
2022-07-13 17:45:11 +02:00
yxxhero fba8b63eac fix link issue for paths.md
Signed-off-by: yxxhero <aiopsclub@163.com>
2022-07-07 13:42:14 +08:00
Yusuke Kuoka 9abcc1f413 proposal: Drop --arsg in Helmfile 1.0
Signed-off-by: Yusuke Kuoka <ykuoka@gmail.com>
2022-06-08 03:43:30 +00:00
yxxhero fef447ddec
Merge pull request #136 from helmfile/towards-1.0
Add proposals about two breaking changes before we cut Helmfile 1.0
2022-06-06 09:43:56 +08:00
Stoned Elipot 214d06e5cd Whitespace fixes
Signed-off-by: Stoned Elipot <stoned.elipot@gmail.com>
2022-06-05 14:14:34 +02:00
Stoned Elipot 6ea940e50f Fix documentation link
Signed-off-by: Stoned Elipot <stoned.elipot@gmail.com>
2022-06-05 14:14:34 +02:00
Yusuke Kuoka bf9eeba544 Add proposals about two breaking changes before we cut Helmfile 1.0
Signed-off-by: Yusuke Kuoka <ykuoka@gmail.com>
2022-06-05 08:32:54 +00:00
yxxhero 8a2fe28bbf update envExec docs
Signed-off-by: yxxhero <aiopsclub@163.com>
2022-05-23 16:46:29 +08:00
Quan TRAN 35bd7c1349 update urls in docs & CONTRIBUTING.md
Signed-off-by: Quan TRAN <account@itscaro.me>
2022-05-16 17:17:26 +02:00
yxxhero 761b12e120 update doc for template func
Signed-off-by: yxxhero <aiopsclub@163.com>
2022-04-30 14:58:38 +08:00
Yusuke Kuoka 3267484f47 Documentation site based on mkdocs and Read the Docs
Ref https://github.com/roboll/helmfile/issues/1824
Ref https://github.com/roboll/helmfile/issues/1755
2022-04-03 05:04:54 +00:00
George Gaál 8594944f63
Update writing-helmfile.md (#1937)
fix small typo
2021-09-14 04:36:40 +09:00
Evgenii Tereshkov d8247e6543
Update writing-helmfile.md: fix typos (#1892) 2021-07-02 07:31:47 +09:00
Vladimir Avdoshka d9e15754b7
Add documentation about re-using the environment state from parent in sub-helmfile (#1808)
Ref #762

Co-authored-by: Vladimir Avdoshka <vavdoshka@kyriba.com>
Co-authored-by: Quan TRAN <itscaro@users.noreply.github.com>
2021-05-01 12:26:00 +09:00
Yujun Zhang 378ae4ad72
Fix typo (#1788) 2021-04-23 09:27:37 +09:00
Yusuke Kuoka efad26641d Add documentation about adhoc chart dependencies 2021-04-10 16:09:27 +09:00
Quan TRAN 5cd0afcfa0
Add documentation about helmfile-fetch and StateValues alias (#1746)
Ref #1743, #1744, #1734
2021-04-01 09:48:58 +09:00
Jason Witkowski 2618cfb38b
Enable --wait-for-jobs flag introduced in helm 3.5 (#1715)
Fixes #1650
Fixes #785

This change introduces:

- `--wait-for-jobs` CLI override option to helmfile binary
- `waitForJobs` helmDefaults parameter (default `false`)
- `waitForJobs` release parameter (default `false`)

Note that `--wait-for-jobs` was introduced in Helm 3.5 (https://github.com/helm/helm/pull/8363)
2021-03-23 16:53:57 +09:00
Nathan Flynn 14a83e7cbe
Update reference for helm-secrets to latest maintained fork (#1676)
* Update referance for helm-secrets to latest maintained fork

* Missed a referance in the docs to an older edition of helm secrets

* Removed docker2 changes back to original method

Co-authored-by: Nathan Flynn <nflynn@williamhill.co.uk>
Co-authored-by: Yusuke Kuoka <ykuoka@gmail.com>
2021-03-09 10:17:16 +09:00
Shunsuke Suzuki 33880dab77
docs: fix typo (#1645)
* docs: fix typo

* docs: syntax highlight
2021-01-12 10:23:21 +09:00
Yusuke Kuoka b910591e1d
Add support for Kustomize Transformers (#1592)
Please see the updated `advanced-features.md` for more details.

This is often used for adding common labels and annotations to any resources rendered from a Helm chart.
2020-11-19 09:33:05 +09:00
Rene Hernandez 604af3f1d2
Replace getOrNil with get function in documentation (#1268)
* New output flag for list command

Support output as json
Add new formatters file to handle extrac formatting to its own concern
New config interface to support list command specification

* Fix usage message

* Add error handling for formatters

* Replace usage of getOrNil with get function

* Add nil in get function

Co-authored-by: Rene Hernandez Remedios <rene.hernandez@fullscript.com>
2020-06-08 08:10:27 +09:00
Yusuke Kuoka 1cfce32e0d Add documentation for releases[].{strategicMergePatches,jsonPatches} 2020-05-27 22:15:12 +09:00
KUOKA Yusuke 16288dfa7d
feat: GA of Kustomize and K8s manifests support (#1172)
This is the GA version of the helm-x integration #673 developed last year.

You get all the following benefits without an extra helm plugin:

- Ability to add ad-hoc chart dependencies/aliases, without forking the chart (Fixes #876 )
- Ability to patch resulting K8s resources before installing the helm chart
- Ability to install a kustomization as a chart (Requires `kustomize` binary to be available in `$PATH`
- Ability to install a directory of K8s manifests as a chart
- etc.
2020-05-27 11:42:43 +09:00
Brian Choy 969de1ebc9
Fix typo in writing-helmfiles.md example (#1263) 2020-05-19 10:04:38 +09:00
Marcin Kaciuba b1190508b2
feat(template): added secret template function (#1221)
* feat(tmpl): added fetchSecretValue template function

This adds a tmpl `fetchSecretValue` and `expandSecretRefs` function by:
- Adding:
    - `expandSecretRefs` function in tmpl package that uses vals
    package to fetch secrets
    - `fetchSecretValue` function in tmpl package like below but for
    single string value
    - gomock for tests purpose
- Changing:
    - move init of vals package to function (so the same instance can be used for template values and rendering the whole template)

* doc(secret): added doc how to use new tmpl methods

Added example usage of `fetchSecretValue` and `expandSecretRefs`
2020-04-25 21:10:02 +09:00
jfreeland 8acbbc596d
new here, fixing very minor typo (#1121) 2020-02-26 10:33:35 +09:00
Guillaume Lecerf 5abbdea059
Fix "Merging Arrays in Layers" doc example (#1084) 2020-02-03 08:42:16 +09:00
Matt L c8ba676e19
Update writing-helmfile.md (#1073)
nitpick spelling
2020-02-03 08:39:40 +09:00
Liam Dawson d6bd317c9c Update templating example typo (#895) 2019-10-17 08:25:24 +09:00
eddycharly fd0133e10a Update documentation and tests for .Values (#839)
Resolves #816
2019-09-14 05:35:16 +02:00
a-hat 6dfc9be0d1 doc: Update documentation about layering release values (#837)
Closes #836
2019-09-06 09:29:08 +09:00
KUOKA Yusuke 4bc99337b2
Make advanced templating backward-compatible (#833)
This is a follow-up for #823
Ref https://github.com/roboll/helmfile/pull/823#discussion_r319712283
2019-08-31 22:37:46 +09:00
astorath 11d0abba6e feat: Advanced Templating (#823)
1. Added `helmfile build` command to print final state
Motivation: useful for debugging purposes and some CI scenarios

Ref #780 

2. Template interpolation is now recursive (you can cross-reference release fields) like:
```yaml
templates:
  release:
    name: {{`app-{{ .Release.Namespace }}`}}
    namespace: {{`{{ .Release.Labels.ns }}`}}
    labels:
      ns: dev
```
3. Experimental: Added some boolean release fields interpolation in templates:
```yaml
templates:
  release:
    name: {{`app-{{ .Release.Namespace }}`}}
    namespace: dev
    installedTemplate: {{`{{ eq .Release.Namespace "dev" }}`}}
```

Resolves #818

4. Added more template interpolations: Labels, SetValues
5. Added template interpolation for inline Values
6. Added `helmfile list` command to print target releases in simple tabular form
7. Added release names in some `helm` output messages, e.g.: `Comparing release=%v, chart=%v`
2019-08-31 14:31:31 +09:00
KUOKA Yusuke 3986f6497e
Update writing-helmfile.md 2019-06-04 23:41:26 +09:00
KUOKA Yusuke 1012256f16
feat: "base" helmfile state gotmpl is rendered with the envvals inherited from the parent (#613)
Resolves #611
2019-05-22 18:28:10 +09:00
Yusuke KUOKA aef366660b feat: split-render-merge helmfile.yaml parts
This splits your helmfile.yaml by the YAML document separator "---" before evaluating go template expressions as outlined in https://github.com/roboll/helmfile/issues/388#issuecomment-491710348
2019-05-13 21:49:59 +09:00
Yusuke KUOKA 1db205de48 feat: "bases" for easier layerina
This adds the new configuration key `baeses` to your helmfile.yaml files, so that you can layer them without the `readFile` template function, which was a bit unintuitive.

Please see https://github.com/roboll/helmfile/issues/388#issuecomment-491710348 for more context
2019-05-13 21:48:00 +09:00
sgandon 57df25c3ff doc(team): changed the sub-helmfile as template (#524)
try to make the doc more clear.
2019-04-01 07:41:11 +09:00
KUOKA Yusuke 14a392666e
feat: easier way to share configuration across helmfiles (#522)
This basically allows to define both `releases` and `helmfiles` within a helmfile.yaml, so that you can start using sub-helmfiles easily, by extracting only reused releases.

Resolves #445
2019-03-31 22:51:06 +09:00
Dan O'Brien 8f7ab740bd minor typo (#496) 2019-03-19 19:14:52 +09:00
Simon Li abeccc5e8e Fix indentation in writing-helmfile.md example (#454) 2019-01-25 23:32:33 +09:00
KUOKA Yusuke 5f52f96709
fix missingFileHandler (#440)
- Fix panics when `missingFileHandler` is not defined
- Fix `missingFileHandler: Error` had been writing errors at the Warn level
- Add `Info` and `Debug` as valid values

Ref https://github.com/roboll/helmfile/pull/439#issuecomment-456155521
2019-01-22 11:22:53 +09:00
KUOKA Yusuke f813ac2642
feat: Release Template (#439)
This feature is supposed to help advanced use-cases like Conventional Directory Structure explained in several issues like #428.

Newly added configuration keys `templates`, `missingFileHandler`, and the ability to defer executing template expressions in `values`, `secrets`, `namespace`, and `chart` of releases allows you to abstract away repetitions into a reusable template:

```yaml
templates:
  default: &default
    missingFileHandler: Warn
    namespace: "{{`{{ .Release.Name }}`}}"
    chart: stable/{{`{{ .Release.Name }}`}}
    values:
    - config/{{`{{ .Release.Name }}`}}/values.yaml
    - config/{{`{{ .Release.Name }}`}}/{{`{{ .Environment.Name }}`}}.yaml
    secrets:
    - config/{{`{{ .Release.Name }}`}}/secrets.yaml
    - config/{{`{{ .Release.Name }}`}}/{{`{{ .Environment.Name }}`}}-secrets.yaml

releases:
- name: envoy
  <<: *default
```

See the updated documentation for more details.

Resolves #428
2019-01-22 01:19:07 +09:00
KUOKA Yusuke 770c3daa5f
feat: `get` and `getOrNil` template funcs to allow defaulting in templates (#370)
* feat: `get` and `getOrNil` template funcs to allow defaulting in templates

Ref #357

* Add docs about missing keys and default values in templates
2018-09-28 11:44:49 +09:00
KUOKA Yusuke 9808849986
feat: Merge multiple docs inside a single helmfile.yaml (#270)
Resolves #254
2018-09-19 15:42:01 +09:00