Project Readiness for Amber Release

Update

20191107:   Linux Foundation Jenkins CI tutorial: Defining Automated Jenkins Jobs for O-RAN SC Repos

Introduction


PTLs: Please include the following status information for each project

  1. The list of repos that are to be included in Amber release under your project.
  2. For each repo, provide the following information:
    1. License Status:
      1. What license for each repo, Apache 2 or O-RAN?
      2. Whether the LICENSES.txt is included at the root of the repo and whether each code file has a license and copyright claim header?
      3. NOT including any contributing company proprietary information?
    2. Code status:
      1. Is the code available (code MUST be in by code freeze date of 11/04)?
      2. Is the code build-able?
      3. Is the building and artifact generation integrated with LF Jenkins? We can mark this item as "yes" if a particular repo implements a (a) verify, (b) merge and (c) daily release job. The group maintaining a repo needs to implement this. 
    3. Documentation status:
      1. Following the documentation format, structure, and template provided by DOC project?
        1. It is sufficient to generate the release notes bases on docs/release-notes.rst in your repo as per https://lf-o-ran-sc.atlassian.net/wiki/display/DOC/#DocumentationHome-RequiredFiles  ans as per these templates https://lf-o-ran-sc.atlassian.net/wiki/display/DOC/#DocumentationHome-Templates  Other files you may also generate already now if you think this can be done in the remaining Amber timeframe (deadline = Nov-13, 8am ET): docs/installation-guides.rst,  docs/developer-guide.rst , docs/api-docs.rst. The file docs/index.rst is also needed as.  For Amber release the minimum requirement is the release note file. There is no need to publish README.md file from your repo in readthedocs.io . We need to figure out a clever way to maintain it in the root directory (for github& co), but also to correctly trigger the general CI job that generates documentation. You pass this item (2.c.ii) if you can successfully run "tox -e docs,docs-linkcheck" on your repo/subproject and it generates HTML that includes release notes.

      2. Documentation buildable by the DOC project?
        1. Also implement the input for the centralized Jenkins job that pushes the documentation to readthedocs.io (https://readthedocs.org/projects/o-ran-sc-doc/  (scroll down to see "Sub projects" on the right hand side)). Instructions on how to publish them to via thus centralized Jenkins job are here: Configure Repo for Documentation.  (the doc-template directory under the doc repo already contains all the necessary files).
      3. Prepared a video demo for how to build and run your project.

Documentation Home:

https://docs.o-ran-sc.org/en/latest/

Status

(Near Realtime) RICAPP

PTL: Matti Hiltunen

Project

Repos

License and Open Source Status

Code and Building StatusDocumentation

Apache2

or O-RAN

Claims

included

Proprietary

info removed

Code

available

Buildable

LF CI

integrated

Follow

DOC

DOC

buildable

Video

demo 

RICAPPric-app/adminApache 2yesyesyesyesyesyesyesraw video available, needs editing
RICAPPric-app/mcApache 2yesyesyesyesyesyesyesyes
RICAPPric-app/mlApache 2yes

yes


yesyesyesyesyesyes (some editing required)
RICAPPcom/gs-liteApache 2yesyesyesyes

N/A

(library used by MC)

yesyesno
RICAPPric-app/kpimonApache2yesyesyesyesyesyesyesno

(Near Realtime) RIC Platform

PTL: Thoralf Czichy

(A) Project

(B) Repos

(C) License and Open Source Status

(D) Code and Building Status(E) Documentation

(C.1) Apache2

or O-RAN 

(C.2) Claims

included?

(C.3) Proprietary

info removed?

(D.1) Code

available

(D.2) Buildable

(D.3) LF CI

integrated

(E.1) Follow

DOC

(E.2) DOC

buildable

(E.3) Video

demo

RICPcom/logApache2yesyesyesyesyesyesyes

no

RICPcom/gologApache2yesyesyesyesyesyesyesno
RICPcom/pylogApache2yesyesyesyesyesyesyesno
RICPric-plt/a1Apache2yesyesyesyesyesyesyesno
RICPric-plt/appmgrApache2yesyesyesyesyesno - only README in reponono
RICPric-plt/dbaasApache2yesyesyesyesyesYesYesno
RICPric-plt/e2Apache2yesyesyesyesyesyesnono
RICPric-plt/e2mgrApache2Yesyesyesyesyesyesnono
RICPric-plt/lib/rmrApache2yesyesyesyesyesyesyes - standard man pages built into dev package and RTD 'hooks' in docs/no
RICPric-plt/nodeb-rnibApache2yesyesyesyesN/A (Go code)yes (empty)nono
RICPric-plt/rtmgrApache2yesyesyesyesyesYesyesno
RICPric-plt/sdlApache2yesyesyesyesyesYesyesno
RICPric-plt/sdlgoApache2yesyesyesyesyes (verification only as this is a importable go module)YesYesno
RICPric-plt/submgrApache2Licence header missing in two files. Generated ASN1 codes are not under 3dparty directory.yesyesyesyes - includes only build job. No unit test available in the code.Only READMEnono
RICPric-plt/jaegeradapterApache2yesyesyesNothing to build in this repoNo, repo contains only helm chart for testing purposesyesyesno
RICPric-plt/tracelibcppApache2yesyesyesyesyesyesyesno
RICPric-plt/tracelibgoApache2yesyesyesyesyesyesyesno
RICPric-plt/vespamgrApache2yesyesyesyesyesyesyesno
RICPric-plt/xapp-frameApache2yesyesyesyesN/A (Go library)

no
RICPric-plt/asn1-documentsCreative Commons License, Attribution 4.0 Intl.not applicablenot applicablenot applicableno, only documentationno, not neededyes
no
RICPric-plt/streaming-protobufsCreative Commons License, Attribution 4.0 Intl.yesyesyesno, not needed. Definitions to be used by other reposno, planned for release B as a set of "unit tests". There's no CI/CD artifact resulting from this repo.YesYesno
RICPric-plt/resource-status-managerApache2yesyesyesyesyesyesnono























































NONRTRIC

PTL: John Keeney (Ericsson EST)

Project

Repos

License and Open Source Status

Code and Building StatusDocumentation

Apache2

or O-RAN 

Claims

included?

Proprietary

info removed?

Code

available

Buildable

LF CI

integrated

Follow

DOC

DOC

buildable

Video

demo

NONRTRICnonrtricApache 2.0YesNo proprietary informationYesYesYesYesYes

TBC


OAM

PTL: Martin Skorupski

Project

Repos

License and Open Source Status

Code and Building StatusDocumentation

Apache2

or O-RAN 

Claims

included?

Proprietary

info removed?

Code

available

Buildable

LF CI

integrated

Follow

DOC

DOC

buildable

Video

demo

OAMgerrit.o-ran-sc.org/r/q/oamApache  2.0Yes, file LICENSES.txt is in repo root; yes every code file has an appropriate headerNo company proprietary infoYes code is available in LF gerritYes code is buildable

n/a
LF CI integration including docker image creation is part of the ONAP CCSDK/SDNC/SDN-R project.

YesYes

not yet

A demo is scheduled for first week of December including capturing of videos.

OAMgerrit.o-ran-sc.org/r/admin/repos/scp/oam/modelingO-RAN
No company proprietary infon/a for modelingn/a for modelingn/a for modelingn/a for modelingn/a for modelingn/a for modeling
OAM (Portal RIC)Apache  2.0Yes, file LICENSES.txt is in repo root; yes every code file has an appropriate headerNo company proprietary infoYes code is available in LF gerritYes code is buildableYes the continuous integration (build) is performed in LF JenkinsYes documentation follows the format, structure and template of DOC

Yes documentation is included when the DOC project builds


OCU

PTL: Former user (Deleted)

Project

Repos

License and Open Source Status

Code and Building StatusDocumentation

Apache2

or O-RAN 

Claims

included?

Proprietary

info removed?

Code

available

Buildable

LF CI

integrated

Follow

DOC

DOC

buildable

Video

demo

OCUhttps://gerrit.o-ran-sc.org/r/scp/ocu/openlteO-RANYes, file LICENSES.txt is in repo root; every code file has the claimNo company proprietary infoYesYesYes* (sandbox buildable, helpdesk ticket to LF)YesYesno


ODUHIIGH


PTL: Sachin Srivastava

Project

Repos

License and Open Source Status

Code and Building StatusDocumentation

Apache2

or O-RAN 

Claims

included?

Proprietary

info removed?

Code

available

Buildable

LF CI

integrated

Follow

DOC

DOC

buildable

Video

demo

ODUHIGH

https://gerrit.o-ran-sc.org/r/admin/repos/o-du/l2

Apache2

Yes.

LICENSE.txt is included at the root of the repo and each code file has a license and copyright claim header

Yes, company proprietary info is not includedYesYesYesYesRelease notes doc has been placed inside doc folder of the o-du/l2 repo.

ODULOW

PTL: Zhimin Yuan (Deactivated)

Project

Repos

License and Open Source Status

Code and Building StatusDocumentation

Apache2

or O-RAN 

Claims

included?

Proprietary

info removed?

Code

available

Buildable

LF CI

integrated

Follow

DOC

DOC

buildable

Video

demo

ODULOWhttps://gerrit.o-ran-sc.org/r/o-du/phy

Apache2


YesYesYesYesYes  yesyesno

INF

PTL: Xiaohua Zhang

Project

Repos

License and Open Source Status

Code and Building StatusDocumentation

Apache2

or O-RAN 

Claims

included?

Proprietary

info removed?

Code

available

Buildable

LF CI

integrated

Follow

DOC

DOC

buildable

Video

demo

INFhttps://gerrit.o-ran-sc.org/r/admin/repos/pti/rtpApache2YesYesYesYesYes* (waiting for LF merge)YesYesNo

SIM

PTL: Alex Stancu

Project

Repos

License and Open Source Status

Code and Building StatusDocumentation

Apache2

or O-RAN 

Claims

included?

Proprietary

info removed?

Code

available

Buildable

LF CI

integrated

Follow

DOC

DOC

buildable

Video

demo 

SIMsim/o1-interfaceApache2YesNo company proprietary info.YesYesYesYesYes

not yet

A demo is scheduled for first week of December including capturing of videos.

DOC

PTL: Weichen Ni

Project

Repos

License and Open Source Status

Code and Building StatusDocumentation

Apache2

or O-RAN 

Claims

included?

Proprietary

info removed?

Code

available

Buildable

LF CI

integrated

Follow

DOC

DOC

buildable

Video

demo

DOCdocCC 4.0NoNo company proprietary infoN/AN/A
N/AIn progressno

INT

PTL: Former user (Deleted)

Project

Repos

License and Open Source Status

Code and Building StatusDocumentation

Apache2

or O-RAN 

Claims

included?

Proprietary

info removed?

Code

available

Buildable

LF CI

integrated

Follow

DOC

DOC

buildable

Video

demo 

INTit/depApache2YYYYYYY
INTit/testApache2YYYYYYY
INTit/devApache2YYYN/AN/AYYN/A
INTit/otfApache2YYYYYYY