From: Martin Skorupski Date: Mon, 26 May 2025 11:58:07 +0000 (+0000) Subject: Create oam/oam-controller repository X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=bc086d69609fe9d9e2f7f362f7413ea8dfc6d1a9;p=oam%2Foam-controller.git Create oam/oam-controller repository - create an init folder structure - which includes docs generation IssueID: OAM-457 Change-Id: Idcf856f9ad1da07cbd867d99a6272662655d9455 Signed-off-by: Martin Skorupski --- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d789c1e --- /dev/null +++ b/.gitignore @@ -0,0 +1,91 @@ +############################################################################## +# +# Copyright 2024 highstreet technologies USA Corp. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +pom.xml.next +dependency-reduced-pom.xml +buildNumber.properties +.mvn/timing.properties +*.pyc +append_to_etc_hosts.txt + +*/**/bin/ + +# Maven +target/ +*.tar.gz + +# Opendaylight yang-tools +yang-gen-sal/ + +# IDE (Eclipse, vsCode) related +.project +.classpath +.settings/ +target-ide/ +release.properties +.vscode +archive + +# python +__pycache__ +.pylintrc +output +.oam +.venv +venv + +# Avoid ignoring Maven wrapper jar file (.jar files are usually ignored) +!/.mvn/wrapper/maven-wrapper.jar + +# VES related +*/**/json/examples +*/**/__pycache__ +*.log + +# avoid copyright issues with 3GPP +*/**/3gpp/**/*.yaml + +# node js +node_modules +package-lock.json + +# wireshark +.cache + +# ODLUX cache +*/**/O D L UX* + +# nodered +*.backup + +# container-analyis +*.sbom.spdx.json +*.vulnerabilities.vex.json + +# jenkins +*/**/apps/jenkins/* + +# wireshark +*/**/apps/wireshark/* + +# documentation +.tox +docs/_build/ +ci-management/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..9bde2ca --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,17 @@ +--- +version: 2 + +formats: + - htmlzip + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +python: + install: + - requirements: docs/requirements-docs.txt + +sphinx: + configuration: docs/conf.py diff --git a/LICENSES b/LICENSES new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/LICENSES @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..327600b --- /dev/null +++ b/Makefile @@ -0,0 +1,89 @@ +# Copyright 2025 highstreet technologies USA Corp. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# ------------------------------------------------------------------------- +# Variables +# ------------------------------------------------------------------------- +ACTIVATE = . .venv/bin/activate + +# ------------------------------------------------------------------------- +# Phony targets +# ------------------------------------------------------------------------- +.PHONY: system-check docs hello help + +# ------------------------------------------------------------------------- +# [Install & Setup] +# ------------------------------------------------------------------------- + +install: install-pip system-check ## [Install] Install necessary tools + +venv: ## [Install] Set up Python virtual environment + @echo "## Creating Python virtual environment..." + python3 -m venv .venv + +install-pip: ## [Install] Install Python dependencies + @echo "## Installing Python dependencies..." + $(ACTIVATE) && pip install -r requirements.txt + +docs: ## [Docs] Shows the docker status + @echo "Gererate READ_THE_DOCS output" + tox -e docs,docs-linkcheck + + +# ------------------------------------------------------------------------- +# [System] +# ------------------------------------------------------------------------- + +docker-status: ## [System] Shows the docker status + @docker ps -a --format "table {{.Names}}\t{{.Image}}\t{{.Status}}" + +system-check: hello ## [System] System overview + @echo "## System Overview:" + @df -hT + @free -h + @grep -c ^processor /proc/cpuinfo + @cat /etc/os-release | grep -i pretty + @docker version + @docker compose version + @git --version + @python3 --version + @go version + @timedatectl + @echo "Host: ${HOSTNAME}" + +# ------------------------------------------------------------------------- +# [Help] +# ------------------------------------------------------------------------- + +TEXT_FILE := banner.txt +hello: ## [Help] Displays a banner + @echo "Reading lines from $(TEXT_FILE):" + @while IFS= read -r line; do \ + echo "$$line"; \ + done < $(TEXT_FILE) + +help: hello ## [Help] Show this help + @echo "" + @echo "Available Make targets:" + @awk 'BEGIN {FS = ":.*?## "}; /^[a-zA-Z_-]+:.*?## / { \ + split($$2, parts, "] "); \ + group = substr(parts[1], 2); \ + desc = parts[2]; \ + if (group != last_group) { \ + printf "\n\033[1m[%s]\033[0m\n", group; \ + last_group = group; \ + } \ + printf " \033[36m%-25s\033[0m %s\n", $$1, desc \ + }' $(MAKEFILE_LIST) + @echo "" diff --git a/README.md b/README.md new file mode 100644 index 0000000..5600f17 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# Operation and Maintenance (OAM) Controller + +This repository contains code artifctes related to an OAM Controller, which +terminats the O-RAN Alliance Interfaces O1 and OpenFronthaul Management Plane. + +## Get stated + +Update your ubuntu 24.04 system and clone the OAM Controller repository. + +```bash +sudo apt update +sudo apt upgrade -y +sudo apt install make +sudo apt install apache2-utils +mkdir -p ~/workspace && cd ~/workspace + +## Get an overview of the system +git clone "https://gerrit.o-ran-sc.org/r/oam/oam-controller" && (cd "oam-controller" && mkdir -p `git rev-parse --git-dir`/hooks/ && curl -Lo `git rev-parse --git-dir`/hooks/commit-msg https://gerrit.o-ran-sc.org/r/tools/hooks/commit-msg && chmod +x `git rev-parse --git-dir`/hooks/commit-msg) +cd oam-controller +make system-check +make install +source .venv/bin/activate +``` + +## Build + +// to be updated + +## Deploy + +// to be updated + +## Documentation + +The project documentation link is: +https://docs.o-ran-sc.org/projects/o-ran-sc-oam/en/latest/index.html?highlight=Operation%20and%20mainetance + +To generate the documentation the project must be cloned and the following +command must be executed: +``` +make docs +``` + +## License + +This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details. diff --git a/banner.txt b/banner.txt new file mode 100644 index 0000000..00e7cf6 --- /dev/null +++ b/banner.txt @@ -0,0 +1,7 @@ + + ________ _____ _____ _________ __ .__ .__ + \_____ \ / _ \ / \ \_ ___ \ ____ _____/ |________ ____ | | | | ___________ + / | \ / /_\ \ / \ / \ / \ \/ / _ \ / \ __\_ __ \/ _ \| | | | _/ __ \_ __ \ + / | \/ | \/ Y \ \ \___( <_> ) | \ | | | \( <_> ) |_| |_\ ___/| | \/ + \_______ /\____|__ /\____|__ / \______ /\____/|___| /__| |__| \____/|____/____/\___ >__| + \/ \/ \/ \/ \/ \/ diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 100644 index 0000000..c3b6ce5 Binary files /dev/null and b/docs/_static/logo.png differ diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..48b0c30 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,7 @@ +from docs_conf.conf import * +linkcheck_ignore = [ + 'http://localhost.*', + 'http://127.0.0.1.*', + 'https://gerrit.o-ran-sc.org.*', + 'https://sdnc-web:8453' +] \ No newline at end of file diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..62b79fd --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: oran +project: oam \ No newline at end of file diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000..00b0fd0 Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..fcdfe70 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2025 highstreet technologies USA Corp. + +Operation and Maintenance (OAM) Controller +========================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + release-notes.rst + +* :ref:`search` diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..d05c483 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,18 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2025 highstreet technologies USA Corp. + + +OAM-Controller: Release Notes +======================================= + +This document provides the release notes for O-RAN-SC M-Release of the Operation and Maintenance (OAM) project. + +M-Release, 2025-12-28 +--------------------- + ++-----------------------------------------------------------------+------------------------------------------------------------+ +| Issue | Summary | ++=================================================================+============================================================+ +| `OAM-457 `__ | Create oam/oam-cotroller repository. | ++-----------------------------------------------------------------+------------------------------------------------------------+ diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 0000000..e59958e --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,27 @@ +# Copyright 2025 highstreet technologies USA Corp. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +tox +Sphinx +doc8 +docutils < 0.17 +setuptools +six +sphinx_rtd_theme +sphinxcontrib-needs +sphinxcontrib-swaggerdoc +sphinx_bootstrap_theme +sphinxcontrib-redoc +lfdocs-conf +urllib3~=1.26.15 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..6ef8f6d --- /dev/null +++ b/requirements.txt @@ -0,0 +1,15 @@ +# Copyright 2025 highstreet technologies USA Corp. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +tox \ No newline at end of file diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..22f612e --- /dev/null +++ b/tox.ini @@ -0,0 +1,21 @@ +# documentation only +[tox] +minversion = 2.0 +envlist = + docs, + docs-linkcheck, +skipsdist = true + +[testenv:docs] +basepython = python3 +deps = -r{toxinidir}/docs/requirements-docs.txt + +commands = + sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +allowlist_externals = echo + +[testenv:docs-linkcheck] +basepython = python3 +deps = -r{toxinidir}/docs/requirements-docs.txt +commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck \ No newline at end of file