Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Support for "Plan" Mode Before Applying Changes #222

Open
eye-dee opened this issue Jan 17, 2025 · 0 comments
Open

Add Support for "Plan" Mode Before Applying Changes #222

eye-dee opened this issue Jan 17, 2025 · 0 comments

Comments

@eye-dee
Copy link

eye-dee commented Jan 17, 2025

Description

It would be highly beneficial if topicctl had the ability to perform a "plan" operation that displays the intended changes before actually applying them. This feature would align well with best practices seen in infrastructure-as-code tools like Terraform.

Motivation

  1. Preview Changes: A "plan" mode would provide a detailed report of actions topicctl would take during an apply, enabling users to verify correctness before making irreversible modifications.
  2. Safety: Reduces the risk of misconfigurations or accidental changes to critical topics.

Expected Behavior

  • New Command or Flag: A --plan flag or topicctl plan command to preview changes.
  • Output Format:
    • Show clear, human-readable descriptions of proposed changes (e.g., "Add partitions to topic X", "Update retention for topic Y").
    • Optionally support JSON or other machine-readable output formats for automation.

Example Usage

# Plan changes without applying them  
topicctl apply --plan --config-file topics.yaml  
  
# Separate command for planning  
topicctl plan --config-file topics.yaml  
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant