First draft (c8b24867) · Commits · TFS / controller

proto/ztp_server.proto

0 → 100755

+23 −0

Original line number	Diff line number	Diff line
		// Copyright 2022-2024 ETSI 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 ztpServer;

		import "context.proto";

		service ZtpServerService {
		rpc GetProvisioningScript (context.ProvisioningScriptName ) returns (context.ProvisioningScript ) {}
		rpc GetZtpProvisioning (context.ZtpFileName ) returns (context.ZtpFile ) {}
		}

src/common/Constants.py

+2 −0

Original line number	Diff line number	Diff line
		@@ -42,6 +42,7 @@ class ServiceNameEnum(Enum):
		SERVICE = 'service'
		SLICE = 'slice'
		ZTP = 'ztp'
		ZTP_SERVER = 'ztp_server'
		POLICY = 'policy'
		MONITORING = 'monitoring'
		DLT = 'dlt'
		@@ -84,6 +85,7 @@ DEFAULT_SERVICE_GRPC_PORTS = {
		ServiceNameEnum.SERVICE .value : 3030,
		ServiceNameEnum.SLICE .value : 4040,
		ServiceNameEnum.ZTP .value : 5050,
		ServiceNameEnum.ZTP_SERVER .value : 5051,
		ServiceNameEnum.POLICY .value : 6060,
		ServiceNameEnum.MONITORING .value : 7070,
		ServiceNameEnum.DLT .value : 8080,

src/ztp_server/.gitlab-ci.yml

0 → 100755

+120 −0

Original line number	Diff line number	Diff line
		# Copyright 2022-2024 ETSI 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.

		# Build, tag, and push the Docker image to the GitLab Docker registry
		build nbi:
		variables:
		IMAGE_NAME: 'nbi' # 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 nbi:
		variables:
		IMAGE_NAME: 'nbi' # name of the microservice
		IMAGE_TAG: 'latest' # tag of the container image (production, development, etc)
		stage: unit_test
		needs:
		- build nbi
		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 9090:9090 -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 --append -m pytest --log-level=INFO --verbose $IMAGE_NAME/tests/test_tfs_api.py --junitxml=/opt/results/${IMAGE_NAME}_report_tfs_api.xml"
		- docker exec -i $IMAGE_NAME bash -c "coverage run --append -m pytest --log-level=INFO --verbose $IMAGE_NAME/tests/test_ietf_l2vpn.py --junitxml=/opt/results/${IMAGE_NAME}_report_ietf_l2vpn.xml"
		- docker exec -i $IMAGE_NAME bash -c "coverage run --append -m pytest --log-level=INFO --verbose $IMAGE_NAME/tests/test_ietf_network.py --junitxml=/opt/results/${IMAGE_NAME}_report_ietf_network.xml"
		- docker exec -i $IMAGE_NAME bash -c "coverage run --append -m pytest --log-level=INFO --verbose $IMAGE_NAME/tests/test_ietf_l3vpn.py --junitxml=/opt/results/${IMAGE_NAME}_report_ietf_l3vpn.xml"
		- docker exec -i $IMAGE_NAME bash -c "coverage run --append -m pytest --log-level=INFO --verbose $IMAGE_NAME/tests/test_etsi_bwm.py --junitxml=/opt/results/${IMAGE_NAME}_report_etsi_bwm.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 nbi:
		# variables:
		# IMAGE_NAME: 'nbi' # name of the microservice
		# IMAGE_TAG: 'latest' # tag of the container image (production, development, etc)
		# stage: deploy
		# needs:
		# - unit test nbi
		# # - 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/ztp_server/Config.py

0 → 100755

+20 −0

Original line number	Diff line number	Diff line
		# Copyright 2022-2024 ETSI 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.

		from werkzeug.security import generate_password_hash

		# REST-API users
		RESTAPI_USERS = { # TODO: implement a database of credentials and permissions
		'admin': generate_password_hash('admin'),
		}

src/ztp_server/Dockerfile

0 → 100755

+97 −0

Original line number	Diff line number	Diff line
		# Copyright 2022-2024 ETSI 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.

		FROM python:3.9-slim

		# Install dependencies
		RUN apt-get --yes --quiet --quiet update && \
		apt-get --yes --quiet --quiet install wget g++ git build-essential cmake libpcre2-dev python3-dev python3-cffi && \
		rm -rf /var/lib/apt/lists/*

		# Download, build and install libyang. Note that APT package is outdated
		# - Ref: https://github.com/CESNET/libyang
		# - Ref: https://github.com/CESNET/libyang-python/
		RUN mkdir -p /var/libyang
		RUN git clone https://github.com/CESNET/libyang.git /var/libyang
		WORKDIR /var/libyang
		RUN git fetch
		RUN git checkout v2.1.148
		RUN mkdir -p /var/libyang/build
		WORKDIR /var/libyang/build
		RUN cmake -D CMAKE_BUILD_TYPE:String="Release" ..
		RUN make
		RUN make install
		RUN ldconfig

		# 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

		# 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

		# 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/nbi
		WORKDIR /var/teraflow/nbi
		COPY src/nbi/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/nbi/. nbi/
		COPY src/context/__init__.py context/__init__.py
		COPY src/context/client/. context/client/
		COPY src/device/__init__.py device/__init__.py
		COPY src/device/client/. device/client/
		COPY src/service/__init__.py service/__init__.py
		COPY src/service/client/. service/client/
		COPY src/slice/__init__.py slice/__init__.py
		COPY src/slice/client/. slice/client/
		COPY src/qkd_app/__init__.py qkd_app/__init__.py
		COPY src/qkd_app/client/. qkd_app/client/
		COPY src/vnt_manager/__init__.py vnt_manager/__init__.py
		COPY src/vnt_manager/client/. vnt_manager/client/
		RUN mkdir -p /var/teraflow/tests/tools
		COPY src/tests/tools/mock_osm/. tests/tools/mock_osm/

		# Start the service
		ENTRYPOINT ["python", "-m", "nbi.service"]