diff options
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/index.rst | 58 | ||||
| -rw-r--r-- | docs/release-notes.rst | 1 | ||||
| -rw-r--r-- | docs/so-libs.rst | 55 | ||||
| -rw-r--r-- | docs/tox.ini | 6 | ||||
| -rw-r--r-- | pom.xml | 8 |
6 files changed, 70 insertions, 60 deletions
diff --git a/docs/conf.py b/docs/conf.py index 5371015..d211470 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,4 +12,4 @@ intersphinx_mapping = {} html_last_updated_fmt = '%d-%b-%y %H:%M' def setup(app): - app.add_stylesheet("css/ribbon.css") + app.add_css_file("css/ribbon.css") diff --git a/docs/index.rst b/docs/index.rst index af26c59..31fe970 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,55 +1,11 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2018 Huawei Technologies Co., Ltd. +.. SPDX-License-Identifier: CC-BY-4.0 .. _master_index: -ONAP SO/libs Documentation -=========================== - Openstack Java SDK v2.0 used by SO components. +SO Libs +======= -**Ceilometer client**: - Ceilometer client will collect, normalise and transform data produced by OpenStack services. The data it produces is intended to be used to create different views and help solve various telemetry use cases. - -**Glance client**: - Glance client discover, register, and retrieve virtual machine images.it provide RESTful client to query of VM image metadata as well as retrieval of the actual image. - -**Heat client**: - Heat client used for orchestrating the infrastructure resources for a cloud application based on templates in the form of text files that can be treated like code. - -**Keystone client**: - Keystone client provides API client authentication, service discovery, and distributed multi-tenant authorization. - -**Nova client**: - To implement services and associated libraries to provide massively scalable, on demand, self service access to compute resources, including bare metal, virtual machines, and containers. - -**Openstack client** : - Provide a single command-line interface for OpenStack services with a uniform command set and format. - -**Quantum client** : - It provides API for delivering networking-as-a-service (NaaS) in virtual compute environments. +.. toctree:: + :maxdepth: 1 -**Swift client** : - Swift client provides functionalities for object storage in OpenStack. Swift is ideal for storing unstructured data that can grow without bound. - - -Building SO/libs ------------------ - -Build software with unit tests ------------------------------- - -.. code-block:: bash - - cd $HOME/onap/workspace/SO/libs - - $HOME/onap/apache-maven-3.3.9/bin/mvn -s $HOME/onap/.m2/settings.xml clean install - - -Build software without unit tests ----------------------------------- - -.. code-block:: bash - - cd $HOME/onap/workspace/SO/libs - - $HOME/onap/apache-maven-3.3.9/bin/mvn -s $HOME/onap/.m2/settings.xml -DskipTests -Dmaven.test.skip=true clean install + release-notes.rst + so-libs.rst diff --git a/docs/release-notes.rst b/docs/release-notes.rst index a91c33e..61170c7 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -3,7 +3,6 @@ .. Copyright 2017 Huawei Intellectual Property. All rights reserved. .. _release_notes: - SO Release Notes ================ diff --git a/docs/so-libs.rst b/docs/so-libs.rst new file mode 100644 index 0000000..f8d5691 --- /dev/null +++ b/docs/so-libs.rst @@ -0,0 +1,55 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2018 Huawei Technologies Co., Ltd. +.. _so_libs: + +ONAP SO/libs Documentation +=========================== + Openstack Java SDK v2.0 used by SO components. + +**Ceilometer client**: + Ceilometer client will collect, normalise and transform data produced by OpenStack services. The data it produces is intended to be used to create different views and help solve various telemetry use cases. + +**Glance client**: + Glance client discover, register, and retrieve virtual machine images.it provide RESTful client to query of VM image metadata as well as retrieval of the actual image. + +**Heat client**: + Heat client used for orchestrating the infrastructure resources for a cloud application based on templates in the form of text files that can be treated like code. + +**Keystone client**: + Keystone client provides API client authentication, service discovery, and distributed multi-tenant authorization. + +**Nova client**: + To implement services and associated libraries to provide massively scalable, on demand, self service access to compute resources, including bare metal, virtual machines, and containers. + +**Openstack client** : + Provide a single command-line interface for OpenStack services with a uniform command set and format. + +**Quantum client** : + It provides API for delivering networking-as-a-service (NaaS) in virtual compute environments. + +**Swift client** : + Swift client provides functionalities for object storage in OpenStack. Swift is ideal for storing unstructured data that can grow without bound. + + +Building SO/libs +----------------- + +Build software with unit tests +------------------------------ + +.. code-block:: bash + + cd $HOME/onap/workspace/SO/libs + + $HOME/onap/apache-maven-3.3.9/bin/mvn -s $HOME/onap/.m2/settings.xml clean install + + +Build software without unit tests +---------------------------------- + +.. code-block:: bash + + cd $HOME/onap/workspace/SO/libs + + $HOME/onap/apache-maven-3.3.9/bin/mvn -s $HOME/onap/.m2/settings.xml -DskipTests -Dmaven.test.skip=true clean install diff --git a/docs/tox.ini b/docs/tox.ini index edac8c3..dd702eb 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -4,10 +4,10 @@ envlist = docs, skipsdist = true [testenv:docs] -basepython = python3 +basepython = python3.8 deps = -r{toxinidir}/requirements-docs.txt commands = - sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html + sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html echo "Generated docs available in {toxinidir}/_build/html" whitelist_externals = echo @@ -18,5 +18,5 @@ whitelist_externals = basepython = python3 #deps = -r{toxinidir}/requirements-docs.txt commands = echo "Link Checking not enforced" -#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck +#commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck whitelist_externals = echo @@ -6,7 +6,7 @@ <parent> <groupId>org.onap.oparent</groupId> <artifactId>oparent</artifactId> - <version>3.0.0</version> + <version>3.3.3</version> <relativePath /> </parent> @@ -213,17 +213,17 @@ <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> - <version>2.11.1</version> + <version>2.13.3</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-core</artifactId> - <version>2.11.1</version> + <version>2.13.3</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-annotations</artifactId> - <version>2.11.1</version> + <version>2.13.3</version> </dependency> <dependency> <groupId>javax.xml.bind</groupId> |