mirror of
https://github.com/helmfile/helmfile.git
synced 2026-09-30 10:51:41 +02:00
yxxhero
e703b15075
* 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>
67 lines
1.6 KiB
YAML
67 lines
1.6 KiB
YAML
# Test this locally with:
|
|
# $ docker run --rm -it -v $(pwd):$(pwd) --workdir $(pwd) python:3 bash
|
|
# # pip install -r docs/requirements.txt
|
|
# # mkdocs serve
|
|
# # mkdocs build
|
|
# $ ls -lah site/
|
|
site_name: helmfile
|
|
site_author: Helmfile Authors
|
|
|
|
repo_name: helmfile/helmfile/
|
|
repo_url: https://github.com/helmfile/helmfile/
|
|
edit_uri: ''
|
|
|
|
docs_dir: docs
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Getting Started:
|
|
- Writing Helmfile: writing-helmfile.md
|
|
- Values and Merging: values-and-merging.md
|
|
- Environments: environments.md
|
|
- Releases & DAG: releases.md
|
|
- Configuration:
|
|
- helmfile.yaml Reference: configuration.md
|
|
- Templating: templating.md
|
|
- Template Functions: templating_funcs.md
|
|
- Built-in Objects: builtin-objects.md
|
|
- HCL Functions: hcl_funcs.md
|
|
- Paths Overview: paths.md
|
|
- CLI Reference: cli.md
|
|
- Advanced:
|
|
- Advanced Features: advanced-features.md
|
|
- Hooks: hooks.md
|
|
- Secrets: remote-secrets.md
|
|
- Shared Configuration: shared-configuration-across-teams.md
|
|
- Integrations: integrations.md
|
|
- Experimental Features: experimental-features.md
|
|
- About:
|
|
- Users: users.md
|
|
- License: license.md
|
|
- Contributing: contributing.md
|
|
|
|
theme:
|
|
name: readthedocs
|
|
features:
|
|
- navigation.tabs
|
|
collapse_navigation: false
|
|
hljs_languages:
|
|
- yaml
|
|
- dockerfile
|
|
|
|
markdown_extensions:
|
|
# meta, toc, table and fenced_code extensions are included by default
|
|
- extra
|
|
- admonition
|
|
- smarty
|
|
- sane_lists
|
|
- nl2br
|
|
- toc:
|
|
permalink: true
|
|
|
|
plugins:
|
|
- search
|
|
- git-revision-date-localized:
|
|
type: date
|
|
fallback_to_build_date: true
|