servicemanager/README.md

   1 <!--
   2 -
   3 ========================LICENSE_START=================================
   4 O-RAN-SC
   5 %%
   6 Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved.
   7 %%
   8 Licensed under the Apache License, Version 2.0 (the "License");
   9 you may not use this file except in compliance with the License.
  10 You may obtain a copy of the License at
  11
  12      http://www.apache.org/licenses/LICENSE-2.0
  13
  14 Unless required by applicable law or agreed to in writing, software
  15 distributed under the License is distributed on an "AS IS" BASIS,
  16 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17 See the License for the specific language governing permissions and
  18 limitations under the License.
  19 ========================LICENSE_END===================================
  20
  21 -->
  22
  23 # O-RAN-SC Non-RealTime RIC Service Management and Exposure
  24
  25 This product is a Go implementation of a service that calls the CAPIF Core function. When publishing a service we create a Kong route and Kong service, https://konghq.com/. The InterfaceDescription that we return is updated to point to the Kong Data Plane. Therefore, the API interface that we return from Service Discovery has the Kong host and port, and not the original service's host and port. This allows the rApp's API call to be re-directed through Kong.
  26
  27 ## O-RAN-SC Non-RealTime RIC CAPIF Core Implementation
  28
  29 This product is a Go implementation of the CAPIF Core function, which is based on the 3GPP "29.222 Common API Framework for 3GPP Northbound APIs (CAPIF)" interfaces, see https://portal.3gpp.org/desktopmodules/Specifications/SpecificationDetails.aspx?specificationId=3450.
  30
  31 See [CAPIF Core](../capifcore/README.md)
  32
  33 ## Generation of API Code
  34
  35 The CAPIF APIs are generated from the OpenAPI specifications provided by 3GPP. The `generate.sh` script downloads the
  36 specifications from 3GPP, fixes them and then generates the APIs. While these files are checked into the repo, they can be re-generated using `generate.sh`.
  37
  38 ```sh
  39 ./generate.sh
  40 ```
  41
  42 The specifications are downloaded from the following site; https://www.3gpp.org/ftp/Specs/archive/29_series. To see
  43 the APIs in swagger format, see the following link; https://github.com/jdegre/5GC_APIs/tree/Rel-17#common-api-framework-capif.
  44
  45 To fix the specifications there are three tools.
  46 - `commoncollector`, collects type definitions from peripheral specifications to keep down the number of dependencies to
  47   other specifications. The types to collect are listed in the `definitions.txt` file. Some fixes are hard-coded.
  48 - `enumfixer`, fixes enumeration definitions so they can be properly generated.
  49 - `specificationfixer`, fixes flaws in the specifications so they can be properly generated. All fixes are hard-coded.
  50
  51 ## Set Up
  52
  53 First, we need to run `generate.sh` as described above to generate our API code from the 3GPP spec.
  54
  55 Before we can test or run Service Manager, we need to configure a .env file with the required parameters. Please see the template .env.example in the servicemanager directory.
  56
  57 You can set the environmental variable SERVICE_MANAGER_ENV to specify the .env file. For example, the following command specifies to use the config file
  58 .env.development. If this flag is not set, first we try .env.development and then .env.
  59
  60 ```sh
  61 export SERVICE_MANAGER_ENV=development
  62 ```
  63
  64 ### CAPIFcore and Kong
  65
  66 We also need Kong and CAPIFcore to be running. Please see the examples in the `deploy` folder. You can also use https://gerrit.o-ran-sc.org/r/it/dep for deployment. Please see the notes at https://wiki.o-ran-sc.org/display/RICNR/%5BWIP%5D+Service+Manager.
  67
  68 ## Build
  69
  70 After generating the API code, we can build the application with the following command.
  71
  72 ```sh
  73 go build
  74 ```
  75
  76 ## Unit Tests
  77
  78 To run the unit tests for the application, first ensure that the .env file is configured. In the following example, we specify `.env.test`.
  79
  80 ```sh
  81 export SERVICE_MANAGER_ENV=test
  82 go test ./...
  83 ```
  84
  85 ## Run Locally
  86
  87 To run as a local app, first ensure that the .env file is configured. In the following example, we specify `.env.development`.
  88
  89 ```sh
  90 export SERVICE_MANAGER_ENV=development
  91 ./servicemanager
  92 ```
  93
  94 Service Manager is then available on the port configured in .env.
  95
  96 ## Building the Docker Image
  97
  98 The application can also be built as a Docker image, by using the following command. We build the image without a .env file. This is supplied by volume mounting at container run-time. Because we need to include CAPIFcore in the Docker build context, we build from the git repo's root directory, sme.
  99
 100 ```sh
 101 docker build -t servicemanager -f servicemanager/Dockerfile .
 102 ```
 103
 104 ## Kongclearup
 105
 106 Please note that a special executable has been provided for deleting Kong routes and services that have been created by Service Manager in Kong. This executable is called `kongclearup` and is found in the working directory of the Service Manger Docker image, at `/app/servicemanager`. When we create a Kong route or service, we add Kong tags with information as follows.
 107   * apfId
 108   * aefId
 109   * apiId
 110   * apiVersion
 111   * resourceName
 112
 113 When we delete Kong routes and services using `kongclearup`, we check for the existance of these tags, specifically, apfId, apiId and aefId. Only if these tags exist and have values do we proceed to delete the Kong service or route. The executable `kongclearup` uses the volume-mounted .env file to load the configuration giving the location of Kong. Please refer to `sme/servicemanager/internal/kongclearup.go`.
 114
 115 ## Stand-alone Deployment on Kubernetes
 116
 117 For a stand-alone deployment, please see the `deploy` folder for configurations to deploy to Service Manager to Kubernetes. We need the following steps.
 118  - Deploy a PV for Kong's Postgres database (depends on your Kubernetes cluster, not needed for Minikube)
 119  - Deploy a PVC for Kong's Postgres database
 120  - Deploy Kong with Postgres
 121  - Deploy CAPIFcore
 122  - Deploy Service Manager
 123
 124 We consolidate the above steps into the script `deploy-to-k8s.sh`. To delete the full deployment, you can use `delete-from-k8s.sh`. The deploy folder has the following structure.
 125
 126 - sme/
 127   - servicemanager/
 128     - deploy/
 129       - src/
 130       - manifests/
 131
 132 We store the Kubernetes manifests files in the manifests in the subfolder. We store the shell scripts in the src folder.
 133
 134 In `deploy-to-k8s.sh`, we copy .env.example and use `sed` to replace the template values with values for running the Service Manager container. You will need to update this part of the script with your own values. There is an example sed replacement in function `substitute_manifest()` in `deploy-to-k8s.sh`. Here, you can substitute your own Docker images for CAPIFcore and Service Manager for local development.
 135
 136 In addition there are 2 switches that are added for developer convenience.
 137  * --repo # allows you to specify your own docker repo, e.g. your Docker Hub id
 138  * --env  # allows you to specify an additional env file, and sets SERVICE_MANAGER_ENV in the Docker environment to point to this file.
 139
 140 The additional env file needs to exist in the sme/servicemanager folder so that kongclearup can access is. It is specified by its filename. The relative path ../.. is added in the `deploy-to-k8s.sh` script. For example, to use
 141
 142 `./deploy-to-k8s.sh --env .env.development`
 143
 144  ../../.env.development needs to exist.