From 1e4eecdbf19de19527eca370280c96eebcfe5e2b Mon Sep 17 00:00:00 2001 From: Jorge Moratinos Salcines Date: Fri, 31 Jan 2025 12:46:41 +0100 Subject: [PATCH 1/3] Removing information present on ocf documentation webpage --- README.md | 134 ++---------------------------------------------------- 1 file changed, 3 insertions(+), 131 deletions(-) diff --git a/README.md b/README.md index 74a32c28..7bb59f6b 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,6 @@ - [CAPIF\_API\_Services](#capif_api_services) - [Documentation](#documentation) - [Install and Run](#install-and-run) - - [How to run CAPIF services in this Repository](#how-to-run-capif-services-in-this-repository) - - [Run All CAPIF Services locally with Docker images](#run-all-capif-services-locally-with-docker-images) - - [Run All CAPIF Services locally with Docker images and deploy monitoring stack](#run-all-capif-services-locally-with-docker-images-and-deploy-monitoring-stack) - - [Run each service using Docker](#run-each-service-using-docker) - - [Run each service using Python](#run-each-service-using-python) -- [Important urls:](#important-urls) - - [Mongo CAPIF's DB Dashboard](#mongo-capifs-db-dashboard) - - [Mongo Register's DB Dashboard](#mongo-registers-db-dashboard) - [FAQ Documentation](#faq-documentation) @@ -24,130 +16,9 @@ This repository has the python-flask Mockup servers created with openapi-generat Please refer to [OCF Documentation] for more detailed information. +# Install and Run -# Install and Run - -## How to run CAPIF services in this Repository -Capif services are developed under /service/ folder. - -### Run All CAPIF Services locally with Docker images -To run using docker and docker compose, version 2.10 or higher, you must ensure you have that tools installed at your machine. Also to simplify the process, we have 3 script to control docker images to deploy, check and cleanup. - -To run all CAPIF APIs locally using docker and docker-compose you can execute: -``` -cd services/ - -./run.sh -``` -This will build and run all services using docker images, including mongodb and nginx locally and in background, and import ca.crt to nginx. - -Nginx deployed by default use **capifcore** hostname, but can add a parameter when run.sh is executed setting a different hostname, for example, -``` -./run.sh -c openshift.evolved-5g.eu -``` - -Also you can run monitoring just using option -m true, for example: -``` -./run.sh -m true -./run.sh -m true -c openshift.evolved-5g.eu -``` - -If you want to check if all CAPIF services are running properly in local machine after execute run.sh, we can use: -``` -./check_services_are_running.sh -``` -This shell script will return 0 if all services are running properly. - -When we need to stop all CAPIF services, we can use next bash script: -``` -./clean_capif_docker_services.sh -a -``` - -NOTE: You can use different flags if you only want to stop some of them, please check help using -``` -./clean_capif_docker_services.sh -h - -Usage: clean_capif_docker_services.sh - -c : clean capif services - -v : clean vault service - -r : clean register service - -m : clean monitoring service - -a : clean all services - -h : show this help -`````` - -This shell script will remove and clean all CAPIF services started previously with run.sh - -On the other hand you can check logs using show_logs.sh script, please check options: -``` -./show_logs.sh -You must specify an option before run script. -Usage: ./show_logs.sh - -c : Show capif services - -v : Show vault service - -r : Show register service - -m : Show monitoring service - -a : Show all services - -f : Follow log output - -h : Show this help -``` -You can also use option -f in order to live follow log output - -### Run All CAPIF Services locally with Docker images and deploy monitoring stack -It is now possible to deploy a monitoring stack for CAPIF with Grafana, Prometheus, FluentBit, Loki, Cadvisor, Tempo and Opentelemetry. - -To deploy CAPIF together with the monitoring stack, it is only necessary to execute the following. - -``` -./run.sh -m true -``` - -After they have been built, the different panels can be consulted in Grafana at the url - -``` -http://localhost:3000 -``` - -By default, the monitoring option is set to false. Once up, all data sources and dashboards are automatically provisioned - -### Run each service using Docker - -Also you can run service by service using docker: -``` -cd -docker build -t capif_security . -docker run -p 8080:8080 capif_security -``` - -### Run each service using Python - -Run using python -``` -cd -pip3 install -r requirements.txt -python3 -m -``` - -# Important urls: - -## Mongo CAPIF's DB Dashboard -``` -http://localhost:8082/ (if accessed from localhost) - -or - -http://:8082/ (if accessed from another host) -``` - -## Mongo Register's DB Dashboard -``` -http://localhost:8083/ (if accessed from localhost) - -or - -http://:8083/ (if accessed from another host) -``` - +Please refer to [OCF How to run] for more detailed information. # FAQ Documentation @@ -159,4 +30,5 @@ Frequently asked questions can be found here: [FAQ Directory] [Testing with Robot Framework]: ./docs/testing_with_robot/README.md "Testing with Robot Framework" [FAQ Directory]: https://ocf.etsi.org/documentation/latest/FAQ/ "FAQ Url" [OCF Documentation]: https://ocf.etsi.org/documentation/latest/ "OCF Documentation" +[OCF How to run]: https://ocf.etsi.org/documentation/latest/gettingstarted/howtorun/ "How to run" -- GitLab From 700894ce428839001c25da0968f5caaf57f5c28f Mon Sep 17 00:00:00 2001 From: Jorge Moratinos Salcines Date: Fri, 31 Jan 2025 12:51:41 +0100 Subject: [PATCH 2/3] Changed informatino on README.md --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7bb59f6b..62f6b8a0 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,15 @@ # Common API Framework (CAPIF) - [Common API Framework (CAPIF)](#common-api-framework-capif) -- [CAPIF\_API\_Services](#capif_api_services) +- [3GPP Common API Framework CAPIF\_API\_Services](#3gpp-common-api-framework-capif_api_services) - [Documentation](#documentation) - [Install and Run](#install-and-run) - [FAQ Documentation](#faq-documentation) -# CAPIF_API_Services -This repository has the python-flask Mockup servers created with openapi-generator related with CAPIF APIS defined here: -[Open API Descriptions of 3GPP 5G APIs] +# 3GPP Common API Framework CAPIF_API_Services +This repository includes all services developed using Python Flask servers, created with openapi-generator with swagger definitions on [Open API Descriptions of 3GPP 5G APIs] for release 18 of Technical Specifications. # Documentation -- GitLab From 13edad80d4e62f78b62d4b265864b893153059e5 Mon Sep 17 00:00:00 2001 From: Jorge Moratinos Salcines Date: Fri, 31 Jan 2025 12:52:38 +0100 Subject: [PATCH 3/3] Changed informatino on README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 62f6b8a0..8043acab 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # Common API Framework (CAPIF) - [Common API Framework (CAPIF)](#common-api-framework-capif) -- [3GPP Common API Framework CAPIF\_API\_Services](#3gpp-common-api-framework-capif_api_services) +- [3GPP Common API Framework OpenCAPIF implementation](#3gpp-common-api-framework-opencapif-implementation) - [Documentation](#documentation) - [Install and Run](#install-and-run) - [FAQ Documentation](#faq-documentation) -# 3GPP Common API Framework CAPIF_API_Services +# 3GPP Common API Framework OpenCAPIF implementation This repository includes all services developed using Python Flask servers, created with openapi-generator with swagger definitions on [Open API Descriptions of 3GPP 5G APIs] for release 18 of Technical Specifications. # Documentation -- GitLab