Skip to content

Commit e8a3ad4

Browse files
committed
[doc] massaging
1 parent 420ba77 commit e8a3ad4

File tree

4 files changed

+23
-16
lines changed

4 files changed

+23
-16
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,19 +53,22 @@ There are two ways of interacting with AliECS:
5353

5454
### I want to develop AliECS
5555

56-
:hammer_and_wrench: [Building instructions](https://alice-flp.docs.cern.ch/aliecs/building/)
57-
58-
:arrow_right: [Running instructions](https://alice-flp.docs.cern.ch/aliecs/running/)
59-
60-
TODO CONTRIBUTING.md
56+
:hammer_and_wrench: Welcome to the team, please head to [contributing instructions](/docs/CONTRIBUTING.md)
6157

6258
### I want to receive updates about environments or services controlled by AliECS
6359

64-
:book: Learn more about the [kafka event service](docs/kafka.md)
60+
:pager: Learn more about the [kafka event service](/docs/kafka.md)
61+
62+
### I want my application to send requests to AliECS
63+
64+
:scroll: See the API docs of AliECS components:
65+
- [AliECS core gRPC server](/docs/apidocs_aliecs.md)
66+
- [apricot gRPC server](/docs/apidocs_apricot.md)
67+
- [apricot HTTP server](/apricot/docs/apricot_http_service.md)
6568

66-
### I want my service to communicate with AliECS
69+
### I want my service to be sent requests by AliECS
6770

68-
:book: Learn more about the [plugin system](TODO)
71+
:electric_plug: Learn more about the [plugin system](/core/integration/README.md)
6972

7073
## Table of Contents
7174

@@ -156,7 +159,7 @@ TODO CONTRIBUTING.md
156159
* [Using Kafka debug tools](/docs/kafka.md#using-kafka-debug-tools)
157160

158161
* Developer documentation
159-
* [Contributing](CONTRIBUTING.md)
162+
* [Contributing](/docs/CONTRIBUTING.md)
160163
* [Package pkg.go.dev documentation](https://pkg.go.dev/github.com/AliceO2Group/Control)
161164
* [Building AliECS](/docs/building.md#building-aliecs)
162165
* [Overview](/docs/building.md#overview)
@@ -166,7 +169,8 @@ TODO CONTRIBUTING.md
166169
* [Clone and build (Go components only)](/docs/building.md#clone-and-build-go-components-only)
167170
* [Makefile reference](/docs/makefile_reference.md)
168171
* [Component Configuration](/docs/handbook/appconfiguration.md#component-configuration)
169-
* [Connectivity to controlled nodes](/docs/handbook/appconfiguration.md#connectivity-to-controlled-nodes)
172+
* [Apache Mesos](/docs/handbook/appconfiguration.md#apache-mesos)
173+
* [Connectivity to controlled nodes](/docs/handbook/appconfiguration.md#connectivity-to-controlled-nodes)
170174
* [Running AliECS as a developer](/docs/running.md#running-aliecs-as-a-developer)
171175
* [Running the AliECS core](/docs/running.md#running-the-aliecs-core)
172176
* [Running AliECS in production](/docs/running.md#running-aliecs-in-production)

docs/building.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ AliECS consists of:
1212
* coconut - Go, runs locally or wherever you like and connects to core
1313
* process control plugin + library (OCC) - C++, runs throughout the cluster linked by user processes
1414
* peanut - Go, local debugging tool
15-
* walnut - Go, local workflow conversion tool
1615

1716
## Building with aliBuild
1817

docs/handbook/appconfiguration.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Component Configuration
22

3-
## Connectivity to controlled nodes
3+
## Apache Mesos
4+
5+
Apache Mesos is installed as a part of the FLP Suite.
6+
7+
### Connectivity to controlled nodes
48

59
ECS relies on Mesos to know the state of the controlled nodes.
610
Thus, losing connection to a Mesos slave can be treated as a node being down or unresponsive.
@@ -9,4 +13,4 @@ Then, the environment is transitioned to ERROR.
913

1014
Mesos slave health check can be configured with `MESOS_MAX_AGENT_PING_TIMEOUTS` (`--max_agent_ping_timeouts`) and `MESOS_AGENT_PING_TIMEOUT` (`--agent_ping_timeout`) parameters for Mesos.
1115
Effectively, the factor of the two parameters is the time needed to consider a slave/agent as lost.
12-
Please refer to Mesos documentation for more details.
16+
Please refer to [Mesos documentation](https://mesos.apache.org/documentation/latest/) for more details.

docs/running.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Running AliECS as a developer
22

3-
43
> **WARNING**: The running instructions described in this page are **for development purposes only**. Users interested in deploying, running and controlling O²/FLP software or their own software with AliECS should refer to the O²/FLP Suite instructions instead.
54
6-
75
## Running the AliECS core
86

97
This part assumes you have already set up the Go environment, fetched the sources and built all AliECS Go components.
108

11-
The recommended way to set up a Mesos cluster is by performing a complete deployment of the O²/FLP Suite with `o2-flp-setup`. The AliECS core on the head node should be stopped (`systemctl stop o2-aliecs-core`) and your own AliECS core should be made to point to the head node.
9+
The recommended way to set up a Mesos cluster is by performing a complete deployment of the O²/FLP Suite with `o2-flp-setup`.
10+
The AliECS core on the head node should be stopped (`systemctl stop o2-aliecs-core`) and your own AliECS core should be made to point to the head node.
11+
Typically, it can be done by replacing the AliECS core binary on the head node with your own and restarting the `o2-aliecs-core` systemd service.
1212

1313
The following example flags assume a remote head node `centosvmtest`, the use of the default `settings.yaml` file, very verbose output, verbose workflow dumps on every workflow deployment, and the executor having been copied (`scp`) to `/opt/o2control-executor` on all controlled nodes:
1414

0 commit comments

Comments
 (0)