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 <timo.tietavainen@nokia.com>
--- /dev/null
+# documentation
+.tox
+docs/_build/
--- /dev/null
+---
+version: 2
+
+formats:
+ - htmlzip
+
+build:
+ image: latest
+
+python:
+ version: 3.7
+ install:
+ - requirements: docs/requirements-docs.txt
+
+sphinx:
+ configuration: docs/conf.py
# 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'
# 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
--- /dev/null
+from docs_conf.conf import *
+linkcheck_ignore = [
+ 'http://localhost.*',
+ 'http://127.0.0.1.*',
+ 'https://gerrit.o-ran-sc.org.*'
+]
--- /dev/null
+---
+project_cfg: oran
+project: ric-plt/dbaas
--- /dev/null
+..
+.. 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`
--- /dev/null
+..
+.. 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).
--- /dev/null
+..
+.. 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.
--- /dev/null
+sphinx
+sphinx-rtd-theme
+sphinxcontrib-httpdomain
+recommonmark
+lfdocs-conf
--- /dev/null
+# 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