Commit aad71eb8 authored by Lluis Gifre Renom's avatar Lluis Gifre Renom
Browse files

Optical Controller component: 

- Added CI/CD pipeline descriptor
- Homogeneized Dockerfile
parent 4066f05a

.gitlab-ci.yml

+1 −0
Original line number Diff line number Diff line
@@ -31,6 +31,7 @@ include: 
  - local: '/src/opticalattackmitigator/.gitlab-ci.yml'

  - local: '/src/opticalattackdetector/.gitlab-ci.yml'

  - local: '/src/opticalattackmanager/.gitlab-ci.yml'

  - local: '/src/opticalcontroller/.gitlab-ci.yml'

  - local: '/src/ztp/.gitlab-ci.yml'

  - local: '/src/policy/.gitlab-ci.yml'

  - local: '/src/forecaster/.gitlab-ci.yml'

src/opticalcontroller/.gitlab-ci.yml

0 → 100644
+105 −0
Original line number Diff line number Diff line 
# Copyright 2022-2023 ETSI TeraFlowSDN - TFS OSG (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.



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

build opticalcontroller:

  variables:

    IMAGE_NAME: 'opticalcontroller' # 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 buildx 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 opticalcontroller:

#  variables:

#    IMAGE_NAME: 'opticalcontroller' # name of the microservice

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

#  stage: unit_test

#  needs:

#    - build opticalcontroller

#  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 --driver=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 20030:20030  -v "$PWD/src/$IMAGE_NAME/tests:/opt/results" --network=teraflowbridge $CI_REGISTRY_IMAGE/$IMAGE_NAME:$IMAGE_TAG

#    - sleep 5

#    - 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=/opt/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

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

#  variables:

#    IMAGE_NAME: 'opticalcontroller' # name of the microservice

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

#  stage: deploy

#  needs:

#    - unit test opticalcontroller

#    # - 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/opticalcontroller/Dockerfile

+16 −24
Original line number Diff line number Diff line
@@ -16,63 +16,55 @@ FROM python:3.9-slim 


# Install dependencies

RUN apt-get --yes --quiet --quiet update && \

    apt-get --yes --quiet --quiet install wget g++ && \

    apt-get --yes --quiet --quiet install wget g++ git && \

    rm -rf /var/lib/apt/lists/*



# Set Python to show logs as they occur

ENV PYTHONUNBUFFERED=0



# Download the gRPC health probe

# RUN GRPC_HEALTH_PROBE_VERSION=v0.2.0 && \

#     wget -qO/bin/grpc_health_probe https://github.com/grpc-ecosystem/grpc-health-probe/releases/download/${GRPC_HEALTH_PROBE_VERSION}/grpc_health_probe-linux-amd64 && \

#     chmod +x /bin/grpc_health_probe







RUN GRPC_HEALTH_PROBE_VERSION=v0.2.0 && \

    wget -qO/bin/grpc_health_probe https://github.com/grpc-ecosystem/grpc-health-probe/releases/download/${GRPC_HEALTH_PROBE_VERSION}/grpc_health_probe-linux-amd64 && \

    chmod +x /bin/grpc_health_probe



# Get generic Python packages

RUN python3 -m pip install --upgrade pip

RUN python3 -m pip install --upgrade setuptools wheel

RUN python3 -m pip install --upgrade pip-tools







# Get common Python packages

# Note: this step enables sharing the previous Docker build steps among all the Python components

WORKDIR /var/teraflow

COPY common_requirements.in common_requirements.in

RUN pip-compile --quiet --output-file=common_requirements.txt common_requirements.in

RUN python3 -m pip install -r common_requirements.txt



RUN mkdir -p /var/teraflow/opticalcontroller



WORKDIR /var/teraflow/opticalcontroller/common

# Add common files into working directory

WORKDIR /var/teraflow/common

COPY src/common/. ./

RUN rm -rf proto





# Create proto sub-folder, copy .proto files, and generate Python code

RUN mkdir -p /var/teraflow/opticalcontroller/common/proto

WORKDIR /var/teraflow/opticalcontroller/common/proto

RUN mkdir -p /var/teraflow/common/proto

WORKDIR /var/teraflow/common/proto

RUN touch __init__.py

COPY proto/*.proto ./

RUN python3 -m grpc_tools.protoc -I=. --python_out=. --grpc_python_out=. *.proto

RUN rm *.proto

RUN find . -type f -exec sed -i -E 's/(import\ .*)_pb2/from . \1_pb2/g' {} \;



# Create component sub-folder, get specific Python packages







# Create component sub-folders, get specific Python packages

RUN mkdir -p /var/teraflow/opticalcontroller

WORKDIR /var/teraflow/opticalcontroller

COPY src/opticalcontroller/requirements.in requirements.in

RUN pip-compile --quiet --output-file=requirements.txt requirements.in

RUN python3 -m pip install -r requirements.txt



# Add component files into working directory

WORKDIR /var/teraflow/



COPY src/context/. context/



WORKDIR /var/teraflow

COPY src/context/__init__.py context/__init__.py

COPY src/context/client/. context/client/

COPY src/opticalcontroller/. opticalcontroller/

COPY src/context/. opticalcontroller/context/



# Start the service

WORKDIR /var/teraflow/opticalcontroller