docs/installation/oom.rst

   1 .. This work is licensed under a
   2 .. Creative Commons Attribution 4.0 International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4
   5
   6 Policy OOM Installation
   7 -----------------------
   8
   9 .. contents::
  10     :depth: 2
  11
  12 Policy OOM Charts
  13 *****************
  14 The policy K8S charts are located in the `OOM repository <https://gerrit.onap.org/r/gitweb?p=oom.git;a=tree;f=kubernetes/policy;h=78576c7a0d30cb87054e9776326cdde20986e6e3;hb=refs/heads/master>`_.
  15
  16 Please refer to the OOM documentation on how to install and deploy ONAP.
  17
  18 Policy Pods
  19 ***********
  20 To get a listing of the Policy Pods, run the following command:
  21
  22 .. code-block:: bash
  23
  24   kubectl get pods -n onap | grep dev-policy
  25
  26   dev-policy-59684c7b9c-5gd6r                        2/2     Running            0          8m41s
  27   dev-policy-apex-pdp-0                              1/1     Running            0          8m41s
  28   dev-policy-api-56f55f59c5-nl5cg                    1/1     Running            0          8m41s
  29   dev-policy-distribution-54cc59b8bd-jkg5d           1/1     Running            0          8m41s
  30   dev-policy-mariadb-0                               1/1     Running            0          8m41s
  31   dev-policy-xacml-pdp-765c7d58b5-l6pr7              1/1     Running            0          8m41s
  32
  33 .. note::
  34    To get a listing of the Policy services, run this command:
  35    kubectl get svc -n onap | grep policy
  36
  37 Accessing Policy Containers
  38 ***************************
  39 Accessing the policy docker containers is the same as for any kubernetes container. Here is an example:
  40
  41 .. code-block:: bash
  42
  43   kubectl -n onap exec -it dev-policy-policy-xacml-pdp-584844b8cf-9zptx bash
  44
  45 Installing or Upgrading Policy
  46 ******************************
  47 The assumption is you have cloned the charts from the OOM repository into a local directory.
  48
  49 **Step 1** Go into local copy of OOM charts
  50
  51 From your local copy, edit any of the values.yaml files in the policy tree to make desired changes.
  52
  53 The policy schema will be installed automatically as part of the database configuration using ``db-migrator``.
  54 By default the policy schema is upgraded to the latest version.
  55 For more information on how to change the ``db-migrator`` setup please see: `Using Policy DB Migrator`_.
  56
  57 .. _Using Policy DB Migrator: ../db-migrator/policy-db-migrator.html
  58
  59 **Step 2** Build the charts
  60
  61 .. code-block:: bash
  62
  63   make policy
  64   make SKIP_LINT=TRUE onap
  65
  66 .. note::
  67    SKIP_LINT is only to reduce the "make" time
  68
  69 **Step 3** Undeploy Policy
  70 After undeploying policy, loop on monitoring the policy pods until they go away.
  71
  72 .. code-block:: bash
  73
  74   helm undeploy dev-policy
  75   kubectl get pods -n onap | grep dev-policy
  76
  77
  78 **Step 4** Re-Deploy Policy pods
  79
  80 After deploying policy, loop on monitoring the policy pods until they come up.
  81
  82 .. code-block:: bash
  83
  84   helm deploy dev-policy local/onap --namespace onap
  85   kubectl get pods -n onap | grep dev-policy
  86
  87 .. note::
  88    If you want to purge the existing data and start with a clean install,
  89    please follow these steps after undeploying:
  90
  91    **Step 1** Delete NFS persisted data for Policy
  92
  93    .. code-block:: bash
  94
  95      rm -fr /dockerdata-nfs/dev/policy
  96
  97    **Step 2** Make sure there is no orphan policy database persistent volume or claim.
  98
  99    First, find if there is an orphan database PV or PVC with the following commands:
 100
 101    .. code-block:: bash
 102
 103      kubectl get pvc -n onap | grep policy
 104      kubectl get pv -n onap | grep policy
 105
 106    If there are any orphan resources, delete them with
 107
 108    .. code-block:: bash
 109
 110        kubectl delete pvc <orphan-policy-mariadb-resource>
 111        kubectl delete pv <orphan-policy-mariadb-resource>
 112
 113
 114 Restarting a faulty component
 115 *****************************
 116 Each policy component can be restarted independently by issuing the following command:
 117
 118 .. code-block:: bash
 119
 120     kubectl delete pod <policy-pod> -n onap
 121
 122 Exposing ports
 123 **************
 124 For security reasons, the ports for the policy containers are configured as ClusterIP and thus not exposed. If you find you need those ports in a development environment, then the following will expose them.
 125
 126 .. code-block:: bash
 127
 128   kubectl -n onap expose service policy-api --port=7171 --target-port=6969 --name=api-public --type=NodePort
 129
 130 Overriding certificate stores
 131 *******************************
 132 Policy components package default key and trust stores that support https based communication with other
 133 AAF-enabled ONAP components.  Each store can be overridden at installation.
 134
 135 To override a default keystore, the new certificate store (policy-keystore) file should be placed at the
 136 appropriate helm chart locations below:
 137
 138 * oom/kubernetes/policy/charts/drools/resources/secrets/policy-keystore drools pdp keystore override.
 139 * oom/kubernetes/policy/charts/policy-apex-pdp/resources/config/policy-keystore apex pdp keystore override.
 140 * oom/kubernetes/policy/charts/policy-api/resources/config/policy-keystore api keystore override.
 141 * oom/kubernetes/policy/charts/policy-distribution/resources/config/policy-keystore distribution keystore override.
 142 * oom/kubernetes/policy/charts/policy-pap/resources/config/policy-keystore pap keystore override.
 143 * oom/kubernetes/policy/charts/policy-xacml-pdp/resources/config/policy-keystore xacml pdp keystore override.
 144
 145 In the event that the truststore (policy-truststore) needs to be overriden as well, place it at the appropriate
 146 location below:
 147
 148 * oom/kubernetes/policy/charts/drools/resources/configmaps/policy-truststore drools pdp truststore override.
 149 * oom/kubernetes/policy/charts/policy-apex-pdp/resources/config/policy-truststore apex pdp truststore override.
 150 * oom/kubernetes/policy/charts/policy-api/resources/config/policy-truststore api truststore override.
 151 * oom/kubernetes/policy/charts/policy-distribution/resources/config/policy-truststore distribution truststore override.
 152 * oom/kubernetes/policy/charts/policy-pap/resources/config/policy-truststore pap truststore override.
 153 * oom/kubernetes/policy/charts/policy-xacml-pdp/resources/config/policy-truststore xacml pdp truststore override.
 154
 155 When the keystore passwords are changed, the corresponding component configuration ([1]_) should also change:
 156
 157 * oom/kubernetes/policy/charts/drools/values.yaml
 158 * oom/kubernetes/policy-apex-pdp/resources/config/config.json
 159 * oom/kubernetes/policy-distribution/resources/config/config.json
 160
 161 This procedure is applicable to an installation that requires either AAF or non-AAF derived certificates.
 162 The reader is refered to the AAF documentation when new AAF-compliant keystores are desired:
 163
 164 * `AAF automated configuration and Certificates <https://docs.onap.org/projects/onap-aaf-authz/en/latest/sections/configuration/AAF_4.1_config.html#typical-onap-entity-info-in-aaf>`_.
 165 * `AAF Certificate Management for Dummies <https://wiki.onap.org/display/DW/AAF+Certificate+Management+for+Dummies>`_.
 166 * `Instructional Videos <https://wiki.onap.org/display/DW/Instructional+Videos>`_.
 167
 168 After these changes, follow the procedures in the :ref:`Installing or Upgrading Policy` section to make usage of
 169 the new stores effective.
 170
 171 Additional PDP-D Customizations
 172 *******************************
 173
 174 Credentials and other configuration parameters can be set as values
 175 when deploying the policy (drools) subchart.  Please refer to
 176 `PDP-D Default Values <https://git.onap.org/oom/tree/kubernetes/policy/components/policy-drools-pdp/values.yaml>`_
 177 for the current default values.  It is strongly recommended that sensitive
 178 information is secured appropriately before using in production.
 179
 180 Additional customization can be applied to the PDP-D.  Custom configuration goes under the
 181 "resources" directory of the drools subchart (oom/kubernetes/policy/charts/drools/resources).
 182 This requires rebuilding the policy subchart
 183 (see section :ref:`Installing or Upgrading Policy`).
 184
 185 Configuration is done by adding or modifying configmaps and/or secrets.
 186 Configmaps are placed under "drools/resources/configmaps", and
 187 secrets under "drools/resources/secrets".
 188
 189 Custom configuration supportes these types of files:
 190
 191 * **\*.conf** files to support additional environment configuration.
 192 * **features\*.zip** to add additional custom features.
 193 * **\*.pre.sh** scripts to be executed before starting the PDP-D process.
 194 * **\*.post.sh** scripts to be executed after starting the PDP-D process.
 195 * **policy-keystore** to override the PDP-D policy-keystore.
 196 * **policy-truststore** to override the PDP-D policy-truststore.
 197 * **aaf-cadi.keyfile** to override the PDP-D AAF key.
 198 * **\*.properties** to override or add properties files.
 199 * **\*.xml** to override or add xml configuration files.
 200 * **\*.json** to override json configuration files.
 201 * **\*settings.xml** to override maven repositories configuration .
 202
 203 Examples
 204 ^^^^^^^^
 205
 206 To *disable AAF*, simply override the "aaf.enabled" value when deploying the helm chart
 207 (see the OOM installation instructions mentioned above).
 208
 209 To *override the PDP-D keystore or trustore*, add a suitable replacement(s) under
 210 "drools/resources/secrets".  Modify the drools chart values.yaml with
 211 new credentials, and follow the procedures described at
 212 :ref:`Installing or Upgrading Policy` to redeploy the chart.
 213
 214 To *disable https* for the DMaaP configuration topic, add a copy of
 215 `engine.properties <https://git.onap.org/policy/drools-pdp/tree/policy-management/src/main/server/config/engine.properties>`_
 216 with "dmaap.source.topics.PDPD-CONFIGURATION.https" set to "false", or alternatively
 217 create a ".pre.sh" script (see above) that edits this file before the PDP-D is
 218 started.
 219
 220 To use *noop topics* for standalone testing, add a "noop.pre.sh" script under
 221 oom/kubernetes/policy/charts/drools/resources/configmaps/:
 222
 223 .. code-block:: bash
 224
 225     #!/bin/bash
 226     sed -i "s/^dmaap/noop/g" $POLICY_HOME/config/*.properties
 227
 228
 229 .. rubric:: Footnotes
 230
 231 .. [1] There is a limitation that store passwords are not configurable for policy-api, policy-pap, and policy-xacml-pdp.