Commit 3b3afa9e authored by Carlos Natalino's avatar Carlos Natalino
Browse files

Including the optical attack manager.

parent 5d8b9352

deploy/tfs.sh

+6 −0
Original line number Diff line number Diff line
@@ -169,11 +169,17 @@ kubectl create secret generic qdb-data --namespace ${TFS_K8S_NAMESPACE} --type=' 
    --from-literal=METRICSDB_PASSWORD=${QDB_PASSWORD}

printf "\n"



echo "Create Redis secret..."

REDIS_PASSWORD=`uuidgen`

kubectl create secret generic redis-secrets --namespace=$TFS_K8S_NAMESPACE \

    --from-literal=REDIS_PASSWORD=$REDIS_PASSWORD



echo "Deploying components and collecting environment variables..."

ENV_VARS_SCRIPT=tfs_runtime_env_vars.sh

echo "# Environment variables for TeraFlowSDN deployment" > $ENV_VARS_SCRIPT

PYTHONPATH=$(pwd)/src

echo "export PYTHONPATH=${PYTHONPATH}" >> $ENV_VARS_SCRIPT

echo "export REDIS_PASSWORD=${REDIS_PASSWORD}" >> $ENV_VARS_SCRIPT



for COMPONENT in $TFS_COMPONENTS; do

    echo "Processing '$COMPONENT' component..."

manifests/opticalattackmanagerservice.yaml

0 → 100644
+86 −0
Original line number Diff line number Diff line 
# Copyright 2021-2023 H2020 TeraFlow (https://www.teraflow-h2020.eu/)

#

# 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: opticalattackmanagerservice

spec:

  selector:

    matchLabels:

      app: opticalattackmanagerservice

  template:

    metadata:

      labels:

        app: opticalattackmanagerservice

    spec:

      terminationGracePeriodSeconds: 5

      containers:

      - name: server

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

        imagePullPolicy: Always

        ports:

        - containerPort: 10005

        - containerPort: 9192

        env:

        - name: LOG_LEVEL

          value: "DEBUG"

        - name: MONITORING_INTERVAL

          value: "30"

        - name: OPTICALATTACKMANAGERSERVICE_LOOP_MIN_WORKERS

          value: "2"  # remember to align this with the resource limits

        - name: OPTICALATTACKMANAGERSERVICE_LOOP_MAX_WORKERS

          value: "10"  # remember to align this with the resource limits

        - name: REDIS_PASSWORD

          valueFrom:

            secretKeyRef:

              name: redis-secrets

              key: REDIS_PASSWORD

        resources:

          requests:

            cpu: 250m

            memory: 128Mi

          limits:

            cpu: 10000m

            memory: 10240Mi

---

apiVersion: v1

kind: Service

metadata:

  name: opticalattackmanagerservice

  labels:

    app: opticalattackmanagerservice

spec:

  type: ClusterIP

  selector:

    app: opticalattackmanagerservice

  ports:

  - name: grpc

    port: 10005

    targetPort: 10005

  - name: metrics

    port: 9192

    targetPort: 9192

---

apiVersion: autoscaling/v2

kind: HorizontalPodAutoscaler

metadata:

  name: opticalattackdetectorservice-hpa

spec:

  scaleTargetRef:

    apiVersion: apps/v1

    kind: Deployment

    name: opticalattackdetectorservice

  minReplicas: 1

  maxReplicas: 1

my_deploy.sh

+6 −3
Original line number Diff line number Diff line
@@ -22,6 +22,9 @@ export TFS_REGISTRY_IMAGES="http://localhost:32000/tfs/" 
# Set the list of components, separated by spaces, you want to build images for, and deploy.

export TFS_COMPONENTS="context device automation monitoring pathcomp service slice compute webui load_generator"



# addition for the optical cybersecurity component

export TFS_COMPONENTS="${TFS_COMPONENTS} dbscanserving opticalattackmitigator opticalattackdetector opticalattackmanager"



# Set the tag you want to use for your images.

export TFS_IMAGE_TAG="dev"
@@ -29,7 +32,7 @@ export TFS_IMAGE_TAG="dev" 
export TFS_K8S_NAMESPACE="tfs"



# Set additional manifest files to be applied after the deployment

export TFS_EXTRA_MANIFESTS="manifests/nginx_ingress_http.yaml manifests/servicemonitors.yaml"

export TFS_EXTRA_MANIFESTS="manifests/nginx_ingress_http.yaml manifests/servicemonitors.yaml manifests/cachingservice.yaml"



# Set the new Grafana admin password

export TFS_GRAFANA_PASSWORD="admin123+"
@@ -63,7 +66,7 @@ export CRDB_DATABASE="tfs" 
export CRDB_DEPLOY_MODE="single"



# Disable flag for dropping database, if it exists.

export CRDB_DROP_DATABASE_IF_EXISTS=""

export CRDB_DROP_DATABASE_IF_EXISTS="YES"



# Disable flag for re-deploying CockroachDB from scratch.

export CRDB_REDEPLOY=""
@@ -111,7 +114,7 @@ export QDB_TABLE_MONITORING_KPIS="tfs_monitoring_kpis" 
export QDB_TABLE_SLICE_GROUPS="tfs_slice_groups"



# Disable flag for dropping tables if they exist.

export QDB_DROP_TABLES_IF_EXIST=""

export QDB_DROP_TABLES_IF_EXIST="YES"



# Disable flag for re-deploying QuestDB from scratch.

