diff options
author | liamfallon <liam.fallon@est.tech> | 2021-10-11 11:57:31 +0100 |
---|---|---|
committer | liamfallon <liam.fallon@est.tech> | 2021-10-12 13:53:44 +0100 |
commit | 40f09542ef0fcbb652a96ac8bd3f691c5a72cc83 (patch) | |
tree | 1360a91aa1e1ee5d8866c32e87d55c6ae1de9296 /docs/installation | |
parent | 196eb6f1bb30ae7820815e3fa1e574da4e3d1554 (diff) |
Fix warnings in PF documentation generation
Geeneration of documents in the Policy Framework issued many warnings,
for example missing links, hanging references, unreferenced pages and
missing swagger, as well as bad formatting for code blocks.
This commit cleans up all the warnings.
Issue-ID: POLICY-3337
Change-Id: I20db6ff76cfb58a603317f5faf20c7479b77c13b
Signed-off-by: liamfallon <liam.fallon@est.tech>
Diffstat (limited to 'docs/installation')
-rw-r--r-- | docs/installation/oom.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/installation/oom.rst b/docs/installation/oom.rst index 8e7c585d..621df5b7 100644 --- a/docs/installation/oom.rst +++ b/docs/installation/oom.rst @@ -42,6 +42,8 @@ Accessing the policy docker containers is the same as for any kubernetes contain kubectl -n onap exec -it dev-policy-policy-xacml-pdp-584844b8cf-9zptx bash +.. _install-upgrade-policy-label: + Installing or Upgrading Policy ****************************** The assumption is you have cloned the charts from the OOM repository into a local directory. @@ -165,7 +167,7 @@ The reader is refered to the AAF documentation when new AAF-compliant keystores * `AAF Certificate Management for Dummies <https://wiki.onap.org/display/DW/AAF+Certificate+Management+for+Dummies>`_. * `Instructional Videos <https://wiki.onap.org/display/DW/Instructional+Videos>`_. -After these changes, follow the procedures in the :ref:`Installing or Upgrading Policy` section to make usage of +After these changes, follow the procedures in the :ref:`install-upgrade-policy-label` section to make usage of the new stores effective. Additional PDP-D Customizations @@ -180,7 +182,7 @@ information is secured appropriately before using in production. Additional customization can be applied to the PDP-D. Custom configuration goes under the "resources" directory of the drools subchart (oom/kubernetes/policy/charts/drools/resources). This requires rebuilding the policy subchart -(see section :ref:`Installing or Upgrading Policy`). +(see section :ref:`install-upgrade-policy-label`). Configuration is done by adding or modifying configmaps and/or secrets. Configmaps are placed under "drools/resources/configmaps", and @@ -209,7 +211,7 @@ To *disable AAF*, simply override the "aaf.enabled" value when deploying the hel To *override the PDP-D keystore or trustore*, add a suitable replacement(s) under "drools/resources/secrets". Modify the drools chart values.yaml with new credentials, and follow the procedures described at -:ref:`Installing or Upgrading Policy` to redeploy the chart. +:ref:`install-upgrade-policy-label` to redeploy the chart. To *disable https* for the DMaaP configuration topic, add a copy of `engine.properties <https://git.onap.org/policy/drools-pdp/tree/policy-management/src/main/server/config/engine.properties>`_ |