...
| near-RT RIC (end of Cherry) | |||
| Criteria | Result / Proof point / Notes | ||
|---|---|---|---|
| Identification | |||
What is the human-readable name of the project? | yes | O-RAN SC's Near-RT RIC RT = realtime RIC = RAN intelligent controller RAN = Radio Access Network O-RAN = Open RAN SC = software community | |
What is a brief description of the project? | yes | The near-RT RIC Platform is a software based near‐real‐time micro‐service‐based platform for hosting micro-service-based applications - the xApps - that run on the near-RT RIC platform. xApps are not part of the RIC platform and developed in projects that are separate from the near-RT RIC platform project. The near-RT RIC platform is providing xApps the infrastructure for controlling a distributed collection of RAN base stations (eNB, gNB, CU, DU) in a region via the O-RAN alliance's E2 protocol ("southbound"). (quote from Scope of the near-RT RIC platform and its components (summary)) | |
What is the URL for the project (as a whole)? | yes | Near Realtime RAN Intelligent Controller (RIC) | |
What is the URL for the version control repository (it may be the same as the project URL)? | yes | Multiple repositories in Linux Foundation Gerrit: https://gerrit.o-ran-sc.org/r/admin/repos/ List of repos: Scope of the near-RT RIC platform and its components (summary) | |
What programming language(s) are used to implement the project? | yes | C++, Golang, Python | |
What is the Common Platform Enumeration (CPE) name for the project (if it has one)? | no ID | ||
Basic project website content | |||
| The project website MUST succinctly describe what the software does (what problem does it solve? | yes | Scope of the near-RT RIC platform and its components (summary)) | |
| The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. | yes | obtain: from gerrit repos or from the OSC releases: Releases bugs: Tools (mailing list, JIRA, Gerrit) enhancements: Same JIRAS tool as for feature planning. contribute: See OSC guidelines: Project Developer Wiki | |
| The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) | yes | contribute: See OSC guidelines: Project Developer Wiki | |
| The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) | no (fix-priority very-low) | not available. | Governance 2021-02-19 Follow standard coding styles for components. Its optional |
FLOSS license | |||
| What license(s) is the project released under? | yes | Apache 2.0 | |
| The software produced by the project MUST be released as FLOSS. | yes | Apache 2.0 | |
| It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI). | yes | ||
| The project MUST post the license(s) of its results in a standard location in their source repository. | yes | root dir of all repos included in the project | |
| Documentation | |||
| The project MUST provide basic documentation for the software produced by the project. | yes | https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-ric-dep/en/latest/ and other documentation under: https://docs.o-ran-sc.org/en/latest/projects.html | |
| The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. | partial (fix-priority medium) | Could be better organized. | Governance 2021-02-17 A page is to be created Introduction and guides & the page will be regularly updated for below:
|
| Other | |||
| The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. | yes | ||
| The project MUST have one or more mechanisms for discussion (including proposed changes and issues) that are searchable, allow messages and topics to be addressed by URL, enable new people to participate in some of the discussions, and do not require client-side installation of proprietary software. | yes | Tools (mailing list, JIRA, Gerrit) | |
| The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. | yes | ||
...
(Result/Proof point (column A: enter Met/Unmet; Column B: enter relevant URLs/comments)
| Project A | |||
| Criteria | Result / Proof point | ||
|---|---|---|---|
Public version-controlled source repository | |||
The project MUST have a version-controlled source repository that is publicly readable and has a URL. | yes | Scope of the near-RT RIC platform and its components (summary) | |
The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. | yes | Scope of the near-RT RIC platform and its components (summary) | |
To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. | yes | Scope of the near-RT RIC platform and its components (summary) | |
It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. | yes | Scope of the near-RT RIC platform and its components (summary) | |
Unique version numbering | |||
The project results MUST have a unique version identifier for each release intended to be used by users | yes | ||
It is SUGGESTED that the Semantic Versioning (SemVer) format be used for releases. | yes | ||
It is SUGGESTED that projects identify each release within their version control system. For example, it is SUGGESTED that those using git identify each release using git tags. | yes | named branches | |
Release notes | |||
The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes). Projects whose results are not intended for reuse in multiple locations (such as the software for a single website or service) AND employ continuous delivery MAY select "N/A". (URL required) | partial (fix-priority low) | by repo, but not all repos have release notes. Good example: https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-lib-rmr/en/latest/rel-notes.html | Governance 2021-02-19 Create a release checklist comprising of this & few other from this page. Did every component update their rst release notes & did PTL summarized those on one wiki page ? |
The release notes MUST identify every publicly known vulnerability with a CVE assignment or similar that is fixed in each new release, unless users typically cannot practically update the software themselves. If there are no release notes or there have been no publicly known vulnerabilities, choose "not applicable" (N/A). | no (fix-priority low) | Governance/Technical 2021-02-19 For own source-code bugs this can be handled manually as part of release checklist (If JIRA based security bug has been created) But for containers we should find a technical solution (automated) involving some tool e.g. docker image scanning tool (LFN provided preferred) | |
Reporting (8 Reporting (8 Points)
(Result/Proof point (column A: enter Met/Unmet; Column B: enter relevant URLs/comments)
| near-RT RIC (end of Cherry) | |||||||
| Criteria | Result / Proof point | ||||||
|---|---|---|---|---|---|---|---|
Bug-reporting process | |||||||
| The project MUST provide a process for users to submit bug reports (e.g., using an issue tracker or a mailing list). (URL required) | yes | Tools (mailing list, JIRA, Gerrit) | |||||
| The project SHOULD use an issue tracker for tracking individual issues. | yes | Tools (mailing list, JIRA, Gerrit) | |||||
| The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. | yes | TODO | |||||
| The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). | yes | TODO | |||||
| The project MUST have a publicly available archive for reports and responses for later searching. (URL required) | no (fix-priority low) | Governance 2021-02-19 Depends on previous two criterion As part of release checklist store the snapshot copy of the reports of previous two criterion into wiki page. | |||||
Vulnerability | Vulnerability report process | ||||||
| The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) | no (fix-priority low) | Governance 2021-02-19 A wiki page is under progress (Thoralf) Jira issues will need to be labelled for security bugs. | |||||
If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. (URL required) Examples include a private defect report submitted on the web using HTTPS (TLS) or an email encrypted using OpenPGP. If vulnerability reports are always public (so there are never private vulnerability reports), choose "not applicable" (N/A). | no (fix-priority low) | Governance 2021-02-19 | |||||
The project's initial response time for any vulnerability report received in the last 6 months MUST be less than or equal to 14 days. If there have been no vulnerabilities reported in the last 6 months, choose "not applicable" (N/A). | no (fix-priority low) | ||||||
...