Automation component skeleton

Konstantinos Poulakakisrequested to merge
feat/159-automation-component-skeleton into develop

Closes #159 (closed)

Skeleton Python code for the new Automation component and its planned integration with Monitoring, Analytics, Policy, and Service/SBI components.

Edited by Lluis Gifre Renom

Merge request reports

manifests/automationservice.yaml

0 → 100644
+80 −0
Changes for manifests/automationservice.yaml: 80 added lines, 0 removed lines.
Original line number Diff line number Diff line 
# Copyright 2022-2024 ETSI OSG/SDG TeraFlowSDN (TFS) (https://tfs.etsi.org/)

#

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

#

#      http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.



apiVersion: apps/v1

kind: Deployment

metadata:

  name: automationservice

spec:

  selector:

    matchLabels:

      app: automationservice

  replicas: 1

  template:

    metadata:

      annotations:

        # Required for IETF L2VPN SBI when both parent and child run in same K8s cluster with Linkerd

        config.linkerd.io/skip-outbound-ports: "2002"

      labels:

        app: automationservice

    spec:

      terminationGracePeriodSeconds: 5

      containers:

        - name: server

          image: labs.etsi.org:5050/tfs/controller/automation:latest

          imagePullPolicy: Always

          ports:

            - containerPort: 30200

            - containerPort: 9192

          env:

            - name: LOG_LEVEL

              value: "INFO"

          startupProbe:

            exec:

              command: ["/bin/grpc_health_probe", "-addr=:30200"]

            failureThreshold: 30

            periodSeconds: 1

          readinessProbe:

            exec:

              command: ["/bin/grpc_health_probe", "-addr=:30200"]

          livenessProbe:

            exec:

              command: ["/bin/grpc_health_probe", "-addr=:30200"]

          resources:

            requests:

              cpu: 250m

              memory: 128Mi

            limits:

              cpu: 1000m

              memory: 1024Mi

---

apiVersion: v1

kind: Service

metadata:

  name: automationservice

  labels:

    app: automationservice

spec:

  type: ClusterIP

  selector:

    app: automationservice

  ports:

    - name: grpc

      protocol: TCP

      port: 30200

      targetPort: 30200

    - name: metrics

      protocol: TCP

      port: 9192

      targetPort: 9192

proto/automation.proto

0 → 100644
+69 −0
Changes for proto/automation.proto: 69 added lines, 0 removed lines.
Original line number Diff line number Diff line 
// Copyright 2022-2024 ETSI OSG/SDG TeraFlowSDN (TFS) (https://tfs.etsi.org/)

//

// Licensed under the Apache License, Version 2.0 (the "License");

// you may not use this file except in compliance with the License.

// You may obtain a copy of the License at

//

//      http://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing, software

// distributed under the License is distributed on an "AS IS" BASIS,

// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

// See the License for the specific language governing permissions and

// limitations under the License.



syntax = "proto3";

package automation;



import "context.proto";

import "policy.proto";



// Automation service RPCs

service AutomationService {

  rpc ZSMCreate       (ZSMCreateRequest ) returns (ZSMService     ) {}

  rpc ZSMUpdate       (ZSMCreateUpdate  ) returns (ZSMService     ) {}

  rpc ZSMDelete       (ZSMServiceID     ) returns (ZSMServiceState) {}

  rpc ZSMGetById      (ZSMServiceID     ) returns (ZSMService     ) {}

  rpc ZSMGetByService (context.ServiceId) returns (ZSMService     ) {}

}



// ZSM service states

enum ZSMServiceStateEnum {

  ZSM_UNDEFINED = 0;     // Undefined ZSM loop state

  ZSM_FAILED = 1;        // ZSM loop failed

  ZSM_ACTIVE = 2;        // ZSM loop is currently active

  ZSM_INACTIVE = 3;      // ZSM loop is currently inactive

  ZSM_UPDATED = 4;       // ZSM loop is updated

  ZSM_REMOVED = 5;       // ZSM loop is removed

}



message ZSMCreateRequest {

  context.ServiceId serviceId = 1;

  policy.PolicyRuleList policyList = 2;

}



message ZSMCreateUpdate {

  context.Uuid ZSMServiceID = 1;

  policy.PolicyRuleList policyList = 2;

}



// A unique identifier per ZSM service

message ZSMServiceID {

  context.Uuid uuid = 1;

}



// The state of a ZSM service

message ZSMServiceState {

  ZSMServiceStateEnum zsmServiceState = 1;

  string zsmServiceStateMessage = 2;

}



// Basic ZSM service attributes

message ZSMService {

  ZSMServiceID zsmServiceId = 1;



  context.ServiceId serviceId = 2;

  policy.PolicyRuleList policyList = 3;



  // TODO: When new Analytics and updated Monitoring are in place, add the necessary binding to them

}

scripts/run_tests_locally-analytics-DB.sh

+1 −1
Changes for scripts/run_tests_locally-analytics-DB.sh: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -19,6 +19,6 @@ PROJECTDIR=`pwd` 
cd $PROJECTDIR/src

RCFILE=$PROJECTDIR/coverage/.coveragerc

CRDB_SQL_ADDRESS=$(kubectl get service cockroachdb-public --namespace crdb -o jsonpath='{.spec.clusterIP}')

export CRDB_URI="cockroachdb://tfs:tfs123@${CRDB_SQL_ADDRESS}:26257/tfs_kpi_mgmt?sslmode=require"

export CRDB_URI="cockroachdb://tfs:tfs123@${CRDB_SQL_ADDRESS}:26257/tfs_analytics?sslmode=require"

python3 -m pytest --log-level=DEBUG --log-cli-level=DEBUG --verbose \

    analytics/tests/test_analytics_db.py

scripts/run_tests_locally-analytics-backend.sh

+1 −1
Changes for scripts/run_tests_locally-analytics-backend.sh: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -20,6 +20,6 @@ cd $PROJECTDIR/src 
RCFILE=$PROJECTDIR/coverage/.coveragerc

export KFK_SERVER_ADDRESS='127.0.0.1:9092'

CRDB_SQL_ADDRESS=$(kubectl get service cockroachdb-public --namespace crdb -o jsonpath='{.spec.clusterIP}')

export CRDB_URI="cockroachdb://tfs:tfs123@${CRDB_SQL_ADDRESS}:26257/tfs_kpi_mgmt?sslmode=require"

export CRDB_URI="cockroachdb://tfs:tfs123@${CRDB_SQL_ADDRESS}:26257/tfs_analytics?sslmode=require"

python3 -m pytest --log-level=DEBUG --log-cli-level=DEBUG --verbose \

    analytics/backend/tests/test_backend.py

scripts/run_tests_locally-analytics-frontend.sh

+1 −1
Changes for scripts/run_tests_locally-analytics-frontend.sh: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -20,6 +20,6 @@ cd $PROJECTDIR/src 
RCFILE=$PROJECTDIR/coverage/.coveragerc

export KFK_SERVER_ADDRESS='127.0.0.1:9092'

CRDB_SQL_ADDRESS=$(kubectl get service cockroachdb-public --namespace crdb -o jsonpath='{.spec.clusterIP}')

export CRDB_URI="cockroachdb://tfs:tfs123@${CRDB_SQL_ADDRESS}:26257/tfs_kpi_mgmt?sslmode=require"

export CRDB_URI="cockroachdb://tfs:tfs123@${CRDB_SQL_ADDRESS}:26257/tfs_analytics?sslmode=require"

python3 -m pytest --log-level=DEBUG --log-cli-level=DEBUG --verbose \

    analytics/frontend/tests/test_frontend.py