docs/deployment.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2021-2022 Nordix Foundation
   4 .. Modifications Copyright (C) 2021 Bell Canada.
   5
   6 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   7 .. _deployment:
   8
   9 CPS Deployment
  10 ##############
  11
  12 .. contents::
  13     :depth: 2
  14
  15 CPS OOM Charts
  16 ==============
  17 The CPS kubernetes chart is located in the `OOM repository <https://github.com/onap/oom/tree/master/kubernetes/cps>`_.
  18 This chart includes different cps components referred as <cps-component-name> further in the document are listed below:
  19
  20 .. container:: ulist
  21
  22   - `cps-core <https://github.com/onap/oom/tree/master/kubernetes/cps/components/cps-core>`__
  23   - `cps-temporal <https://github.com/onap/oom/tree/master/kubernetes/cps/components/cps-temporal>`__
  24   - `ncmp-dmi-plugin <https://github.com/onap/oom/tree/master/kubernetes/cps/components/ncmp-dmi-plugin>`__
  25
  26 Please refer to the `OOM documentation <https://docs.onap.org/projects/onap-oom/en/latest/sections/guides/user_guides/oom_user_guide.html>`_ on how to install and deploy ONAP.
  27
  28 Installing or Upgrading CPS Components
  29 ======================================
  30
  31 The assumption is you have cloned the charts from the OOM repository into a local directory.
  32
  33 **Step 1** Go to the cps charts and edit properties in values.yaml files to make any changes to particular cps component if required.
  34
  35 .. code-block:: bash
  36
  37   cd oom/kubernetes/cps/components/<cps-component-name>
  38
  39 **Step 2** Build the charts
  40
  41 .. code-block:: bash
  42
  43   cd oom/kubernetes
  44   make SKIP_LINT=TRUE cps
  45
  46 .. note::
  47    SKIP_LINT is only to reduce the "make" time
  48
  49 **Step 3** Undeploying already deployed cps components
  50
  51 After undeploying cps components, keep monitoring the cps pods until they go away.
  52
  53 .. code-block:: bash
  54
  55   helm del --purge <my-helm-release>-<cps-component-name>
  56   kubectl get pods -n <namespace> | grep <cps-component-name>
  57
  58 **Step 4** Make sure there is no orphan database persistent volume or claim.
  59
  60 First, find if there is an orphan database PV or PVC with the following commands:
  61
  62 .. note::
  63    This step does not apply to ncmp-dmi-plugin.
  64
  65 .. code-block:: bash
  66
  67   kubectl get pvc -n <namespace> | grep <cps-component-name>
  68   kubectl get pv -n <namespace> | grep <cps-component-name>
  69
  70 If there are any orphan resources, delete them with
  71
  72 .. code-block:: bash
  73
  74     kubectl delete pvc <orphan-cps-core-pvc-name>
  75     kubectl delete pv <orphan-cps-core-pv-name>
  76
  77 **Step 5** Delete NFS persisted data for CPS components
  78
  79 Connect to the machine where the file system is persisted and then execute the below command
  80
  81 .. code-block:: bash
  82
  83   rm -fr /dockerdata-nfs/<my-helm-release>/<cps-component-name>
  84
  85 **Step 6** Re-Deploy cps pods
  86
  87 After deploying cps, keep monitoring the cps pods until they come up.
  88
  89 .. code-block:: bash
  90
  91   helm deploy <my-helm-release> local/cps --namespace <namespace>
  92   kubectl get pods -n <namespace> | grep <cps-component-name>
  93
  94 Restarting a faulty component
  95 =============================
  96 Each cps component can be restarted independently by issuing the following command:
  97
  98 .. code-block:: bash
  99
 100     kubectl delete pod <cps-component-pod-name> -n <namespace>
 101
 102 .. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning
 103 .. _cps_common_credentials_retrieval:
 104
 105 Credentials Retrieval
 106 =====================
 107
 108 Application and database credentials are kept in Kubernetes secrets. They are defined as external secrets in the
 109 values.yaml file to be used across different components as :
 110
 111 .. container:: ulist
 112
 113   - `cps-core <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-core/values.yaml>`_
 114   - `cps-temporal <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-temporal/values.yaml>`_
 115   - `ncmp-dmi-plugin <https://github.com/onap/oom/blob/master/kubernetes/cps/components/ncmp-dmi-plugin/values.yaml>`_
 116
 117 Below are the list of secrets for different cps components.
 118
 119 +--------------------------+---------------------------------+---------------------------------------------------+
 120 | Component                | Secret type                     | Secret Name                                       |
 121 +==========================+=================================+===================================================+
 122 | cps-core                 | Database authentication         | <my-helm-release>-cps-core-pg-user-creds          |
 123 +--------------------------+---------------------------------+---------------------------------------------------+
 124 | cps-core                 | Rest API Authentication         | <my-helm-release>-cps-core-app-user-creds         |
 125 +--------------------------+---------------------------------+---------------------------------------------------+
 126 | cps-temporal             | Rest API Authentication         | <my-helm-release>-cps-temporal-app-user-creds     |
 127 +--------------------------+---------------------------------+---------------------------------------------------+
 128 | cps-temporal             | Database authentication         | <my-helm-release>-cps-temporal-pg-user-creds      |
 129 +--------------------------+---------------------------------+---------------------------------------------------+
 130 | ncmp-dmi-plugin          | Rest API Authentication         | <my-helm-release>-cps-dmi-plugin-user-creds       |
 131 +--------------------------+---------------------------------+---------------------------------------------------+
 132 | ncmp-dmi-plugin          | SDNC authentication             | <my-helm-release>-ncmp-dmi-plugin-sdnc-creds      |
 133 +--------------------------+---------------------------------+---------------------------------------------------+
 134
 135 The credential values from these secrets are configured in running container as environment variables. Eg:
 136 `cps core deployment.yaml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-core/templates/deployment.yaml>`_
 137
 138 If no specific passwords are provided to the chart as override values for deployment, then passwords are automatically
 139 generated when deploying the Helm release. Below command can be used to retrieve application property credentials
 140
 141 .. code::
 142
 143   kubectl get secret <my-helm-release>-<secret-name> -n <namespace> -o json | jq '.data | map_values(@base64d)'
 144
 145 .. note::
 146    base64d works only with jq version 1.6 or above.
 147
 148 CPS Core Pods
 149 =============
 150 To get a listing of the cps-core Pods, run the following command:
 151
 152 .. code-block:: bash
 153
 154   kubectl get pods -n <namespace> | grep cps-core
 155
 156   dev-cps-core-ccd4cc956-r98pv                          1/1     Running            0          24h
 157   dev-cps-core-postgres-primary-f7766d46c-s9d5b         1/1     Running            0          24h
 158   dev-cps-core-postgres-replica-84659d68f9-6qnt4        1/1     Running            0          24h
 159
 160 .. note::
 161     The CPS Service will have to be restarted each time a change is made to a configurable property.
 162
 163 Additional CPS-Core Customizations
 164 ==================================
 165
 166 The following table lists some properties that can be specified as Helm chart
 167 values to configure the application to be deployed. This list is not exhaustive.
 168
 169 Any spring supported property can be configured by providing in ``config.additional.<spring-supported-property-name>: value`` Example: config.additional.spring.datasource.hikari.maximumPoolSize: 30
 170
 171 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 172 | Property                              | Description                                                                                             | Default Value                 |
 173 +=======================================+=========================================================================================================+===============================+
 174 | config.appUserName                    | User name used by cps-core service to configure the authentication for REST API it exposes.             | ``cpsuser``                   |
 175 |                                       |                                                                                                         |                               |
 176 |                                       | This is the user name to be used by cps-core REST clients to authenticate themselves.                   |                               |
 177 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 178 | config.appUserPassword                | Password used by cps-core service to configure the authentication for REST API it exposes.              | Not defined                   |
 179 |                                       |                                                                                                         |                               |
 180 |                                       | This is the password to be used by CPS Temporal REST clients to authenticate themselves.                |                               |
 181 |                                       |                                                                                                         |                               |
 182 |                                       | If not defined, the password is generated when deploying the application.                               |                               |
 183 |                                       |                                                                                                         |                               |
 184 |                                       | See also :ref:`cps_common_credentials_retrieval`.                                                       |                               |
 185 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 186 | postgres.config.pgUserName            | Internal user name used by cps-core to connect to its own database.                                     | ``cps``                       |
 187 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 188 | postgres.config.pgUserPassword        | Internal password used by cps-core to connect to its own database.                                      | Not defined                   |
 189 |                                       |                                                                                                         |                               |
 190 |                                       | If not defined, the password is generated when deploying the application.                               |                               |
 191 |                                       |                                                                                                         |                               |
 192 |                                       | See also :ref:`cps_common_credentials_retrieval`.                                                       |                               |
 193 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 194 | postgres.config.pgDatabase            | Database name used by cps-core                                                                          | ``cpsdb``                     |
 195 |                                       |                                                                                                         |                               |
 196 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 197 | logging.level                         | Logging level set in cps-core                                                                           | info                          |
 198 |                                       |                                                                                                         |                               |
 199 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 200 | config.useStrimziKafka                | If targeting a custom kafka cluster, ie useStrimziKafka: false, the config.eventPublisher.spring.kafka  | true                          |
 201 |                                       | values below must be set.                                                                               |                               |
 202 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 203 | config.eventPublisher.                | Kafka hostname and port                                                                                 | ``<kafka-bootstrap>:9092``    |
 204 | spring.kafka.bootstrap-servers        |                                                                                                         |                               |
 205 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 206 | config.eventPublisher.                | Kafka consumer client id                                                                                | ``cps-core``                  |
 207 | spring.kafka.consumer.client-id       |                                                                                                         |                               |
 208 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 209 | config.eventPublisher.                | Kafka security protocol.                                                                                | ``SASL_PLAINTEXT``            |
 210 | spring.kafka.security.protocol        | Some possible values are:                                                                               |                               |
 211 |                                       |                                                                                                         |                               |
 212 |                                       | * ``PLAINTEXT``                                                                                         |                               |
 213 |                                       | * ``SASL_PLAINTEXT``, for authentication                                                                |                               |
 214 |                                       | * ``SASL_SSL``, for authentication and encryption                                                       |                               |
 215 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 216 | config.eventPublisher.                | Kafka security SASL mechanism. Required for SASL_PLAINTEXT and SASL_SSL protocols.                      | Not defined                   |
 217 | spring.kafka.properties.              | Some possible values are:                                                                               |                               |
 218 | sasl.mechanism                        |                                                                                                         |                               |
 219 |                                       | * ``PLAIN``, for PLAINTEXT                                                                              |                               |
 220 |                                       | * ``SCRAM-SHA-512``, for SSL                                                                            |                               |
 221 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 222 | config.eventPublisher.                | Kafka security SASL JAAS configuration. Required for SASL_PLAINTEXT and SASL_SSL protocols.             | Not defined                   |
 223 | spring.kafka.properties.              | Some possible values are:                                                                               |                               |
 224 | sasl.jaas.config                      |                                                                                                         |                               |
 225 |                                       | * ``org.apache.kafka.common.security.plain.PlainLoginModule required username="..." password="...";``,  |                               |
 226 |                                       |   for PLAINTEXT                                                                                         |                               |
 227 |                                       | * ``org.apache.kafka.common.security.scram.ScramLoginModule required username="..." password="...";``,  |                               |
 228 |                                       |   for SSL                                                                                               |                               |
 229 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 230 | config.eventPublisher.                | Kafka security SASL SSL store type. Required for SASL_SSL protocol.                                     | Not defined                   |
 231 | spring.kafka.ssl.trust-store-type     | Some possible values are:                                                                               |                               |
 232 |                                       |                                                                                                         |                               |
 233 |                                       | * ``JKS``                                                                                               |                               |
 234 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 235 | config.eventPublisher.                | Kafka security SASL SSL store file location. Required for SASL_SSL protocol.                            | Not defined                   |
 236 | spring.kafka.ssl.trust-store-location |                                                                                                         |                               |
 237 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 238 | config.eventPublisher.                | Kafka security SASL SSL store password. Required for SASL_SSL protocol.                                 | Not defined                   |
 239 | spring.kafka.ssl.trust-store-password |                                                                                                         |                               |
 240 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 241 | config.eventPublisher.                | Kafka security SASL SSL broker hostname identification verification. Required for SASL_SSL protocol.    | Not defined                   |
 242 | spring.kafka.properties.              | Possible value is:                                                                                      |                               |
 243 | ssl.endpoint.identification.algorithm |                                                                                                         |                               |
 244 |                                       | * ``""``, empty string to disable                                                                       |                               |
 245 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 246 | config.additional.                    | Kafka topic to publish to cps-temporal                                                                  | ``cps.data-updated-events``   |
 247 | notification.data-updated.topic       |                                                                                                         |                               |
 248 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 249 | config.additional.                    | Array of dataspaces to be enabled for publishing events to cps-temporal                                 | []                            |
 250 | notification.data-updated.filters.    | If left blank CPS-Temporal notification will be sent for all dataspaces                                 |                               |
 251 | enabled-dataspaces                    |                                                                                                         |                               |
 252 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 253 | config.additional.                    | If asynchronous messaging, user notifications, and updated event persistence should be enabled          | ``true``                      |
 254 | notification.data-updated.enabled     |                                                                                                         |                               |
 255 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 256 | config.additional.                    | Core pool size in asynchronous execution of notification.                                               | ``2``                         |
 257 | notification.async.executor.          |                                                                                                         |                               |
 258 | core-pool-size                        |                                                                                                         |                               |
 259 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 260 | config.additional.                    | Max pool size in asynchronous execution of notification.                                                | ``1``                         |
 261 | notification.async.executor.          |                                                                                                         |                               |
 262 | max-pool-size                         |                                                                                                         |                               |
 263 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 264 | config.additional.                    | Queue Capacity in asynchronous execution of notification.                                               | ``500``                       |
 265 | notification.async.executor.          |                                                                                                         |                               |
 266 | queue-capacity                        |                                                                                                         |                               |
 267 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 268 | config.additional.                    | If the executor should wait for the tasks to be completed on shutdown                                   | ``true``                      |
 269 | notification.async.executor.          |                                                                                                         |                               |
 270 | wait-for-tasks-to-complete-on-shutdown|                                                                                                         |                               |
 271 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 272 | config.additional.                    | Prefix to be added to the thread name in asynchronous execution of notifications.                       | ``Async-``                    |
 273 | notification.async.executor.          |                                                                                                         |                               |
 274 | thread-name-prefix                    |                                                                                                         |                               |
 275 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 276 | config.additional.                    | Specifies number of database connections between database and application.                              | ``10``                        |
 277 | spring.datasource.hikari.             | This property controls the maximum size that the pool is allowed to reach,                              |                               |
 278 | maximumPoolSize                       | including both idle and in-use connections.                                                             |                               |
 279 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 280
 281 .. _additional-cps-ncmp-customizations:
 282
 283 Additional CPS-NCMP Customizations
 284 ==================================
 285 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 286 | config.dmiPluginUserName              | User name used by cps-core to authenticate themselves for using ncmp-dmi-plugin service.                | ``dmiuser``                   |
 287 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 288 | config.dmiPluginUserPassword          | Internal password used by cps-core to connect to ncmp-dmi-plugin service.                               | Not defined                   |
 289 |                                       |                                                                                                         |                               |
 290 |                                       | If not defined, the password is generated when deploying the application.                               |                               |
 291 |                                       |                                                                                                         |                               |
 292 |                                       | See also :ref:`cps_common_credentials_retrieval`.                                                       |                               |
 293 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 294 | config.ncmp.timers                    | Specifies the delay in milliseconds in which the module sync watch dog will wake again after finishing. | ``30000``                     |
 295 | .advised-modules-sync.sleep-time-ms   |                                                                                                         |                               |
 296 |                                       |                                                                                                         |                               |
 297 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 298 | config.ncmp.timers                    | Specifies the delay in milliseconds in which the retry mechanism watch dog                              |                               |
 299 | .locked-modules-sync.sleep-time-ms    | will wake again after finishing.                                                                        | ``300000``                    |
 300 |                                       |                                                                                                         |                               |
 301 |                                       |                                                                                                         |                               |
 302 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 303 | config.ncmp.timers                    | Specifies the delay in milliseconds in which the data sync watch dog will wake again after finishing.   | ``30000``                     |
 304 | .cm-handle-data-sync.sleep-time-ms    |                                                                                                         |                               |
 305 |                                       |                                                                                                         |                               |
 306 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 307
 308 CPS-Core Docker Installation
 309 ============================
 310
 311 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.
 312 The latest instructions are covered in the `README <https://github.com/onap/cps/blob/master/docker-compose/README.md>`_.
 313
 314 CPS-Core and NCMP Distributed Datastructures
 315 ============================================
 316
 317 CPS-Core and NCMP both internally uses embedded distributed datastructure to replicate the state across various instances for low latency.
 318 These instances require some additional ports to be available. The default range starts from 5701 and based on the number of instances configured they are incremented sequentially.
 319
 320 Below are the list of distributed datastructures that we have.
 321
 322 +--------------+---------------------------------+----------------------------------------------------------+
 323 | Component    | Datastructure name              |                 Use                                      |
 324 +==============+=================================+==========================================================+
 325 | cps-core     | anchorDataCache                 | Used to resolve prefix for the container name.           |
 326 +--------------+---------------------------------+----------------------------------------------------------+
 327 | cps-ncmp     | moduleSyncStartedOnCmHandles    | Watchdog process to register cmHandles.                  |
 328 +--------------+---------------------------------+----------------------------------------------------------+
 329 | cps-ncmp     | dataSyncSemaphores              | Watchdog process to sync data from the nodes.            |
 330 +--------------+---------------------------------+----------------------------------------------------------+
 331 | cps-ncmp     | moduleSyncWorkQueue             | Queue used internally for workers to pick the task.      |
 332 +--------------+---------------------------------+----------------------------------------------------------+
 333 | cps-ncmp     | forwardedSubscriptionEventCache | Keeps track of the LCM Subscription Events.              |
 334 +--------------+---------------------------------+----------------------------------------------------------+
 335 | cps-ncmp     | untrustworthyCmHandlesSet       | Stores untrustworthy cmHandles whose TrustLevel is NONE. |
 336 +--------------+---------------------------------+----------------------------------------------------------+
 337 | cps-ncmp     | trustLevelPerDmiPlugin          | Stores the TrustLevel for the dmi-plugins.               |
 338 +--------------+---------------------------------+----------------------------------------------------------+
 339
 340 Total number of caches : 7