Skip to content

kcp report plan

kcp report plan

Generate a Migration Plan to migrate to Confluent Cloud

Synopsis

Generate a Migration Plan to migrate to Confluent Cloud from a kcp state file produced by kcp scan or kcp discover, or from your answers alone with no state file.

For each scanned cluster the plan recommends a target cluster type, sizing, networking, authentication, and data-migration approach, and lists the questions a scan can't answer.

How it works: kcp auto-answers everything it can from the scan. What it can't derive is written to plan-inputs.yaml (in the current directory) — fleet-wide questions once under all_clusters:, per-cluster facts under each cluster, each answer a short, stable token with the full wording in the comment above it. Edit that file in place and re-run; kcp reads your answers back, folds them into the plan, and rewrites the file with any follow-ups revealed — so it converges over a couple of passes.

Output: plan.md and plan.json go to --output-dir (default ./plan-output); plan-inputs.yaml is read from and written back to --plan-inputs (default ./plan-inputs.yaml) — edit it in place between runs.

kcp report plan [flags]

Examples

  # First pass: state file in; writes ./plan-inputs.yaml + plan.md/plan.json
  kcp report plan --state-file kcp-state.json

  # Edit ./plan-inputs.yaml, then re-run — same command refines the plan
  kcp report plan --state-file kcp-state.json

  # JSON only
  kcp report plan --state-file kcp-state.json --output json

Options

      --cluster-id string    [Optional] Plan only this cluster (name or ARN). Default: every cluster in the scan.
  -h, --help                 help for plan
      --output string        Comma-separated output formats: md, json, or both. (default "md,json")
      --output-dir string    Directory to write plan.md / plan.json into. (default "./plan-output")
      --plan-inputs string   Path to plan-inputs.yaml — read from and written back to in place. kcp seeds it on the first run; edit it and re-run to refine the plan. All answers optional. (default "./plan-inputs.yaml")
      --region string        [Optional] Plan only clusters in this region. Default: every region in the scan.
      --state-file string    Path to your kcp-state.json file (produced by kcp scan). Optional: omit it to run as a pure questionnaire — the planner starts one cluster with nothing derived, so every fact becomes a question in plan-inputs.yaml.

Options inherited from parent commands

      --verbose   Enable verbose logging to console

SEE ALSO

  • kcp report - Generate reports (costs, metrics, migration plan) from kcp scan data