public_git
/
helmfile
mirror of https://github.com/helmfile/helmfile.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
2,737 Commits 21 Branches 370 Tags 78 MiB
Commit Graph

229 Commits

Author SHA1 Message Date
yxxhero e703b15075
docs: restructure documentation and improve newcomer experience (#2573) 
* feat: add --write-output flag to helmfile fetch for air-gapped environments

Add --write-output flag to helmfile fetch that outputs a modified
helmfile.yaml with chart references updated to point to downloaded
local chart paths. Combined with --output-dir, this enables preparing
all charts for deployment in air-gapped environments.

Usage:
  helmfile fetch --output-dir ./charts --write-output > helmfile-airgapped.yaml

Fixes #2571

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

* docs: restructure documentation and improve newcomer experience

Split the monolithic index.md (1990 lines) into focused topic pages,
update mkdocs.yml navigation, and add missing documentation for
undocumented code features.

Structure changes:
- Extract configuration.md (helmfile.yaml reference)
- Extract cli.md (CLI commands and flags)
- Extract templating.md (template syntax and env vars)
- Extract environments.md (environment configuration)
- Extract releases.md (DAG, needs, selectors)
- Extract hooks.md (lifecycle hooks)
- Extract integrations.md (ArgoCD, Azure ACR, OCI)
- Slim index.md to ~270 line landing page with step-by-step tutorial

Newcomer improvements:
- Add 5-step Getting Started tutorial with explanations
- Reorganize nav: Getting Started now shows core learning path
  (Writing Helmfile → Values → Environments → Releases)
- Add Quick Reference table to configuration.md
- Simplify writing-helmfile.md title

Code-vs-docs gap fixes:
- Document 23 undocumented release fields (valuesTemplate,
  setTemplate, forceNamespace, adopt, trackMode, etc.)
- Document 6 undocumented helmDefaults fields (enableDNS,
  forceConflicts, skipRefresh, takeOwnership, etc.)
- Document print-env command and missing CLI flags
- Document kubectlApply hook field
- Document environment defaults field and merge order
- Document kubedogQPS/kubedogBurst advanced settings
- Document template partials (_*.tpl) auto-loading

Cleanup:
- Fix Docker image version from v0.156.0 to v1.1.0
- Fix heading nesting in advanced-features.md
- Update experimental-features.md with current features
- Fix broken cross-references and anchor links

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

* Revert changes to pkg/app from docs/restructure-and-improve branch

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

* docs: add create subcommand to README and CLI reference

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

---------

Signed-off-by: yxxhero <yxxhero@users.noreply.github.com>
Signed-off-by: yxxhero <aiopsclub@163.com>
 2026-05-03 19:33:33 +08:00
Sianao 88455b1ce8
update readme add install from source (#2561) 
* update readme install method

Signed-off-by: Sianao <admin@sianao.cc>

* update chinese install desc

Signed-off-by: Sianao <admin@sianao.cc>

---------

Signed-off-by: Sianao <admin@sianao.cc>
 2026-04-30 20:08:34 +08:00
Jean-Yves LENHOF e2a8727919
docs(README): add mise alternate installation documentation (#2342) 
Signed-off-by: jylenhof <jygithub@lenhof.eu.org>
 2025-12-24 08:21:58 +08:00
yxxhero 160753c87f
docs: add zread badge to README (#2219) 
Signed-off-by: yxxhero <aiopsclub@163.com>
 2025-10-13 14:10:00 +08:00
Nick Neisen 2116c93cc4
Add helm diff installation to README (#2170) 
Add helm-diff to install section

Signed-off-by: Nick Neisen <nwneisen@gmail.com>
 2025-09-06 13:28:26 +08:00
Yusuke Kuoka efcb1b5ef5
Update README.md (#2046) 
Intends to address https://github.com/helmfile/helmfile/pull/2040#discussion_r2096977864

Signed-off-by: yxxhero <aiopsclub@163.com>
 2025-05-20 22:38:01 +08:00
Zubair Haque f46f5baca7
Update readme & documentation with 2025 status of helmfile project (#2040) 2025-05-15 22:35:01 +08:00
yxxhero 769d56d208
docs: add more complex examples section in README (#2013) 
* docs: add more complex examples section in README

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

* fix typo

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

---------

Signed-off-by: yxxhero <aiopsclub@163.com>
 2025-04-21 15:49:03 -04:00
haruna eb6425c20d
Revive dead badge links (#1776) 2024-11-10 07:03:02 +08:00
Kürşat Aktaş 32409acc61
Introducing Helmfile Guru on Gurubase.io (#1748) 
Signed-off-by: Kürşat Aktaş <kursat.ce@gmail.com>
 2024-10-24 19:21:30 +08:00
jonathanmanton 84e0713788
Fix broken links in status section of README.md (#1618) 
* Update README.md

Broken links in Status section

Signed-off-by: Jonathan Manton <jonathan@manton.com>

* Update README.md

Broken links in Status section

Signed-off-by: Jonathan Manton <jonathan@manton.com>

* Update README.md

Broken links in Status section

Signed-off-by: Jonathan Manton <jonathan@manton.com>

---------

Signed-off-by: Jonathan Manton <jonathan@manton.com>
 2024-07-09 10:51:46 +08:00
Yusuke Kuoka c689a4ce05
Update the project status with invitation to v1 rc testers (#1513) 
Signed-off-by: Yusuke Kuoka <ykuoka@gmail.com>
 2024-05-09 13:45:28 +08:00
yxxhero aedcc4373e
feat: add starhistory (#909) 
Signed-off-by: yxxhero <aiopsclub@163.com>
 2023-06-27 14:21:41 +08:00
xiaomudk b359efef8b
Sync Chinese readme (#676) 2023-02-07 07:05:18 +08:00
xiaomudk 4ce8676588
Improve readme readability (#678) 
Signed-off-by: xiaomudk <xiaomudk@gmail.com>
 2023-02-07 07:25:35 +09:00
yxxhero 9aadde6173
fix typo (#670) 
Signed-off-by: yxxhero <aiopsclub@163.com>
 2023-02-01 22:25:01 +08:00
Felix daa77b24c0
Bring up the init command in readme #661 (#662) 2023-01-29 04:44:22 +08:00
yxxhero eb810c6c0c
add goreportcard (#595) 
Signed-off-by: yxxhero <aiopsclub@163.com>
 2022-12-21 23:46:31 +08:00
yxxhero 54d987dd75 fix ghr badge 
Signed-off-by: yxxhero <aiopsclub@163.com>
 2022-11-24 19:36:30 +08:00
yxxhero 144964002e
fix README.md users.md to USERS.md (#410) 
Signed-off-by: yxxhero <aiopsclub@163.com>

Signed-off-by: yxxhero <aiopsclub@163.com>
 2022-10-08 14:25:01 +09:00
Ugo Mignon 0e04546880 docs: fix best pratices guide link 
Signed-off-by: Ugo Mignon <umignon.externe@bedrockstreaming.com>
 2022-09-29 13:58:38 +02:00
Hervé Le Meur de567ac0f7
chore: remove 'OSS' from Jenkins name 
Signed-off-by: Hervé Le Meur <hlemeur@cloudbees.com>
 2022-08-29 10:57:04 +02:00
yxxhero d201c1d2ea Add Users information in Readme.md 
Signed-off-by: yxxhero <aiopsclub@163.com>
 2022-08-26 10:00:29 +08:00
Nam Nguyen 5d5d61e56f fix typo for readme.md 2022-08-23 15:11:20 +07: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
xiaomudk cdea0ff080 doc: getting start adds repositories configuration 
Signed-off-by: xiaomudk <xiaomudk@gmail.com>
 2022-07-19 10:28:01 +08:00
yxxhero b3f4b78cd9
update Readmd.md (#236) 
Signed-off-by: yxxhero <aiopsclub@163.com>
 2022-07-18 14:06:25 +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
yxxhero f0662f2ebe fix docs site issue 
Signed-off-by: yxxhero <aiopsclub@163.com>
 2022-07-08 08:36:02 +08:00
yxxhero 603d305194 fix paths.md link error 
Signed-off-by: yxxhero <aiopsclub@163.com>
 2022-07-07 13:36:16 +08:00
Hiroaki Kobayashi 26e0a4a482 Fix typo in README 
Signed-off-by: Hiroaki Kobayashi <kobtea9696@gmail.com>
 2022-06-23 23:48:22 +09:00
yxxhero 3f48b295d3
update Readme.md (#170) 
Signed-off-by: yxxhero <aiopsclub@163.com>
 2022-06-21 10:55:01 +09:00
ogugu (Riku Ogura) c897a10dce Fix deprecated chart in Getting Started 
Signed-off-by: ogugu (Riku Ogura) <e.cos.isin@gmail.com>
 2022-06-06 20:59:34 +09:00
yxxhero d83e9214e6 rename execEnvs to envExec 
Signed-off-by: yxxhero <aiopsclub@163.com>
 2022-05-17 08:30:46 +08:00
Quan TRAN f7ef07ff94
Merge pull request #95 from yxxhero/add_execEnvs 
[feat] add execEnvs
 2022-05-16 17:13:57 +02:00
Quan TRAN a942f12d36
Merge pull request #81 from yjqg6666/readme 
[#80] README, update release tag url
 2022-05-16 14:27:19 +02:00
yxxhero ba5bea17d7 update Readme.md for execEnvs 
Signed-off-by: yxxhero <aiopsclub@163.com>
 2022-05-14 10:13:09 +08:00
King Jin 1adcbc152c
update README, update release download url, tags used 
Signed-off-by: King Jin <jinking.this@gmail.com>
 2022-05-10 09:23:21 +08:00
King Jin fda29a639f
[#80] README, update release tag url 
Signed-off-by: King Jin <jinking.this@gmail.com>
 2022-05-06 13:33:36 +08: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 feb2bc9589
Update README.md 2022-04-19 09:48:54 +09:00
Quan TRAN eed489efc1 Update badge to reflect Github Action status 
Signed-off-by: Quan TRAN <account@itscaro.me>
 2022-04-05 21:16:52 +02:00
Yusuke Kuoka e561e9bc06 Add a documentation badge to README 2022-04-03 05:11:01 +00:00
qb-abdul 4716320d99
Update README.md (#2105) 
Added examples in Readme.md for fetching values from Remote
 2022-03-31 10:54:25 +09:00
Yusuke Kuoka 91aa0acddb
Update README.md 
Relates to #2002
 2022-01-10 16:37:02 +09:00
Mårten Svantesson fe8a176db5
feat: Option to pass kubeVersion to helm template (#2002) 2022-01-07 09:05:03 +09:00
Travis Truman b101f9ff8d
Fix capitalization of disableOpenAPIValidation config in README (#2003) 
See https://github.com/roboll/helmfile/blob/master/pkg/state/state.go#L220
 2022-01-07 08:59:49 +09:00
Babis K d34dc7bb64
Add support for --insecure-skip-tls-verify flag on helm repo add command (#1990) 
Parses a new field in repositories named `skipTLSVerify` and if set to `true`, it appends `--insecure-skip-tls-verify` in `helm repo add` command.

This should be useful with internal self-signed repos, mitm proxies etc.

Resolves #1871
 2021-12-21 09:18:57 +09:00
Anatoly Medvedkov 3d7b4287b3
Fix typo in README (#2006) 2021-12-16 09:55:24 +09:00
pjotre86 c0668874e3
Add documentation for needs parameterization. (#1987) 
* Add documentation for needs parameterization.

Co-authored-by: Peter Aichinger <petera@topdesk.com>
 2021-10-21 08:36:00 +09:00