-
Notifications
You must be signed in to change notification settings - Fork 15
Expand file tree
/
Copy pathDataDistControl.proto
More file actions
105 lines (79 loc) · 4.07 KB
/
DataDistControl.proto
File metadata and controls
105 lines (79 loc) · 4.07 KB
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
// Copyright 2019-2022 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
/// \author Gvozden Nešković, Frankfurt Institute for Advanced Studies and Goethe University Frankfurt
syntax = "proto3";
// Changelog:
// 2021-02-08: - Initial version
// - Support for a single partition/environment: PartitionID = EnvironmentID
package o2.DataDistribution.Control;
service DataDistributionControl {
// Partition management requests
rpc PartitionInitialize(PartitionInitRequest) returns (PartitionResponse) { }
rpc PartitionTerminate(PartitionTermRequest) returns (PartitionResponse) { }
rpc PartitionStatus(PartitionInfo) returns (PartitionResponse) { }
}
message PartitionInfo {
string environment_id = 1;
// AliECS environment ID (required)
string partition_id = 2;
// Partition ID. (required)
}
enum PartitionState {
IGNORE__ = 0;
PARTITION_UNKNOWN = 1;
// Partition not known to DataDistControl. Initialize by calling PartitionInitialize()
PARTITION_ERROR = 2;
// Error state, requires manual Terminate/Initialize.
// DD control could not configure the partition according to required specifications
PARTITION_REQUEST_INVALID = 3;
// Provided configuration does not meet requirements or the request is not accepted at the current state.
PARTITION_CONFIGURING = 4;
// Configuration accepted, waiting on FLP and EPN DD components to respond and connect.
PARTITION_CONFIGURED = 5;
// All components configured, ready for dataflow commands
PARTITION_TERMINATING = 6;
// Partition is terminating. EPN-FLP connections will be cleanly closed.
PARTITION_TERMINATED = 7;
// Partition is terminated. TfScheduler does not accept further requests
}
message PartitionResponse {
PartitionState partition_state = 1;
// Current or new state of the partition following reception of the request.
string info_message = 2;
// Optional information message.
}
// Request for a new partition.
// AliECS provides the information about processes of DD in order for partition to be configured by TfScheduler.
// Partition request must include all processes. Adding additional processes to existing partition is not supported.
message PartitionInitRequest {
PartitionInfo partition_info = 1;
map<string, string> stfb_host_id_map = 2;
// Mapping between StfBuilder::discovery-id parameter and its FLP host name (must resolve to IB IP), for all
// StfBuilder processes in the partition.
map<string, string> stfs_host_id_map = 3;
// Mapping between StfSender::discovery-id parameter and its FLP host name (must resolve to IB IP), for all
// StfSender processes in the partition.
// NOTE: 1. Sizes of stfb_host_id_map and stfs_host_id_map must be the same. StfBuilders and StfSenders come in pairs.
// 2. Multiple discovery-id can map to the same FLP node.
// 3. DNS names (strings) in both maps must satisfy the property:
// stfb_host_id_map.values == stfb_host_id_map.values
// 4. discovery-ids are used for debugging purposes. It would be helpful if the values assigned by AliECS
// provided human-readable information. E.g. an id for the first StfSender on flp009 could be:
// "stfs-flp009#0-<short_partition_id>".
// [optional] parameters passed from AliECS to TfScheduler
map<string, string> partition_params = 4;
}
// Request for partition to be terminated.
// This operation will terminate all connections between EPN and FLP, and remove the partition from DD control-plane.
// Lifetime of individual DD components is managed by the respective FairMQ controller.
message PartitionTermRequest {
PartitionInfo partition_info = 1;
}