Commit 17d40a0c authored by kesnar's avatar kesnar
Browse files

refactor: refactor in various resource files

parent de5f7528
Loading
Loading
Loading
Loading
+8 −8
Original line number Diff line number Diff line
# TeraFlowSDN Automation service
# TeraFlowSDN Ztp service

This repository hosts the TeraFlowSDN Automation service, also known as Zero-Touch Provisioning (ZTP) service.
This repository hosts the TeraFlowSDN Ztp service, also known as Zero-Touch Provisioning (ZTP) service.
Follow the instructions below to build, test, and run this service on your local environment.

## TeraFlowSDN Automation service architecture
## TeraFlowSDN Ztp service architecture

The TeraFlowSDN Automation architecture consists of six (6) interfaces listed below:
The TeraFlowSDN Ztp 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. |
| 1. The `ZtpGateway` interface that implements all the RPC functions that are described in `ztp.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. |
| 4. The `ZtpService` 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.
The Ztp service is currently tested against Ubuntu 20.04 and Java 11.

To quickly install Java 11 on a Debian-based Linux distro do:

@@ -64,7 +64,7 @@ To create the K8s manifest file under `target/kubernetes/kubernetes.yml` to be u
To deploy the application in a K8s cluster run

```bash
kubectl apply -f "manifests/automationservice.yaml"
kubectl apply -f "manifests/ztpservice.yaml"
```

## Maintainers
+3 −3
Original line number Diff line number Diff line
@@ -20,10 +20,10 @@
  <modelVersion>4.0.0</modelVersion>

  <groupId>eu.teraflow</groupId>
  <artifactId>automation</artifactId>
  <artifactId>ztp</artifactId>
  <version>0.2.0</version>
  <name>TeraFlow Automation Component</name>
  <description>TeraFlow Automation Component</description>
  <name>TeraFlow ZTP Component</name>
  <description>TeraFlow ZTP Component</description>

  <properties>
    <java.version>11</java.version>
+5 −5
Original line number Diff line number Diff line
@@ -12,11 +12,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.

automation:
ztp:
  should-subscribe-to-context-component: true
quarkus:
  banner:
    path: teraflow-automation-banner.txt
    path: teraflow-ztp-banner.txt
  grpc: 
    server:
      port: 5050
@@ -34,15 +34,15 @@ quarkus:

  container-image:
    group: tfs
    name: controller/automation
    name: controller/ztp
    registry: labs.etsi.org:5050
    tag: 0.2.0

  kubernetes:
    name: automationservice
    name: ztpservice
    image-pull-policy: Always
    labels:
      app: automationservice
      app: ztpservice
    add-version-to-label-selectors: false
    readiness-probe:
      initial-delay: 2s
+0 −9
Original line number Diff line number Diff line

  _______             ______ _                               _                        _   _
 |__   __|           |  ____| |                   /\        | |                      | | (_)
    | | ___ _ __ __ _| |__  | | _____      __    /  \  _   _| |_ ___  _ __ ___   __ _| |_ _  ___  _ __
    | |/ _ \ '__/ _` |  __| | |/ _ \ \ /\ / /   / /\ \| | | | __/ _ \| '_ ` _ \ / _` | __| |/ _ \| '_ \
    | |  __/ | | (_| | |    | | (_) \ V  V /   / ____ \ |_| | || (_) | | | | | | (_| | |_| | (_) | | | |
    |_|\___|_|  \__,_|_|    |_|\___/ \_/\_/   /_/    \_\__,_|\__\___/|_| |_| |_|\__,_|\__|_|\___/|_| |_|

+8 −0
Original line number Diff line number Diff line
  _______             ______ _                 _____________ _____  
 |__   __|           |  ____| |               |___  /__   __|  __ \ 
    | | ___ _ __ __ _| |__  | | _____      __    / /   | |  | |__) |
    | |/ _ \ '__/ _` |  __| | |/ _ \ \ /\ / /   / /    | |  |  ___/ 
    | |  __/ | | (_| | |    | | (_) \ V  V /   / /__   | |  | |     
    |_|\___|_|  \__,_|_|    |_|\___/ \_/\_/   /_____|  |_|  |_|     
                                                                    
                                                                    
 No newline at end of file