README.md

   1 # Subscription Manager
   2
   3 ## Subscription Manager User guide
   4
   5   Subscription manager User guide is available here: https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-submgr/en/latest/user-guide.html
   6   The document source is under the submgr/doc directory. Web document is generated automatically from that after the change has been merged
   7   in the ORAN Gerrit repo.
   8
   9 ## ORAN E2 interface specifications
  10
  11   WG3: The Near-Real-Time RIC and E2 Interface Workgroup
  12   https://www.o-ran.org/specifications
  13
  14 ## Compiling Subscription Manager code
  15
  16 ### Just to compile Docker image give this command
  17
  18   docker build -t submgr:tag .
  19
  20   The command will build the docker image with name 'submgr:tag'. It will run also all the unit tests before image is created.
  21   Unit tests may fail randomly. There are some cases which may fail due to incorrect timing. in test case. If error happens just
  22   issue the same command to recompile. Tag value can be anything or it can be omitted.
  23
  24 ### Compiling code to run unit tests give this command
  25
  26   docker build -t submgr . > build.txt
  27
  28   The command will build the docker image with name 'submgr:latest'. It will run also all the unit tests before image is created.
  29   Compilation and test cases logs are stores in build.txt. Unit tests may fail randomly. There are some cases which may fail due
  30   to incorrect timing in test case. If error happens just issue the same command to recompile.
  31
  32 ## Subscription Manager ORAN Helm chart
  33
  34   Subscription Manager ORAN Helm chart is stored here: https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/ric-dep.
  35
  36 ## How to generate E2AP ASN.1 C-codes
  37
  38   E2AP ASN.1 C-codes has been generated using fork of ASN1C tool. The tool is stored here: https://github.com/nokia/asn1c.
  39
  40   Latest version of the tool should be used. Follow Build and Install instructions for the tool on the page.
  41
  42   Generated ASN1 C-codes are stored in submgr/3rdparty/E2AP-v02.00.00 directory. Directory is name based in the specification version.
  43
  44   Note that any E2AP specifications are not allowed to store in ORAN Gerrit repo! Only generated C-code from the specification can
  45   be stored there.
  46
  47   Example: Update current E2AP-v02.00.00 version to E2AP-v02.00.01 version.
  48
  49   Create following directory structure:
  50
  51     E2AP-v02.00.01
  52      |
  53      - spec
  54         |
  55         - e2ap-v02.00.01.asn
  56
  57   e2ap-v02.00.01.asn file contains the E2AP v02.00.01 specification's data structures in ASN1 format.
  58
  59   To generate the ASN.1 C-codes give following command in E2AP-v02.00.01 dir:
  60   asn1c -pdu=auto -fincludes-quoted -fcompound-names -fno-include-deps -gen-PER -no-gen-OER -no-gen-example spec/e2ap-v02.00.01.asn
  61
  62   Copy E2AP-v02.00.01 directory with the generated C-codes under submgr/3rdparty directory.
  63
  64   Remove spec directory under E2AP-v02.00.01 directory.
  65
  66   Remove old submgr/3rdparty/E2AP-v02.00.00 directory.
  67
  68 ## License
  69
  70   This project is licensed under the Apache License, Version 2.0 - see the LICENSES.txt