export QDB_REDEPLOY=""

src/opticalattackmanager/.gitlab-ci.yml

0 → 100644
+105 −0
Original line number Diff line number Diff line 
# Copyright 2021-2023 H2020 TeraFlow (https://www.teraflow-h2020.eu/)

#

# 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.



# Build, tag, and push the Docker image to the GitLab Docker registry

build opticalattackmanager:

  variables:

    IMAGE_NAME: 'opticalattackmanager' # name of the microservice

    IMAGE_TAG: 'latest' # tag of the container image (production, development, etc)

  stage: build

  before_script:

    - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY

  script:

    - docker build -t "$IMAGE_NAME:$IMAGE_TAG" -f ./src/$IMAGE_NAME/Dockerfile .

    - docker tag "$IMAGE_NAME:$IMAGE_TAG" "$CI_REGISTRY_IMAGE/$IMAGE_NAME:$IMAGE_TAG"

    - docker push "$CI_REGISTRY_IMAGE/$IMAGE_NAME:$IMAGE_TAG"

  after_script:

    - docker images --filter="dangling=true" --quiet | xargs -r docker rmi

  rules:

    - if: '$CI_PIPELINE_SOURCE == "merge_request_event" && ($CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "develop" || $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH)'

    - if: '$CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == "develop"'

    - changes:

      - src/common/**/*.py

      - proto/*.proto

      - src/$IMAGE_NAME/**/*.{py,in,yml}

      - src/$IMAGE_NAME/Dockerfile

      - src/$IMAGE_NAME/tests/*.py

      - manifests/${IMAGE_NAME}service.yaml

      - .gitlab-ci.yml



# Apply unit test to the component

unit test opticalattackmanager:

  variables:

    IMAGE_NAME: 'opticalattackmanager' # name of the microservice

    IMAGE_TAG: 'latest' # tag of the container image (production, development, etc)

  stage: unit_test

  needs:

    - build opticalattackmanager

  before_script:

    - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY

    - if docker network list | grep teraflowbridge; then echo "teraflowbridge is already created"; else docker network create -d bridge teraflowbridge; fi

    - if docker container ls | grep $IMAGE_NAME; then docker rm -f $IMAGE_NAME; else echo "$IMAGE_NAME image is not in the system"; fi

  script:

    - docker pull "$CI_REGISTRY_IMAGE/$IMAGE_NAME:$IMAGE_TAG"

    - docker run --name $IMAGE_NAME -d -p 10005:10005 -v "$PWD/src/$IMAGE_NAME/tests:/home/teraflow/$IMAGE_NAME/results" --network=teraflowbridge $CI_REGISTRY_IMAGE/$IMAGE_NAME:$IMAGE_TAG

    - docker ps -a

    - docker logs $IMAGE_NAME

    - docker exec -i $IMAGE_NAME bash -c "coverage run -m pytest --log-level=INFO --verbose $IMAGE_NAME/tests/test_unitary.py --junitxml=/home/teraflow/$IMAGE_NAME/results/${IMAGE_NAME}_report.xml"

    - docker exec -i $IMAGE_NAME bash -c "coverage report --include='${IMAGE_NAME}/*' --show-missing"

  coverage: '/TOTAL\s+\d+\s+\d+\s+(\d+%)/'

  after_script:

    - docker rm -f $IMAGE_NAME

    - docker network rm teraflowbridge

  rules:

    - if: '$CI_PIPELINE_SOURCE == "merge_request_event" && ($CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "develop" || $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH)'

    - if: '$CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == "develop"'

    - changes:

      - src/common/**/*.py

      - proto/*.proto

      - src/$IMAGE_NAME/**/*.{py,in,yml}

      - src/$IMAGE_NAME/Dockerfile

      - src/$IMAGE_NAME/tests/*.py

      - src/$IMAGE_NAME/tests/Dockerfile

      - manifests/${IMAGE_NAME}service.yaml

      - .gitlab-ci.yml

  artifacts:

      when: always

      reports:

        junit: src/$IMAGE_NAME/tests/${IMAGE_NAME}_report.xml



# Deployment of the service in Kubernetes Cluster

deploy opticalattackmanager:

  variables:

    IMAGE_NAME: 'opticalattackmanager' # name of the microservice

    IMAGE_TAG: 'latest' # tag of the container image (production, development, etc)

  stage: deploy

  needs:

    - unit test opticalattackmanager

    # - integ_test execute

  script:

    - 'sed -i "s/$IMAGE_NAME:.*/$IMAGE_NAME:$IMAGE_TAG/" manifests/${IMAGE_NAME}service.yaml'

    - kubectl version

    - kubectl get all

    - kubectl apply -f "manifests/${IMAGE_NAME}service.yaml"

    - kubectl get all

  # environment:

  #   name: test

  #   url: https://example.com

  #   kubernetes:

  #     namespace: test

  rules:

    - if: '$CI_PIPELINE_SOURCE == "merge_request_event" && ($CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "develop" || $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH)'

      when: manual    

    - if: '$CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == "develop"'

      when: manual

src/opticalattackmanager/Config.py

0 → 100644
+24 −0
Original line number Diff line number Diff line 
# Copyright 2021-2023 H2020 TeraFlow (https://www.teraflow-h2020.eu/)

#

# 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.



import logging



# General settings

LOG_LEVEL = logging.DEBUG



# service settings

MONITORING_INTERVAL = 10  # monitoring interval in seconds



# Prometheus settings

METRICS_PORT = 9192