diff options
| author |   lukegleeson <luke.gleeson@est.tech> | 2021-11-01 17:18:01 +0000 |
|---|---|---|
| committer | lukegleeson <luke.gleeson@est.tech> | 2021-11-01 17:30:49 +0000 |
| commit | 4a53ecc329fd8298d883a32601bc687762f874f3 (patch) | |
| tree | e0367a8bc3d6ccee91dc56a187f162bae25d8a25 /docs/deployment.rst | |
| parent | f0a372f802f5856e15ef947bdf48b169fd5cfb69 (diff) | |
Updating links to Istanbul from latest
- Change conf.py latest to istanbul
- Change file blob links to istanbul versions
- Correct linking error in deployment.rst
- Formatted Modeling to have CPS-Path as subpage to remove "CPS-Path not included in toctree" error and to retain CPS-Path in side index
- Link to OOM user guide in deployment is currently broken but will be fixed when OOM create Istanbul branch for documentation
Issue-ID: CPS-721
Signed-off-by: lukegleeson <luke.gleeson@est.tech>
Change-Id: Ia288662af8d3adc7b08a70662fa260114a37040d
Diffstat (limited to 'docs/deployment.rst')
| -rw-r--r-- | docs/deployment.rst | 28 |
1 files changed, 14 insertions, 14 deletions
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>`_. |