troubleshoot/docs/preflight_template.md at d0584a4d4dceae52812cf44412ea506eeee53a35

mirror of https://github.com/replicatedhq/troubleshoot.git synced 2026-04-15 07:16:34 +00:00

Files

Noah Campbell acc1aad843 Preflight docs and template subcommands (#1847 )

* Added docs and template subcommands with test files

* uses helm templating preflight yaml files

* merge doc requirements for multiple inputs

* Helm aware rendering and markdown output

* v1beta3 yaml structure better mirrors beta2

* Update sample-preflight-templated.yaml

* Added docs and template subcommands with test files

* uses helm templating preflight yaml files

* merge doc requirements for multiple inputs

* Helm aware rendering and markdown output

* v1beta3 yaml structure better mirrors beta2

* Update sample-preflight-templated.yaml

* Added/updated documentation on subcommands

* Update docs.go

* commit to trigger actions

2025-09-16 14:12:09 -05:00

2.0 KiB

Raw Blame History

preflight template

Render a templated preflight spec with values

Synopsis

Process a templated preflight YAML file, substituting variables and removing conditional sections based on provided values. Supports multiple values files and inline overrides. Outputs the fully-resolved YAML (no conditional logic remains).

preflight template [template-file] [flags]

Examples

# Render with defaults only
preflight template sample-preflight-templated.yaml

# Render with multiple values files (later files override earlier ones)
preflight template sample-preflight-templated.yaml \
  --values values-base.yaml --values values-prod.yaml

# Inline overrides (Helm-style --set)
preflight template sample-preflight-templated.yaml \
  --set kubernetes.minVersion=v1.24.0 --set storage.enabled=true

# Save to file
preflight template sample-preflight-templated.yaml -o rendered.yaml

Options

      --values stringArray   Path to YAML files containing template values (can be used multiple times)
      --set stringArray      Set template values on the command line (can be used multiple times)
  -o,  --output string       Output file (default: stdout)

Behavior

Values merge: deep-merged left-to-right across multiple --values files. --set overrides win last.
Rendering engine:
- v1beta3 specs (Helm-style templates using .Values.*) are rendered with the Helm engine.
- Legacy templates are rendered with Go text/template; mixed templates are supported.
Map normalization: values files are normalized to map[string]interface{} before applying --set (avoids type errors when merging Helm strvals).

v1beta3 spec decisions

Layout aligns with v1beta2: spec.analyzers: [...].
Each analyzer accepts an optional docString used by preflight docs.
Templating style is Helm-oriented (.Values.*).
Modularity via conditional analyzers is supported, e.g. {{- if .Values.ingress.enabled }}.

2.0 KiB Raw Blame History