diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin-guide.rst | 4 | ||||
| -rwxr-xr-x | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/deployment.rst | 28 | ||||
| -rwxr-xr-x | docs/design.rst | 2 | ||||
| -rw-r--r-- | docs/modeling.rst | 6 |
5 files changed, 23 insertions, 19 deletions
diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst index 7689ee5b6d..206879e6b9 100644 --- a/docs/admin-guide.rst +++ b/docs/admin-guide.rst @@ -40,9 +40,9 @@ Logger configuration is provided as a chart resource : +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | cps-component-service-name | logback.xml location | +================================+=================================================================================================================================+ - | cps-core | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-core/resources/config/logback.xml>`_ | + | cps-core | `logback.xml <https://github.com/onap/oom/blob/istanbul/kubernetes/cps/components/cps-core/resources/config/logback.xml>`_ | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | cps-temporal | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-temporal/resources/config/logback.xml>`_ | + | cps-temporal | `logback.xml <https://github.com/onap/oom/blob/istanbul/kubernetes/cps/components/cps-temporal/resources/config/logback.xml>`_ | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | ncmp-dmi-plugin | Not yet applicable to DMI-Plugin | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ diff --git a/docs/conf.py b/docs/conf.py index 84dac1ea21..87f5cd443e 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,7 +21,7 @@ from docutils.parsers.rst import directives from docs_conf.conf import * #change 'latest' to relevant branch-name once branch has been created -branch = 'latest' +branch = 'istanbul' doc_url = 'https://docs.onap.org/projects' master_doc = 'index' diff --git a/docs/deployment.rst b/docs/deployment.rst index b1839cbb88..30a3729306 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -14,16 +14,16 @@ CPS Deployment CPS OOM Charts -------------- -The CPS kubernetes chart is located in the `OOM repository <https://github.com/onap/oom/tree/master/kubernetes/cps>`_. +The CPS kubernetes chart is located in the `OOM repository <https://github.com/onap/oom/tree/istanbul/kubernetes/cps>`_. This chart includes different cps components referred as <cps-component-name> further in the document are listed below: .. container:: ulist - - `cps-core <https://github.com/onap/oom/tree/master/kubernetes/cps/components/cps-core>`_ - - `cps-temporal <https://github.com/onap/oom/tree/master/kubernetes/cps/components/cps-temporal>`_ - - `ncmp-dmi-plugin <https://github.com/onap/oom/tree/master/kubernetes/cps/components/ncmp-dmi-plugin>`_ + - `cps-core <https://github.com/onap/oom/tree/istanbul/kubernetes/cps/components/cps-core>`_ + - `cps-temporal <https://github.com/onap/oom/tree/istanbul/kubernetes/cps/components/cps-temporal>`_ + - `ncmp-dmi-plugin <https://github.com/onap/oom/tree/istanbul/kubernetes/cps/components/ncmp-dmi-plugin>`_ -Please refer to the `OOM documentation <https://docs.onap.org/projects/onap-oom/en/latest/oom_user_guide.html>`_ on how to install and deploy ONAP. +Please refer to the `OOM documentation <https://docs.onap.org/projects/onap-oom/en/istanbul/oom_user_guide.html>`_ on how to install and deploy ONAP. Installing or Upgrading CPS Components -------------------------------------- @@ -109,9 +109,9 @@ values.yaml file to be used across different components as : .. container:: ulist - - `cps-core <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-core/values.yaml#L18>`_ - - `cps-temporal <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-temporal/values.yaml#L28>`_ - - `ncmp-dmi-plugin <https://github.com/onap/oom/blob/master/kubernetes/cps/components/ncmp-dmi-plugin/values.yaml#L22>`_ + - `cps-core <https://github.com/onap/oom/blob/istanbul/kubernetes/cps/components/cps-core/values.yaml#L18>`_ + - `cps-temporal <https://github.com/onap/oom/blob/istanbul/kubernetes/cps/components/cps-temporal/values.yaml#L28>`_ + - `ncmp-dmi-plugin <https://github.com/onap/oom/blob/istanbul/kubernetes/cps/components/ncmp-dmi-plugin/values.yaml#L22>`_ Below are the list of secrets for different cps components. @@ -132,7 +132,7 @@ Below are the list of secrets for different cps components. +--------------------------+---------------------------------+---------------------------------------------------+ The credential values from these secrets are configured in running container as environment variables. Eg: -`cps core deployment.yaml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-core/templates/deployment.yaml#L46>`_ +`cps core deployment.yaml <https://github.com/onap/oom/blob/istanbul/kubernetes/cps/components/cps-core/templates/deployment.yaml#L46>`_ If no specific passwords are provided to the chart as override values for deployment, then passwords are automatically generated when deploying the Helm release. Below command can be used to retrieve application property credentials @@ -177,7 +177,7 @@ exhaustive. | | | | | | If not defined, the password is generated when deploying the application. | | | | | | -| | See also :ref:`credentials_retrieval`. | | +| | See also :ref:`cps_common_credentials_retrieval`. | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | config.dmiPluginUserName | User name used by cps-core to authenticate themselves for using ncmp-dmi-plugin service. | ``dmiuser`` | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ @@ -185,7 +185,7 @@ exhaustive. | | | | | | If not defined, the password is generated when deploying the application. | | | | | | -| | See also :ref:`credentials_retrieval`. | | +| | See also :ref:`cps_common_credentials_retrieval`. | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | postgres.config.pgUserName | Internal user name used by cps-core to connect to its own database. | ``cps`` | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ @@ -193,7 +193,7 @@ exhaustive. | | | | | | If not defined, the password is generated when deploying the application. | | | | | | -| | See also :ref:`credentials_retrieval`. | | +| | See also :ref:`cps_common_credentials_retrieval`. | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | postgres.config.pgDatabase | Database name used by cps-core | ``cpsdb`` | | | | | @@ -281,5 +281,5 @@ exhaustive. CPS-Core Docker Installation ============================ -CPS-Core can also be installed in a docker environment. Latest `docker-compose <https://github.com/onap/cps/blob/master/docker-compose/docker-compose.yml>`_ is included in the repo to start all the relevant services. -The latest instructions are covered in the `README <https://github.com/onap/cps/blob/master/docker-compose/README.md>`_. +CPS-Core can also be installed in a docker environment. Istanbul `docker-compose <https://github.com/onap/cps/blob/istanbul/docker-compose/docker-compose.yml>`_ is included in the repo to start all the relevant services. +The Istanbul instructions are covered in the `README <https://github.com/onap/cps/blob/istanbul/docker-compose/README.md>`_. diff --git a/docs/design.rst b/docs/design.rst index 02836c5f37..eb5f6b6e07 100755 --- a/docs/design.rst +++ b/docs/design.rst @@ -64,7 +64,7 @@ CPS Core uses API's from the following ONAP components * DMI-Plugin: REST based interface which is used to provide integration and allow the DMI registry API's have access to the corresponding NCMP API's within CPS Core. - More information on the DMI-Plugins offered APIs can be found on the `DMI-Plugin's Design Page <https://docs.onap.org/projects/onap-cps-ncmp-dmi-plugin/en/latest/design.html>`_. + More information on the DMI-Plugins offered APIs can be found on the :ref:`DMI-Plugin's Design Page <onap-cps-ncmp-dmi-plugin:design>`. CPS Path ======== diff --git a/docs/modeling.rst b/docs/modeling.rst index 5504bf322e..b750c6d5b3 100644 --- a/docs/modeling.rst +++ b/docs/modeling.rst @@ -54,7 +54,11 @@ Data Querying -- **CPS Path** is used to query data nodes. The CPS Path is described in detail in :doc:`cps-path`. +- **CPS Path** is used to query data nodes. +.. toctree:: + :maxdepth: 1 + + cps-path.rst .. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning .. _cps_ncmp_modelling: |