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

Adapted Interdomain to common proto folder 

- Moved imports from *.proto folder to common.proto folder
- Removed interdomain's genproto.sh script
- Minor code and linting fixing
- Arranged requirements to accelerate Docker image creation
- Updated Dockerfile
- Arranged GitLab CI/CD pipeline
parent b1169fb0

src/interdomain/.gitlab-ci.yml

+15 −11
Original line number Diff line number Diff line
@@ -13,15 +13,15 @@ 
# limitations under the License.



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

build service:

build interdomain:

  variables:

    IMAGE_NAME: 'service' # name of the microservice

    IMAGE_NAME: 'interdomain' # 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 ./src/

    - 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:
@@ -30,6 +30,8 @@ build service: 
    - 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
@@ -37,13 +39,13 @@ build service: 
      - .gitlab-ci.yml



# Apply unit test to the component

unit test service:

unit test interdomain:

  variables:

    IMAGE_NAME: 'service' # name of the microservice

    IMAGE_NAME: 'interdomain' # name of the microservice

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

  stage: unit_test

  needs:

    - build service

    - build interdomain

  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
@@ -64,6 +66,8 @@ unit test service: 
    - 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
@@ -76,13 +80,13 @@ unit test service: 
        junit: src/$IMAGE_NAME/tests/${IMAGE_NAME}_report.xml



# Deployment of the service in Kubernetes Cluster

deploy service:

deploy interdomain:

  variables:

    IMAGE_NAME: 'service' # name of the microservice

    IMAGE_NAME: 'interdomain' # name of the microservice

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

  stage: deploy

  needs:

    - unit test service

    - unit test interdomain

    # - integ_test execute

  script:

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

src/interdomain/Dockerfile

+38 −19
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ 
# See the License for the specific language governing permissions and

# limitations under the License.



FROM python:3-slim

FROM python:3.9-slim



# Install dependencies

RUN apt-get --yes --quiet --quiet update && \
@@ -28,27 +28,46 @@ RUN GRPC_HEALTH_PROBE_VERSION=v0.2.0 && \ 
    chmod +x /bin/grpc_health_probe



# Get generic Python packages

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

RUN python3 -m pip install --upgrade pip

RUN python3 -m pip install --upgrade setuptools wheel

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



# Set working directory

# 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



# Create module sub-folders

# 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/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-folders, get specific Python packages

RUN mkdir -p /var/teraflow/interdomain

WORKDIR /var/teraflow/interdomain

COPY src/interdomain/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/

COPY src/device/. device/

COPY src/interdomain/. interdomain/

COPY src/monitoring/. monitoring/

COPY src/service/. service/

COPY src/slice/. slice/



# Get Python packages per module

COPY interdomain/requirements.in interdomain/requirements.in

RUN pip-compile --output-file=interdomain/requirements.txt interdomain/requirements.in

RUN python3 -m pip install -r interdomain/requirements.txt



# Add files into working directory

COPY common/. common

COPY context/. context

COPY device/. device

COPY interdomain/. interdomain

COPY monitoring/. monitoring

COPY service/. service

COPY slice/. slice



# Start interdomain service

# Start the service

ENTRYPOINT ["python", "-m", "interdomain.service"]

src/interdomain/client/InterdomainClient.py

+2 −2
Original line number Diff line number Diff line
@@ -15,10 +15,10 @@ 
import grpc, logging

from common.Constants import ServiceNameEnum

from common.Settings import get_service_host, get_service_port_grpc

from common.proto.context_pb2 import AuthenticationResult, Slice, SliceId, SliceStatus, TeraFlowController

from common.proto.interdomain_pb2_grpc import InterdomainServiceStub

from common.tools.client.RetryDecorator import retry, delay_exponential

from common.tools.grpc.Tools import grpc_message_to_json_string

from interdomain.proto.context_pb2 import AuthenticationResult, Slice, SliceId, SliceStatus, TeraFlowController

from interdomain.proto.interdomain_pb2_grpc import InterdomainServiceStub



LOGGER = logging.getLogger(__name__)

MAX_RETRIES = 15

src/interdomain/genproto.sh

deleted100755 → 0
+0 −52
Original line number Diff line number Diff line 
#!/bin/bash -eu

#

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



# Make folder containing the script the root folder for its execution

cd $(dirname $0)



rm -rf proto/*.py

rm -rf proto/__pycache__

tee proto/__init__.py << EOF > /dev/null

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



EOF



python -m grpc_tools.protoc -I../../proto --python_out=proto --grpc_python_out=proto context.proto

python -m grpc_tools.protoc -I../../proto --python_out=proto --grpc_python_out=proto kpi_sample_types.proto

python -m grpc_tools.protoc -I../../proto --python_out=proto --grpc_python_out=proto interdomain.proto

python -m grpc_tools.protoc -I../../proto --python_out=proto --grpc_python_out=proto slice.proto



rm proto/context_pb2_grpc.py

rm proto/kpi_sample_types_pb2_grpc.py

rm proto/slice_pb2_grpc.py



sed -i -E 's/(import\ .*)_pb2/from . \1_pb2/g' proto/context_pb2.py

sed -i -E 's/(import\ .*)_pb2/from . \1_pb2/g' proto/kpi_sample_types_pb2.py

sed -i -E 's/(import\ .*)_pb2/from . \1_pb2/g' proto/interdomain_pb2.py

sed -i -E 's/(import\ .*)_pb2/from . \1_pb2/g' proto/interdomain_pb2_grpc.py

sed -i -E 's/(import\ .*)_pb2/from . \1_pb2/g' proto/slice_pb2.py

src/interdomain/proto/__init__.py

deleted100644 → 0
+0 −14
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.