Skip to content

Commit 612e8df

Browse files
committed
[doc] fill in a few bits about Control service as an example
1 parent e8a3ad4 commit 612e8df

File tree

3 files changed

+13
-5
lines changed

3 files changed

+13
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ There are two ways of interacting with AliECS:
6262
### I want my application to send requests to AliECS
6363

6464
:scroll: See the API docs of AliECS components:
65-
- [AliECS core gRPC server](/docs/apidocs_aliecs.md)
65+
- [core gRPC server](/docs/apidocs_aliecs.md)
6666
- [apricot gRPC server](/docs/apidocs_apricot.md)
6767
- [apricot HTTP server](/apricot/docs/apricot_http_service.md)
6868

core/protos/o2control.proto

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,26 @@ option go_package = "github.com/AliceO2Group/Control/core/protos;pb";
3030

3131
import public "protos/events.proto";
3232

33+
// The Control service is the main interface to AliECS
3334
service Control {
3435
rpc GetFrameworkInfo (GetFrameworkInfoRequest) returns (GetFrameworkInfoReply) {}
3536

3637
rpc GetEnvironments (GetEnvironmentsRequest) returns (GetEnvironmentsReply) {}
38+
// Creates a new environment which automatically follows one STANDBY->RUNNING->DONE cycle in the state machine.
39+
// It returns only once the environment reaches the CONFIGURED state or upon any earlier failure.
3740
rpc NewAutoEnvironment (NewAutoEnvironmentRequest) returns (NewAutoEnvironmentReply) {}
41+
// Creates a new environment.
42+
// It returns only once the environment reaches the CONFIGURED state or upon any earlier failure.
3843
rpc NewEnvironment (NewEnvironmentRequest) returns (NewEnvironmentReply) {}
3944
rpc GetEnvironment (GetEnvironmentRequest) returns (GetEnvironmentReply) {}
4045
rpc ControlEnvironment (ControlEnvironmentRequest) returns (ControlEnvironmentReply) {}
4146
rpc DestroyEnvironment (DestroyEnvironmentRequest) returns (DestroyEnvironmentReply) {}
4247
rpc GetActiveDetectors (Empty) returns (GetActiveDetectorsReply) {}
4348
rpc GetAvailableDetectors (Empty) returns (GetAvailableDetectorsReply) {}
4449

50+
// Creates a new environment.
51+
// It returns once an environment ID is created and continues the creation asynchronously to the call.
52+
// The environment will be listed in GetEnvironments() only once the workflow is loaded and deployment starts.
4553
rpc NewEnvironmentAsync (NewEnvironmentRequest) returns (NewEnvironmentReply) {}
4654

4755
// rpc SetEnvironmentProperties (SetEnvironmentPropertiesRequest) returns (SetEnvironmentPropertiesReply) {}

docs/apidocs_aliecs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1473,20 +1473,20 @@ Not implemented yet
14731473
<a name="o2control-Control"></a>
14741474

14751475
### Control
1476-
1476+
The Control service is the main interface to AliECS
14771477

14781478
| Method Name | Request Type | Response Type | Description |
14791479
| ----------- | ------------ | ------------- | ------------|
14801480
| GetFrameworkInfo | [GetFrameworkInfoRequest](#o2control-GetFrameworkInfoRequest) | [GetFrameworkInfoReply](#o2control-GetFrameworkInfoReply) | |
14811481
| GetEnvironments | [GetEnvironmentsRequest](#o2control-GetEnvironmentsRequest) | [GetEnvironmentsReply](#o2control-GetEnvironmentsReply) | |
1482-
| NewAutoEnvironment | [NewAutoEnvironmentRequest](#o2control-NewAutoEnvironmentRequest) | [NewAutoEnvironmentReply](#o2control-NewAutoEnvironmentReply) | |
1483-
| NewEnvironment | [NewEnvironmentRequest](#o2control-NewEnvironmentRequest) | [NewEnvironmentReply](#o2control-NewEnvironmentReply) | |
1482+
| NewAutoEnvironment | [NewAutoEnvironmentRequest](#o2control-NewAutoEnvironmentRequest) | [NewAutoEnvironmentReply](#o2control-NewAutoEnvironmentReply) | Creates a new environment which automatically follows one STANDBY-&gt;RUNNING-&gt;DONE cycle in the state machine. It returns only once the environment reaches the CONFIGURED state or upon any earlier failure. |
1483+
| NewEnvironment | [NewEnvironmentRequest](#o2control-NewEnvironmentRequest) | [NewEnvironmentReply](#o2control-NewEnvironmentReply) | Creates a new environment. It returns only once the environment reaches the CONFIGURED state or upon any earlier failure. |
14841484
| GetEnvironment | [GetEnvironmentRequest](#o2control-GetEnvironmentRequest) | [GetEnvironmentReply](#o2control-GetEnvironmentReply) | |
14851485
| ControlEnvironment | [ControlEnvironmentRequest](#o2control-ControlEnvironmentRequest) | [ControlEnvironmentReply](#o2control-ControlEnvironmentReply) | |
14861486
| DestroyEnvironment | [DestroyEnvironmentRequest](#o2control-DestroyEnvironmentRequest) | [DestroyEnvironmentReply](#o2control-DestroyEnvironmentReply) | |
14871487
| GetActiveDetectors | [Empty](#o2control-Empty) | [GetActiveDetectorsReply](#o2control-GetActiveDetectorsReply) | |
14881488
| GetAvailableDetectors | [Empty](#o2control-Empty) | [GetAvailableDetectorsReply](#o2control-GetAvailableDetectorsReply) | |
1489-
| NewEnvironmentAsync | [NewEnvironmentRequest](#o2control-NewEnvironmentRequest) | [NewEnvironmentReply](#o2control-NewEnvironmentReply) | |
1489+
| NewEnvironmentAsync | [NewEnvironmentRequest](#o2control-NewEnvironmentRequest) | [NewEnvironmentReply](#o2control-NewEnvironmentReply) | Creates a new environment. It returns once an environment ID is created and continues the creation asynchronously to the call. The environment will be listed in GetEnvironments() only once the workflow is loaded and deployment starts. |
14901490
| GetTasks | [GetTasksRequest](#o2control-GetTasksRequest) | [GetTasksReply](#o2control-GetTasksReply) | |
14911491
| GetTask | [GetTaskRequest](#o2control-GetTaskRequest) | [GetTaskReply](#o2control-GetTaskReply) | |
14921492
| CleanupTasks | [CleanupTasksRequest](#o2control-CleanupTasksRequest) | [CleanupTasksReply](#o2control-CleanupTasksReply) | |

0 commit comments

Comments
 (0)