Creation VTNManager service

# Uncomment to activate E2E Orchestrator

#export TFS_COMPONENTS="${TFS_COMPONENTS} e2e_orchestrator"

# Uncomment to activate VNT Manager

#export TFS_COMPONENTS="${TFS_COMPONENTS} vnt_manager"

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

export TFS_IMAGE_TAG="dev"

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

build vntmanager:

  variables:

    IMAGE_NAME: 'vntmanager' # 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/$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

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

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

FROM python:3.9-slim

# Install dependencies

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

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

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

# Set Python to show logs as they occur

ENV PYTHONUNBUFFERED=0

ENV PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python

# 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

# Creating a user for security reasons

RUN groupadd -r teraflow && useradd -u 1001 --no-log-init -r -m -g teraflow teraflow

USER teraflow

# set working directory

RUN mkdir -p /home/teraflow/controller/common/

WORKDIR /home/teraflow/controller

# Get Python packages per module

ENV VIRTUAL_ENV=/home/teraflow/venv

RUN python3 -m venv ${VIRTUAL_ENV}

ENV PATH="${VIRTUAL_ENV}/bin:${PATH}"

# 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

COPY --chown=teraflow:teraflow 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

# Add common files into working directory

WORKDIR /home/teraflow/controller/common

COPY --chown=teraflow:teraflow src/common/. ./

RUN rm -rf proto

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

RUN mkdir -p /home/teraflow/controller/common/proto

WORKDIR /home/teraflow/controller/common/proto

RUN touch __init__.py

COPY --chown=teraflow:teraflow 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 module sub-folders

RUN mkdir -p /home/teraflow/controller/vnt_manager

WORKDIR /home/teraflow/controller

# Get Python packages per module

COPY --chown=teraflow:teraflow ./src/vnt_manager/requirements.in vnt_manager/requirements.in

# consider common and specific requirements to avoid inconsistencies with dependencies

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

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

# Add component files into working directory

COPY --chown=teraflow:teraflow ./src/context/. context

COPY --chown=teraflow:teraflow ./src/vnt_manager/. vnt_manager

# Start the service

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

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