X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeployment.rst;h=46160c4f768d5bf75e16fc430b674deb65b1f765;hb=ac6f54fcfd2b07a4804620bd9cfa6de6ce4e1c0c;hp=b1839cbb88dd49be80fd72d5851881e48aa32dd5;hpb=c9b89447ce2eab16206d6fee11fda59a35cb64cf;p=cps.git diff --git a/docs/deployment.rst b/docs/deployment.rst index b1839cbb8..46160c4f7 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -7,13 +7,13 @@ .. _deployment: CPS Deployment -============== +############## .. contents:: :depth: 2 CPS OOM Charts --------------- +============== The CPS kubernetes chart is located in the `OOM repository `_. This chart includes different cps components referred as further in the document are listed below: @@ -26,7 +26,8 @@ This chart includes different cps components referred as fu Please refer to the `OOM documentation `_ on how to install and deploy ONAP. Installing or Upgrading CPS Components --------------------------------------- +====================================== + The assumption is you have cloned the charts from the OOM repository into a local directory. **Step 1** Go to the cps charts and edit properties in values.yaml files to make any changes to particular cps component if required. @@ -91,7 +92,7 @@ After deploying cps, keep monitoring the cps pods until they come up. kubectl get pods -n | grep Restarting a faulty component ------------------------------ +============================= Each cps component can be restarted independently by issuing the following command: .. code-block:: bash @@ -102,7 +103,7 @@ Each cps component can be restarted independently by issuing the following comma .. _cps_common_credentials_retrieval: Credentials Retrieval ---------------------- +===================== Application and database credentials are kept in Kubernetes secrets. They are defined as external secrets in the values.yaml file to be used across different components as : @@ -161,8 +162,9 @@ Additional Cps-Core Customizations ================================== The following table lists some properties that can be specified as Helm chart -values to configure the application to be deployed. This list is not -exhaustive. +values to configure the application to be deployed. This list is not exhaustive. + +Any spring supported property can be configured by providing in ``config.additional.: value`` Example: config.additional.spring.datasource.hikari.maximumPoolSize: 30 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | Property | Description | Default Value | @@ -177,7 +179,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 +187,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 +195,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`` | | | | | @@ -277,6 +279,10 @@ exhaustive. | notification.async.executor. | | | | thread-name-prefix | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ +| config.additional. | Specifies number of database connections between database and application. | ``10`` | +| spring.datasource.hikari. | This property controls the maximum size that the pool is allowed to reach, | | +| maximumPoolSize | including both idle and in-use connections. | | ++---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ CPS-Core Docker Installation ============================