From: Timo Tietavainen Date: Tue, 12 Nov 2019 11:24:44 +0000 (+0200) Subject: Add documentation files X-Git-Tag: 0.2.2~2 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=7f700f8c16ed2d237ae21fa30159b0b41344eccc;p=ric-plt%2Fdbaas.git Add documentation files Added mandatory documentation files for the RIC Amber release. Updated also docker base image to Alpine 6-a3.9, because older version has been removed from ORAN nexus3 repository. Change-Id: I3c55faf82cf589e339019e2fd70bad4fe40ce195 Signed-off-by: Timo Tietavainen --- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9c14461 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +# documentation +.tox +docs/_build/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..095222a --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,16 @@ +--- +version: 2 + +formats: + - htmlzip + +build: + image: latest + +python: + version: 3.7 + install: + - requirements: docs/requirements-docs.txt + +sphinx: + configuration: docs/conf.py diff --git a/container-tag.yaml b/container-tag.yaml index dfa47f5..5f7431b 100644 --- a/container-tag.yaml +++ b/container-tag.yaml @@ -2,4 +2,4 @@ # This file is expected to be in the docker build directory; # can be moved with suitable JJB configuration. --- -tag: '0.2.1' +tag: '0.2.2' diff --git a/docker/Dockerfile.redis b/docker/Dockerfile.redis index 03abab5..aa77c42 100644 --- a/docker/Dockerfile.redis +++ b/docker/Dockerfile.redis @@ -13,8 +13,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -FROM nexus3.o-ran-sc.org:10004/bldr-alpine3:5-a3.9 as build-env - +FROM nexus3.o-ran-sc.org:10004/bldr-alpine3:6-a3.9-nng as build-env COPY ./redismodule /redismodule WORKDIR /redismodule 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..922e22f --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,6 @@ +from docs_conf.conf import * +linkcheck_ignore = [ + 'http://localhost.*', + 'http://127.0.0.1.*', + 'https://gerrit.o-ran-sc.org.*' +] diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..ffce5da --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: oran +project: ric-plt/dbaas 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..34e2176 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,31 @@ +.. +.. Copyright (c) 2019 AT&T Intellectual Property. +.. Copyright (c) 2019 Nokia. +.. +.. Licensed under the Creative Commons Attribution 4.0 International +.. Public License (the "License"); you may not use this file except +.. in compliance with the License. You may obtain a copy of the License at +.. +.. https://creativecommons.org/licenses/by/4.0/ +.. +.. Unless required by applicable law or agreed to in writing, documentation +.. 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. +.. + +Welcome to O-RAN DBAAS Documentation +==================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + overview.rst + release-notes.rst + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 0000000..2de1e74 --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,28 @@ +.. +.. Copyright (c) 2019 AT&T Intellectual Property. +.. Copyright (c) 2019 Nokia. +.. +.. Licensed under the Creative Commons Attribution 4.0 International +.. Public License (the "License"); you may not use this file except +.. in compliance with the License. You may obtain a copy of the License at +.. +.. https://creativecommons.org/licenses/by/4.0/ +.. +.. Unless required by applicable law or agreed to in writing, documentation +.. 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. +.. + +Overview +======== + +The ric-plt/dbaas repo provides all the needed elements to deploy database as +a service (Dbaas) to kubernetes. Dbaas service is realized with a single +container running Redis database. The database is configured to be +non-persistent and non-redundant. + +For the time being Dbaas only allowed usage is to provide database backend +service for Shared Data Layer (SDL). diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..d77f419 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,53 @@ +.. +.. Copyright (c) 2019 AT&T Intellectual Property. +.. Copyright (c) 2019 Nokia. +.. +.. Licensed under the Creative Commons Attribution 4.0 International +.. Public License (the "License"); you may not use this file except +.. in compliance with the License. You may obtain a copy of the License at +.. +.. https://creativecommons.org/licenses/by/4.0/ +.. +.. Unless required by applicable law or agreed to in writing, documentation +.. 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. +.. + +Release-Notes +============= + +This document provides the release notes for O-RAN SC Amber release of +ric-plt/dbaas. + +.. contents:: + :depth: 3 + :local: + + + +Version history +--------------- + +[0.2.2] - 2019-11-12 + +* Take Alpine (version 6-a3.9) linux base image into use in Redis docker image. +* Add mandatory documentation files. + +[0.2.1] - 2019-09-17 + +* Add the curl tool to docker image to facilitate trouble-shooting. + +[0.2.0] - 2019-09-03 + +* Take Redis 5.0 in use. + +[0.1.0] - 2019-06-17 + +* Initial Implementation to provide all the needed elements to deploy database + as a service docker image to kubernetes. +* Introduce new Redis modules: SETIE, SETNE, DELIE, DELNE, MSETPUB, MSETMPUB, + SETXXPUB, SETNXPUB, SETIEPUB, SETNEPUB, DELPUB, DELMPUB, DELIEPUB, DELNEPUB, + NGET, NDEL. diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 0000000..09a0c1c --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,5 @@ +sphinx +sphinx-rtd-theme +sphinxcontrib-httpdomain +recommonmark +lfdocs-conf diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..c86cfdf --- /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