From 301648c2a948e736d7922293108d6980bd9bf429 Mon Sep 17 00:00:00 2001 From: rajalakshmisv Date: Thu, 16 Dec 2021 16:51:02 +0000 Subject: [PATCH] docs folder change Signed-off-by: rajalakshmisv Change-Id: I9cef1d71dc0d0cfd0e674218507836d942474859 --- README.md | 24 +++++++++++++++++ container-tag.yaml | 3 +++ control/rcE2AP.go | 19 -------------- control/rcE2SmRc.go | 19 -------------- docs/installation-guide.rst | 21 +-------------- docs/overview.rst | 2 +- ...p-ts.yaml => container-release-ric-app-rc.yaml} | 4 +-- tox.ini | 30 ++++++++++++++++++++++ 8 files changed, 61 insertions(+), 61 deletions(-) create mode 100644 container-tag.yaml rename releases/{container-release-ric-app-ts.yaml => container-release-ric-app-rc.yaml} (82%) create mode 100644 tox.ini diff --git a/README.md b/README.md index 091901a..e096edd 100644 --- a/README.md +++ b/README.md @@ -32,3 +32,27 @@ GRPC communication can be tested using the grpccurl command In the current implementation, timer is started after initiating Control Request to E2Node. So timer expiry errors will be seen in logs w.r.t. Control Resp. As control ACK is not handled this error can be ignored +Steps to onboard the xapp + 1)echo '{ "config-file.json_url": "https://gerrit.o-ran-sc.org/r/gitweb?p=ric-app/rc.git;a=blob_plain;f=xapp-descriptor/config.json;hb=HEAD","controls-schema.json_url": "https://gerrit.o-ran-sc.org/r/gitweb?p=ric-app/rc.git;a=blob_plain;f=xapp-descriptor/schema.json;hb=HEAD" }' > onboard.rc.url + +2)Onboard the rc xapp using the below command : + $curl --location --request POST "http://$(hostname):32080/onboard/api/v1/onboard/download" --header 'Content-Type: application/json' --data-binary "@./onboard.rc.url" + + After this command: xapp should be created + Eg: + $curl --location --request POST "http://$(hostname):32080/onboard/api/v1/onboard/download" --header 'Content-Type: application/json' --data-binary "@./onboard.rc.url" + { + "status": "Created" + } + 3)Deploying the xapp: + Eg: + $curl --location --request POST "http://$(hostname):32080/appmgr/ric/v1/xapps" --header 'Content-Type: application/json' --data-raw '{"xappName": "rc"}' + { + "instances":null,"name":"rc","status":"deployed","version":"1.0" + } + + after this step the xapp should be in running state + + ricxapp ricxapp-rc-5ccdcc9f6f-ktq7w 1/1 Running 0 88m + + 4) restart rtMgr so rmr is ready diff --git a/container-tag.yaml b/container-tag.yaml new file mode 100644 index 0000000..bdbbd0c --- /dev/null +++ b/container-tag.yaml @@ -0,0 +1,3 @@ +# provide jenkings CI jos with a tag for containers/images +# --- +# tag: 1.0.0 diff --git a/control/rcE2AP.go b/control/rcE2AP.go index 456b6d0..ee3db21 100644 --- a/control/rcE2AP.go +++ b/control/rcE2AP.go @@ -1,22 +1,3 @@ -/* -================================================================================== - Copyright (c) 2019 AT&T Intellectual Property. - Copyright (c) 2019 Nokia - - 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. -================================================================================== -*/ - package control /* diff --git a/control/rcE2SmRc.go b/control/rcE2SmRc.go index ea1492d..502f017 100644 --- a/control/rcE2SmRc.go +++ b/control/rcE2SmRc.go @@ -1,22 +1,3 @@ -/* -================================================================================== - Copyright (c) 2019 AT&T Intellectual Property. - Copyright (c) 2019 Nokia - - 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. -================================================================================== -*/ - package control /* diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 253c336..d778893 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -13,23 +13,4 @@ Installation Guide Installation ------------ -Steps to onboard the xapp - 1)echo '{ "config-file.json_url": "https://gerrit.o-ran-sc.org/r/gitweb?p=ric-app/rc.git;a=blob_plain;f=xapp-descriptor/config.json;hb=HEAD","controls-schema.json_url": "https://gerrit.o-ran-sc.org/r/gitweb?p=ric-app/rc.git;a=blob_plain;f=xapp-descriptor/schema.json;hb=HEAD" }' > onboard.rc.url - - 2)Onboard the rc xapp using the below command : - curl --location --request POST "http://$(hostname):32080/onboard/api/v1/onboard/download" --header 'Content-Type: application/json' --data-binary "@./onboard.rc.url" - - After this command: xapp should be created - Eg: - curl --location --request POST "http://$(hostname):32080/onboard/api/v1/onboard/download" --header 'Content-Type: application/json' --data-binary "@./onboard.rc.url" - { - "status": "Created" - } - 3)Deploying the xapp: - curl --location --request POST "http://$(hostname):32080/appmgr/ric/v1/xapps" --header 'Content-Type: application/json' --data-raw '{"xappName": "rc"}' - - after this step the xapp should be in running state - - ricxapp ricxapp-rc-5ccdcc9f6f-ktq7w 1/1 Running 0 88m - - 4) restart rtMgr so rmr is ready +Steps to onboard the xapp provided in README diff --git a/docs/overview.rst b/docs/overview.rst index b68e78f..d6da5af 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -3,7 +3,7 @@ .. Copyright (C) 2020 AT&T Intellectual Property rc Control Overview -================== +==================== rc is an Xapp used to send RIC control message to E2 / Ran Node based on the GRPC control request received. rc Xapp acts as a GRPC server.It receives and processes the GRPC control request to construct the RIC Control message. diff --git a/releases/container-release-ric-app-ts.yaml b/releases/container-release-ric-app-rc.yaml similarity index 82% rename from releases/container-release-ric-app-ts.yaml rename to releases/container-release-ric-app-rc.yaml index a20d0e2..32c7f7a 100644 --- a/releases/container-release-ric-app-ts.yaml +++ b/releases/container-release-ric-app-rc.yaml @@ -1,10 +1,10 @@ --- distribution_type: container -container_release_tag: 1.0.1 +container_release_tag: 1.0.0 container_pull_registry: nexus3.o-ran-sc.org:10004 container_push_registry: nexus3.o-ran-sc.org:10002 project: ric-app/rc ref: f291db7f83f61976fb46a65e5496317131d5ae82 containers: - name: ric-app-rc - version: 1.0.1 + version: 1.0.0 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..72742cf --- /dev/null +++ b/tox.ini @@ -0,0 +1,30 @@ +# documentation only +[tox] +minversion = 2.0 +envlist = + docs, + docs-linkcheck, +skipsdist = true + +[testenv:docs] +basepython = python3 +deps = + sphinx + sphinx-rtd-theme + sphinxcontrib-httpdomain + recommonmark + lfdocs-conf + +commands = + sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = echo + +[testenv:docs-linkcheck] +basepython = python3 +deps = sphinx + sphinx-rtd-theme + sphinxcontrib-httpdomain + recommonmark + lfdocs-conf +commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck -- 2.16.6