Merge branch 'pr-automation-doc' into 'develop'

doc(automation): update README

See merge request teraflow-h2020/controller!183

src/automation/README.md

-# Automation TeraFlow OS service 
+# TeraFlowSDN Automation service
 
-The Automation service, also known as Zero-Touch Provisioning (ZTP), is tested on Ubuntu 20.04. Follow the instructions below to build, test, and run this service on your local environment.
+This repository hosts the TeraFlowSDN Automation service, also known as Zero-Touch Provisioning (ZTP) service.
+Follow the instructions below to build, test, and run this service on your local environment.
 
-## Automation Teraflow OS service architecture
+## TeraFlowSDN Automation service architecture
 
-| The Automation Teraflow OS service architecture consists of six (6) interfaces listed below:                                                                                                                                                 | 
+The TeraFlowSDN Automation architecture consists of six (6) interfaces listed below:
+
+Interfaces |
 |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| 1. The `AutomationGateway` interface that implements all the rpc functions that are described in `automation.proto` file.                                                                                                                    | 
-| 2. The `ContextGateway` interface that communicates with a `Context` Service gRPC client and implements all the rpc functions that are described in `context.proto` file.                                                                    |
-| 3. The `DeviceGateway` interface that communicates with a `Device` Service gRPC client and implements all the rpc functions that are described in `device.proto` file.                                                                       |
-| 4. The `AutomationService` interface that implements the `addDevice()` method by communicating with a `Context` gRPC client & a `Device` gRPC client through the use of `ContextService` interface & `DeviceService` interface respectively. |
-| 5. The `ContextService` interface that implements the `getDevice()` & `getDeviceEvents()` methods by communicating with a `Context` gRPC client through the use of `ContextGateway` interface.                                               |
-| 6. The `DeviceService` interface that implements the `getInitialConfiguration()` & `configureDevice()` methods by communicating with a `Device` gRPC client through the use of `DeviceGateway` interface.                                    |
+| 1. The `AutomationGateway` interface that implements all the RPC functions that are described in `automation.proto` file. |
+| 2. The `ContextGateway` interface that communicates with a `Context` Service gRPC client to invoke key RPC functions described in `context.proto` file. |
+| 3. The `DeviceGateway` interface that communicates with a `Device` Service gRPC client to invoke key RPC functions described in `device.proto` file. |
+| 4. The `AutomationService` interface that implements the `addDevice()`, `updateDevice()`, and `deleteDevice()` methods by communicating with a `Context` gRPC client and a `Device` gRPC client through the use of `ContextService` interface and `DeviceService` interface respectively. |
+| 5. The `ContextService` interface that implements the `getDevice()` and `getDeviceEvents()` methods by communicating with a `Context` gRPC client through the use of `ContextGateway` interface. |
+| 6. The `DeviceService` interface that implements the `getInitialConfiguration()`, `configureDevice()`, and `deleteDevice()` methods by communicating with a `Device` gRPC client through the use of `DeviceGateway` interface. |
+
+
+## Prerequisites
 
+The Automation service is currently tested against Ubuntu 20.04 and Java 11.
 
-## Run with dev profile
+To quickly install Java 11 on a Debian-based Linux distro do:
 
 ```bash
-./mvnw clean quarkus:dev
+sudo apt-get install openjdk-11-jdk -y
 ```
 
-## Running tests
+Feel free to try more recent Java versions.
+
+## Compile
+
+```bash
+./mvnw compile
+```
+
+## Run tests
+
+```bash
+./mvnw test
+```
 
-Run unit and functional tests `./mvnw clean test`
+## Run service
+
+```bash
+./mvnw quarkus:dev
+````
+
+## Clean
+
+```bash
+./mvnw clean
+```
 
 ## Deploying on a Kubernetes cluster
 
@@ -30,10 +59,16 @@ To create the K8s manifest file under `target/kubernetes/kubernetes.yml` to be u
 
 ```bash
 ./mvnw clean package -DskipUTs -DskipITs
-``` 
+```
 
 To deploy the application in a K8s cluster run
 
 ```bash
 kubectl apply -f "manifests/automationservice.yaml"
 ```
+
+## Maintainers
+
+This TeraFlowSDN service is implemented by [UBITECH](www.ubitech.eu).
+
+Feel free to contact Georgios Katsikas (gkatsikas at ubitech dot eu) in case you have questions.