capifcore/README.md

   1 <!--
   2  -
   3    ========================LICENSE_START=================================
   4    O-RAN-SC
   5    %%
   6    Copyright (C) 2022: Nordix Foundation
   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 CAPIF Core implementation
  24
  25 This product is a Go implementation of the CAPIF Core function, 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.
  26
  27 The, almost, complete data model for CAPIF is shown in the diagram below.
  28
  29 <img src="docs/diagrams/Information model for CAPIF.svg">
  30
  31 The data used within CAPIF Core for registering rApps that both provides and consumes services is shown in the diagram below.
  32
  33 <img src="docs/diagrams/Information in rApp registration.svg">
  34
  35 Some examples of interactions between components using the CAPIF interface are shown in the sequence diagram below.
  36
  37 ***NOTE!*** It has not been decided that CAPIF Core will actually do the Helm chart installation. This is just provided in the prototype as an example of what CAPIF Core could do.
  38
  39 <img src="docs/diagrams/Register Provider.svg">
  40
  41 If Helm is used, before publishing a service, the chart that belongs to the service must be registered in ChartMuseum. When publishing the service the following information should be provided in the `ServiceAPIDescription::description` attribute; "namespace", "repoName", "chartName", "releaseName". An example of the information: "Description of rApp helloWorld,namespace,repoName,chartName,releaseName".
  42
  43 ## Generation of API code
  44
  45 The CAPIF APIs are generated from the OpenAPI specifications provided by 3GPP. The `generate.sh` script downloads the
  46 specifications from 3GPP, fixes them and then generates the APIs. It also generates the mocks needed for unit testing.
  47 The specifications are downloaded from the following site; https://www.3gpp.org/ftp/Specs/archive/29_series. To see
  48 the APIs in swagger format, see the following link; https://github.com/jdegre/5GC_APIs/tree/Rel-16#common-api-framework-capif.
  49 **NOTE!** The documentation in this link is for release 16 of CAPIF, the downloaded specifications are for release 17.
  50
  51 To fix the specifications there are three tools:
  52 - `commoncollector`, collects type definitions from peripheral specifications to keep down the number of dependencies to
  53   other specifications. The types to collect are listed in the `definitions.txt`file. Some fixes are hard coded.
  54 - `enumfixer`, fixes enumeration definitions so they can be properly generated.
  55 - `specificationfixer`, fixes flaws in the specifications so they can be properly generated. All fixes are hard coded.
  56
  57 ### Steps to add a new dependency to the commoncollector
  58
  59 When a dependency to a new specification is introduced in any of the CAPIF specifications, see example below, the following steps should be performed:
  60
  61 For the CAPIF specification "TS29222_CAPIF_Discover_Service_API" a new dependency like the following has been introduced.
  62
  63     websockNotifConfig:
  64         $ref: ✅TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig✅'
  65
  66 1. Copy the part between the checkboxes of the reference and add it to the `definitions.txt` file. This step is not needed if the type is already defined in the file.
  67 2. Look in the `generate.sh` script, between the "<replacements_start>" and "<new_replacement>" tags, to see if "TS29122_CommonData"
  68    has already been replaced in "TS29222_CAPIF_Discover_Service_API".
  69 3. If it has not been replaced, add a replacement above the "<new_replacement>" tag by copying and adapting the two rows above the tag.
  70
  71 ### Security in CAPIF
  72
  73 Security requirements that are applicable to all CAPIF entities includes provide authorization mechanism for service APIs from the 3rd party API providers and support a common security mechanism for all API implementations to provide confidentiality and integrity protection.
  74
  75 In the current implementation Keycloak is being used as identity and access management (IAM) solution that provides authentication, authorization, and user management for applications and services. Keycloak provides robust authentication mechanisms, including username/password, two-factor authentication, and client certificate authentication that complies with CAPIF security requirements.
  76
  77 A docker-compose file is included to start up keycloak.
  78
  79 ## Build and test
  80
  81 To generate mocks manually, run the following command:
  82
  83     go generate ./...
  84
  85 **NOTE!** The `helmmanagement` package contains two mocks from the `helm.sh/helm/v3` product. If they need to be
  86 regenerated, their interfaces must be copied into the `helm.go` file and a generation annotation added before running
  87 the generation script.
  88
  89 To build the application, run the following command:
  90
  91     go build
  92
  93 To run the unit tests for the application, run the following command:
  94
  95     go test ./...
  96
  97 The application can also be built as a Docker image, by using the following command:
  98
  99     docker build . -t capifcore
 100
 101 ## Run
 102
 103 To run the Core Function from the command line, run the following commands from this folder. For the parameter `chartMuseumUrl`, if it is not provided CAPIF Core will not do any Helm integration, i.e. try to start any Halm chart when publishing a service.
 104
 105     ./capifcore [-port <port (default 8090)>] [-secPort <Secure port (default 4433)>] [-chartMuseumUrl <URL to ChartMuseum>] [-repoName <Helm repo name (default capifcore)>] [-loglevel <log level (default Info)>] [-certPath <Path to certificate>] [-keyPath <Path to private key>]
 106
 107 Use docker compose file to start CAPIF core together with Keycloak:
 108
 109     docker-compose up
 110
 111 **NOTE!** There is a configuration file in configs/keycloak.yaml with information related to keycloak host, when running locally the host value must be set to localhost (Eg. host: "localhost") and when using docker-compose set value of host to keycloak (Eg. host:"keycloak")
 112
 113 Before using CAPIF API invoker management, an invoker realm must be created in keycloak. Make sure it is created before running CAPIF core. After creating the realm in keycloak, set the name in the keycloak.yaml configuration file.
 114
 115 To run CAPIF Core as a K8s pod together with ChartMuseum, start and stop scripts are provided. The pod configurations are provided in the `configs` folder. CAPIF Core is then available on port `31570`.