1 .. This work is licensed under a
2 .. Creative Commons Attribution 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
6 Policy OOM Installation
7 -----------------------
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>`_.
16 Please refer to the OOM documentation on how to install and deploy ONAP.
20 To get a listing of the Policy Pods, run the following command:
24 kubectl get pods -n onap | grep dev-policy
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
34 To get a listing of the Policy services, run this command:
35 kubectl get svc -n onap | grep policy
37 Accessing Policy Containers
38 ***************************
39 Accessing the policy docker containers is the same as for any kubernetes container. Here is an example:
43 kubectl -n onap exec -it dev-policy-policy-xacml-pdp-584844b8cf-9zptx bash
45 .. _install-upgrade-policy-label:
47 Installing or Upgrading Policy
48 ******************************
49 The assumption is you have cloned the charts from the OOM repository into a local directory.
51 **Step 1** Go into local copy of OOM charts
53 From your local copy, edit any of the values.yaml files in the policy tree to make desired changes.
55 The policy schema will be installed automatically as part of the database configuration using ``db-migrator``.
56 By default the policy schema is upgraded to the latest version.
57 For more information on how to change the ``db-migrator`` setup please see: `Using Policy DB Migrator`_.
59 .. _Using Policy DB Migrator: ../db-migrator/policy-db-migrator.html
61 **Step 2** Build the charts
66 make SKIP_LINT=TRUE onap
69 SKIP_LINT is only to reduce the "make" time
71 **Step 3** Undeploy Policy
72 After undeploying policy, loop on monitoring the policy pods until they go away.
76 helm undeploy dev-policy
77 kubectl get pods -n onap | grep dev-policy
80 **Step 4** Re-Deploy Policy pods
82 After deploying policy, loop on monitoring the policy pods until they come up.
86 helm deploy dev-policy local/onap --namespace onap
87 kubectl get pods -n onap | grep dev-policy
90 If you want to purge the existing data and start with a clean install,
91 please follow these steps after undeploying:
93 **Step 1** Delete NFS persisted data for Policy
97 rm -fr /dockerdata-nfs/dev/policy
99 **Step 2** Make sure there is no orphan policy database persistent volume or claim.
101 First, find if there is an orphan database PV or PVC with the following commands:
105 kubectl get pvc -n onap | grep policy
106 kubectl get pv -n onap | grep policy
108 If there are any orphan resources, delete them with
112 kubectl delete pvc <orphan-policy-mariadb-resource>
113 kubectl delete pv <orphan-policy-mariadb-resource>
116 Restarting a faulty component
117 *****************************
118 Each policy component can be restarted independently by issuing the following command:
122 kubectl delete pod <policy-pod> -n onap
126 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.
130 kubectl -n onap expose service policy-api --port=7171 --target-port=6969 --name=api-public --type=NodePort
132 Overriding certificate stores
133 *******************************
134 Policy components package default key and trust stores that support https based communication with other
135 AAF-enabled ONAP components. Each store can be overridden at installation.
137 To override a default keystore, the new certificate store (policy-keystore) file should be placed at the
138 appropriate helm chart locations below:
140 * oom/kubernetes/policy/charts/drools/resources/secrets/policy-keystore drools pdp keystore override.
141 * oom/kubernetes/policy/charts/policy-apex-pdp/resources/config/policy-keystore apex pdp keystore override.
142 * oom/kubernetes/policy/charts/policy-api/resources/config/policy-keystore api keystore override.
143 * oom/kubernetes/policy/charts/policy-distribution/resources/config/policy-keystore distribution keystore override.
144 * oom/kubernetes/policy/charts/policy-pap/resources/config/policy-keystore pap keystore override.
145 * oom/kubernetes/policy/charts/policy-xacml-pdp/resources/config/policy-keystore xacml pdp keystore override.
147 In the event that the truststore (policy-truststore) needs to be overriden as well, place it at the appropriate
150 * oom/kubernetes/policy/charts/drools/resources/configmaps/policy-truststore drools pdp truststore override.
151 * oom/kubernetes/policy/charts/policy-apex-pdp/resources/config/policy-truststore apex pdp truststore override.
152 * oom/kubernetes/policy/charts/policy-api/resources/config/policy-truststore api truststore override.
153 * oom/kubernetes/policy/charts/policy-distribution/resources/config/policy-truststore distribution truststore override.
154 * oom/kubernetes/policy/charts/policy-pap/resources/config/policy-truststore pap truststore override.
155 * oom/kubernetes/policy/charts/policy-xacml-pdp/resources/config/policy-truststore xacml pdp truststore override.
157 When the keystore passwords are changed, the corresponding component configuration ([1]_) should also change:
159 * oom/kubernetes/policy/charts/drools/values.yaml
160 * oom/kubernetes/policy-apex-pdp/resources/config/config.json
161 * oom/kubernetes/policy-distribution/resources/config/config.json
163 This procedure is applicable to an installation that requires either AAF or non-AAF derived certificates.
164 The reader is refered to the AAF documentation when new AAF-compliant keystores are desired:
166 * `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>`_.
167 * `AAF Certificate Management for Dummies <https://wiki.onap.org/display/DW/AAF+Certificate+Management+for+Dummies>`_.
168 * `Instructional Videos <https://wiki.onap.org/display/DW/Instructional+Videos>`_.
170 After these changes, follow the procedures in the :ref:`install-upgrade-policy-label` section to make usage of
171 the new stores effective.
173 Additional PDP-D Customizations
174 *******************************
176 Credentials and other configuration parameters can be set as values
177 when deploying the policy (drools) subchart. Please refer to
178 `PDP-D Default Values <https://git.onap.org/oom/tree/kubernetes/policy/components/policy-drools-pdp/values.yaml>`_
179 for the current default values. It is strongly recommended that sensitive
180 information is secured appropriately before using in production.
182 Additional customization can be applied to the PDP-D. Custom configuration goes under the
183 "resources" directory of the drools subchart (oom/kubernetes/policy/charts/drools/resources).
184 This requires rebuilding the policy subchart
185 (see section :ref:`install-upgrade-policy-label`).
187 Configuration is done by adding or modifying configmaps and/or secrets.
188 Configmaps are placed under "drools/resources/configmaps", and
189 secrets under "drools/resources/secrets".
191 Custom configuration supportes these types of files:
193 * **\*.conf** files to support additional environment configuration.
194 * **features\*.zip** to add additional custom features.
195 * **\*.pre.sh** scripts to be executed before starting the PDP-D process.
196 * **\*.post.sh** scripts to be executed after starting the PDP-D process.
197 * **policy-keystore** to override the PDP-D policy-keystore.
198 * **policy-truststore** to override the PDP-D policy-truststore.
199 * **aaf-cadi.keyfile** to override the PDP-D AAF key.
200 * **\*.properties** to override or add properties files.
201 * **\*.xml** to override or add xml configuration files.
202 * **\*.json** to override json configuration files.
203 * **\*settings.xml** to override maven repositories configuration .
208 To *disable AAF*, simply override the "aaf.enabled" value when deploying the helm chart
209 (see the OOM installation instructions mentioned above).
211 To *override the PDP-D keystore or trustore*, add a suitable replacement(s) under
212 "drools/resources/secrets". Modify the drools chart values.yaml with
213 new credentials, and follow the procedures described at
214 :ref:`install-upgrade-policy-label` to redeploy the chart.
216 To *disable https* for the DMaaP configuration topic, add a copy of
217 `engine.properties <https://git.onap.org/policy/drools-pdp/tree/policy-management/src/main/server/config/engine.properties>`_
218 with "dmaap.source.topics.PDPD-CONFIGURATION.https" set to "false", or alternatively
219 create a ".pre.sh" script (see above) that edits this file before the PDP-D is
222 To use *noop topics* for standalone testing, add a "noop.pre.sh" script under
223 oom/kubernetes/policy/charts/drools/resources/configmaps/:
228 sed -i "s/^dmaap/noop/g" $POLICY_HOME/config/*.properties
231 .. rubric:: Footnotes
233 .. [1] There is a limitation that store passwords are not configurable for policy-api, policy-pap, and policy-xacml-pdp.