Commit 03321988 authored by Julien Satti's avatar Julien Satti
Browse files

Small tweaks

parent 999f02d8
Loading
Loading
Loading
Loading
Loading
+18 −15
Original line number Diff line number Diff line
# How to Run

- [Downloading the project](#downloading-the-project)
  - [1. Create a folder to download the project](#1-create-a-folder-to-download-the-project)
  - [2. Download the deployment script](#2-download-the-deployment-script)
  - [3. Run the deployment script](#3-run-the-deployment-script)
- [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)
- [Start Your Testing with OpenCAPIF](#start-your-testing-with-opencapif)

Capif services are developed under [services folder](https://labs.etsi.org/rep/ocf/capif/-/tree/main/services).
1. [Downloading the project](#downloading-the-project) 
    1. [Create a folder to download the project](#1-create-a-folder-to-download-the-project)
    2. [Download the deployment script](#2-download-the-deployment-script)
    3. [Run the deployment script](#3-run-the-deployment-script)
2. Run the services
    * [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)
3. [Start your testing with OpenCAPIF](#start-your-testing-with-opencapif)

> Capif services are developed under [services folder](https://labs.etsi.org/rep/ocf/capif/-/tree/main/services).

### Downloading the project

@@ -55,7 +56,6 @@ We recommend:
sudo ./deploy.sh staging
```


> **We recommend running the deploy.sh script with root permissions! In other case, some directories may not be accessible by the project building tools and hinder the smooth installation.**

### Run All CAPIF Services locally with Docker images
@@ -98,7 +98,8 @@ 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 the help using
NOTE: You can use different flags if you only want to stop some of them, please check the help using:

```
./clean_capif_docker_services.sh -h

@@ -114,6 +115,7 @@ Usage: clean_capif_docker_services.sh <options>
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 when running the script.
@@ -126,7 +128,8 @@ Usage: ./show_logs.sh <options>
       -f : Follow log output
       -h : Show this help
```
You can also use option -f in order to follow log output in real time

> You can also use option -f in order to follow log output in real time

### 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.
@@ -143,7 +146,7 @@ After they have been built, the different panels can be consulted in Grafana at
http://localhost:3000
```

By default, the monitoring option is set to false. Once up, all data sources and dashboards are automatically provisioned.
> By default, the monitoring option is set to false. Once up, all data sources and dashboards are automatically provisioned.

### Run each service using Docker

+2 −2
Original line number Diff line number Diff line
@@ -82,6 +82,6 @@ nav:
      - Test Plan: ./testing/testplan/README.md
      - Robot Framework: ./testing/robotframework/README.md
      - Postman: ./testing/postman/README.md
  - Contributing:
      - Documentation: ./contribute/documenting.md
  - Contribute:
      - Documenting: ./contribute/documenting.md
  - FAQ: ./FAQ.md