ursula-control 0.5.0-patch1

Control-plane state for Ursula dynamic node registration, group placement, and manual group migration.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

use std::collections::BTreeMap;
use std::collections::BTreeSet;
use std::fmt;

use serde::Deserialize;
use serde::Serialize;
use ursula_shard::RaftGroupId;

use crate::model::LearnerStatus;
use crate::model::MigrationPhase;
use crate::model::NodeId;
use crate::model::NodeState;

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum ControlCommand {
    RegisterNode {
        node_id: NodeId,
        client_url: String,
        cluster_url: String,
        #[serde(default)]
        labels: BTreeMap<String, String>,
        now_ms: u64,
    },
    SetNodeState {
        node_id: NodeId,
        state: NodeState,
        now_ms: u64,
    },
    SeedPlacement {
        raft_group_id: RaftGroupId,
        voters: BTreeSet<NodeId>,
        now_ms: u64,
    },
    BeginMigration {
        raft_group_id: RaftGroupId,
        target_voters: BTreeSet<NodeId>,
        retain_removed: bool,
        now_ms: u64,
    },
    AdvanceMigration {
        migration_id: u64,
        phase: MigrationPhase,
        now_ms: u64,
    },
    SetLearnerStatus {
        migration_id: u64,
        node_id: NodeId,
        status: LearnerStatus,
        now_ms: u64,
    },
    RecordMigrationError {
        migration_id: u64,
        error: String,
        now_ms: u64,
    },
    CommitPlacement {
        raft_group_id: RaftGroupId,
        voters: BTreeSet<NodeId>,
        learners: BTreeSet<NodeId>,
        draining: BTreeSet<NodeId>,
        now_ms: u64,
    },
    FinishMigration {
        migration_id: u64,
        success: bool,
        now_ms: u64,
    },
    EvictLearner {
        raft_group_id: RaftGroupId,
        node_id: NodeId,
        now_ms: u64,
    },
}

impl ControlCommand {
    pub fn now_ms(&self) -> u64 {
        match self {
            Self::RegisterNode { now_ms, .. }
            | Self::SetNodeState { now_ms, .. }
            | Self::SeedPlacement { now_ms, .. }
            | Self::BeginMigration { now_ms, .. }
            | Self::AdvanceMigration { now_ms, .. }
            | Self::SetLearnerStatus { now_ms, .. }
            | Self::RecordMigrationError { now_ms, .. }
            | Self::CommitPlacement { now_ms, .. }
            | Self::FinishMigration { now_ms, .. }
            | Self::EvictLearner { now_ms, .. } => *now_ms,
        }
    }
}

impl fmt::Display for ControlCommand {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(match self {
            Self::RegisterNode { .. } => "register_node",
            Self::SetNodeState { .. } => "set_node_state",
            Self::SeedPlacement { .. } => "seed_placement",
            Self::BeginMigration { .. } => "begin_migration",
            Self::AdvanceMigration { .. } => "advance_migration",
            Self::SetLearnerStatus { .. } => "set_learner_status",
            Self::RecordMigrationError { .. } => "record_migration_error",
            Self::CommitPlacement { .. } => "commit_placement",
            Self::FinishMigration { .. } => "finish_migration",
            Self::EvictLearner { .. } => "evict_learner",
        })
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum ControlResponse {
    Ok,
    MigrationStarted { migration_id: u64 },
    Rejected { reason: String },
}

impl ControlResponse {
    pub fn is_rejected(&self) -> bool {
        matches!(self, Self::Rejected { .. })
    }
}

impl fmt::Display for ControlResponse {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(match self {
            Self::Ok => "ok",
            Self::MigrationStarted { .. } => "migration_started",
            Self::Rejected { .. } => "rejected",
        })
    }
}