grafana-util docs
Home / Manpages / grafana-util-change-preview.1

grafana-util-change-preview.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-preview - Preview what would change from discovered or explicit staged inputs.

SYNOPSIS

grafana-util change preview [OPTIONS]

DESCRIPTION

Preview what would change from discovered or explicit staged inputs.

  • Use this when you want the actionable review artifact for the current staged package.
  • This is the task-first replacement for the common plan step.
  • Choose this when the operator question is “what will change?” rather than “which lower-level builder should I run?”

BEFORE / AFTER

  • Before: you know the package exists and passes basic checks, but the actual creates, updates, and deletes are still implicit.
  • After: you have one staged preview contract that can move into review and eventually into apply.

COMMON OPTIONS

--workspace
auto-discover the staged package from common repo-local inputs.
--desired-file
preview one explicit desired change file.
--source-bundle, --target-inventory, --mapping-file, --availability-file
switch into bundle or promotion-aware preview paths.
--live-file
compare against one saved live-state document.
--fetch-live
query live Grafana instead of relying on --live-file.
--allow-prune
allow delete operations to appear in the preview.
--trace-id
stamp the preview with explicit review lineage.
--output-format, --output-file
render or persist the preview artifact.

SUCCESS CRITERIA

  • the summary counts match the operator’s expectation of creates, updates, and deletes
  • the preview can be handed to another person as the review artifact
  • the output is explicit enough to compare against later apply behavior

FAILURE CHECKS

  • if preview fails from --workspace, retry once with explicit staged input flags before assuming the package is bad
  • if live-backed output looks different from expectation, verify auth, org scope, and the target Grafana before approving it
  • if preview emits bundle or promotion preflight kinds instead of a sync plan, confirm which staged inputs you provided

EXAMPLES

Preview what would change from discovered or explicit staged inputs.

grafana-util change preview --workspace . --fetch-live --profile prod

SEE ALSO

grafana-util(1)