grafana-util docs

grafana-util-change-apply.1

Browser-readable rendering of a generated roff manpage.

This page renders the generated roff manpage into readable HTML for browser use. For richer per-subcommand detail, prefer the command-reference pages.

NAME

grafana-util-change-apply - Turn a reviewed preview into a staged apply intent, or execute it live when you explicitly opt in.

SYNOPSIS

grafana-util change apply [OPTIONS]

DESCRIPTION

Turn a reviewed preview into a staged apply intent, or execute it live when you explicitly opt in.

  • Use this after preview and review are already complete.
  • Choose the default staged form when you need approval evidence or a machine-readable apply intent.
  • Add --execute-live only when you are ready to mutate Grafana for real.
  • --preview-file is the preferred input, while --plan-file still works as a compatibility alias for older staged workflows.

BEFORE / AFTER

- Before: preview exists, but the last mile between review and mutation is still a risky operator step.

- After: apply becomes either a clear staged intent artifact or a clear live execution result with approval attached.

The ordering contract stays on the reviewed preview: ordering.mode, operations[].orderIndex / orderGroup / kindOrder, and summary.blocked_reasons are preview fields that document operation order and blocked work before apply.

COMMON OPTIONS

--preview-file
the reviewed preview artifact to apply.
--plan-file
compatibility alias for older plan-based staged workflows.
--approve
explicit acknowledgement that this step may proceed.
--execute-live
switch from staged intent generation into real live execution.
--approval-reason, --apply-note
carry human approval context into the output artifact.
--output-format
render as text or json.

SUCCESS CRITERIA

  • reviewed lineage is preserved into the apply stage instead of being lost at the last step
  • staged apply JSON is explicit enough for approval workflows, tickets, or handoff notes
  • live apply output makes it obvious how many operations ran and whether anything failed

FAILURE CHECKS

  • if apply refuses to proceed, confirm that the input preview is the reviewed artifact and that --approve is present
  • if the staged intent looks right but live execution differs, compare the preview, optional preflight artifacts, and target environment before retrying
  • if automation reads the output, distinguish staged grafana-utils-sync-apply-intent from live apply output before parsing fields

EXAMPLES

Turn a reviewed preview into a staged apply intent, or execute it live when you explicitly opt in.

grafana-util change apply --preview-file ./change-preview.json --approve --output-format json

SEE ALSO

grafana-util(1)