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 skip-reconcile annotation support for controlled operator pause during migrations #704

Open
Kaushik-Vijayakumar-1 opened this issue Oct 25, 2024 · 1 comment · May be fixed by #696 or freshworks/redis-operator#13
Labels

Comments

@Kaushik-Vijayakumar-1
Copy link

Problem Statement

When migrating Redis clusters between Kubernetes clusters, the operator's reconciliation loop can interfere with the migration process by attempting to maintain the desired state (sentinel count, slave count) in the source cluster. This can potentially lead to split-brain scenarios during migrations.

Proposed Solution

Add support for a skip-reconcile annotation that allows operators to temporarily pause reconciliation for specific Redis Failover resources. This gives operators more control during maintenance windows and migrations.

Example usage:

apiVersion: databases.spotahome.com/v1
kind: RedisFailover
metadata:
  name: redisfailover-sample
  annotations:
    skip-reconcile: "true"
spec:
  # ... rest of the spec

Benefits

  • Provides fine-grained control over operator reconciliation at the resource level
  • Facilitates safer maintenance operations and migrations
  • Prevents potential split-brain scenarios during cluster migrations
  • Allows for temporary pause without needing to delete/modify the operator

Implementation Details

The implementation checks for the annotation at the start of the reconciliation loop:

if rf.Annotations != nil {
    skipReconcile, ok := rf.Annotations["skip-reconcile"]
    if ok && skipReconcile == "true" {
        r.logger.Infoln("skip-reconcile set to true. Skipping reconcile for", rf.Name)
        return nil
    }
}
Copy link

This issue is stale because it has been open for 45 days with no activity.

@github-actions github-actions bot added the stale label Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
1 participant