X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation%2Foom.rst;h=30efdbe76df059686b770af8138c1f54ba2bba7c;hb=688a2dd3a681c28ac48ad737316c2dc1dff08526;hp=9da566828435592cd66a146f2f7e08676b717d2a;hpb=e9bdba81173a5d2f217bf215dc7b81d72683ab72;p=policy%2Fparent.git diff --git a/docs/installation/oom.rst b/docs/installation/oom.rst index 9da56682..30efdbe7 100644 --- a/docs/installation/oom.rst +++ b/docs/installation/oom.rst @@ -21,37 +21,18 @@ To get a listing of the Policy Pods, run the following command: .. code-block:: bash - kubectl get pods | grep policy - - brmsgw ClusterIP 10.43.77.177 9989/TCP 5d15h app=brmsgw,release=dev-policy - drools ClusterIP 10.43.167.154 6969/TCP,9696/TCP 5d15h app=drools,release=dev-policy - nexus ClusterIP 10.43.239.92 8081/TCP 5d15h app=nexus,release=dev-policy - pap NodePort 10.43.207.229 8443:30219/TCP,9091:30218/TCP 5d15h app=pap,release=dev-policy - pdp ClusterIP None 8081/TCP 5d15h app=pdp,release=dev-policy - policy-apex-pdp ClusterIP 10.43.226.0 6969/TCP 5d15h app=policy-apex-pdp,release=dev-policy - policy-api ClusterIP 10.43.102.56 6969/TCP 5d15h app=policy-api,release=dev-policy - policy-distribution ClusterIP 10.43.4.211 6969/TCP 5d15h app=policy-distribution,release=dev-policy - policy-pap ClusterIP 10.43.175.164 6969/TCP 5d15h app=policy-pap,release=dev-policy - policy-xacml-pdp ClusterIP 10.43.181.208 6969/TCP 5d15h app=policy-xacml-pdp,release=dev-policy - policydb ClusterIP 10.43.93.233 3306/TCP 5d15h app=policydb,release=dev-policy - -Some of these pods are shared between the legacy components and the latest framework components, while others are not. - -.. csv-table:: - :header: "Policy Pod", "Latest Framework", "Legacy" - :widths: 15,10,10 - - "brmsgw", "", "yes" - "drools", "yes", "yes" - "nexus", "yes", "yes" - "pap", "", "yes" - "pdp", "", "yes" - "policy-apex-pdp", "yes", "" - "policy-api", "yes", "" - "policy-distribution", "yes", "yes" - "policy-pap", "yes", "" - "policy-xacml-pdp", "yes", "" - "policydb", "yes", "yes" + kubectl get pods -n onap | grep dev-policy + + dev-policy-59684c7b9c-5gd6r 2/2 Running 0 8m41s + dev-policy-apex-pdp-0 1/1 Running 0 8m41s + dev-policy-api-56f55f59c5-nl5cg 1/1 Running 0 8m41s + dev-policy-distribution-54cc59b8bd-jkg5d 1/1 Running 0 8m41s + dev-policy-mariadb-0 1/1 Running 0 8m41s + dev-policy-xacml-pdp-765c7d58b5-l6pr7 1/1 Running 0 8m41s + +.. note:: + To get a listing of the Policy services, run this command: + kubectl get svc -n onap | grep policy Accessing Policy Containers *************************** @@ -61,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. @@ -69,51 +52,65 @@ The assumption is you have cloned the charts from the OOM repository into a loca From your local copy, edit any of the values.yaml files in the policy tree to make desired changes. +The policy schema will be installed automatically as part of the database configuration using ``db-migrator``. +By default the policy schema is upgraded to the latest version. +For more information on how to change the ``db-migrator`` setup please see +:ref:`Using Policy DB Migrator `. + **Step 2** Build the charts .. code-block:: bash make policy - make onap + make SKIP_LINT=TRUE onap + +.. note:: + SKIP_LINT is only to reduce the "make" time **Step 3** Undeploy Policy After undeploying policy, loop on monitoring the policy pods until they go away. .. code-block:: bash - helm del --purge dev-policy - kubectl get pods -n onap + helm undeploy dev-policy + kubectl get pods -n onap | grep dev-policy -**Step 4** Delete NFS persisted data for Policy + +**Step 4** Re-Deploy Policy pods + +After deploying policy, loop on monitoring the policy pods until they come up. .. code-block:: bash - rm -fr /dockerdata-nfs/dev-policy + helm deploy dev-policy local/onap --namespace onap + kubectl get pods -n onap | grep dev-policy -**Step 5** Make sure there is no orphan policy database persistent volume or claim. +.. note:: + If you want to purge the existing data and start with a clean install, + please follow these steps after undeploying: -First, find if there is an orphan database PV or PVC with the following commands: + **Step 1** Delete NFS persisted data for Policy -.. code-block:: bash + .. code-block:: bash - kubectl get pvc -n onap | grep policy - kubectl get pv -n onap | grep policy + rm -fr /dockerdata-nfs/dev/policy -If there are any orphan resources, delete them with + **Step 2** Make sure there is no orphan policy database persistent volume or claim. -.. code-block:: bash + First, find if there is an orphan database PV or PVC with the following commands: - kubectl delete pvc - kubectl delete pv + .. code-block:: bash -**Step 6** Re-Deploy Policy pods + kubectl get pvc -n onap | grep policy + kubectl get pv -n onap | grep policy -After deploying policy, loop on monitoring the policy pods until they come up. + If there are any orphan resources, delete them with -.. code-block:: bash + .. code-block:: bash + + kubectl delete pvc + kubectl delete pv - helm deploy dev-policy local/onap --namespace onap - kubectl get pods -n onap Restarting a faulty component ***************************** @@ -132,7 +129,7 @@ For security reasons, the ports for the policy containers are configured as Clus kubectl -n onap expose service policy-api --port=7171 --target-port=6969 --name=api-public --type=NodePort Overriding certificate stores -******************************* +***************************** Policy components package default key and trust stores that support https based communication with other AAF-enabled ONAP components. Each store can be overridden at installation. @@ -165,11 +162,11 @@ When the keystore passwords are changed, the corresponding component configurati This procedure is applicable to an installation that requires either AAF or non-AAF derived certificates. The reader is refered to the AAF documentation when new AAF-compliant keystores are desired: -* `AAF automated configuration and Certificates `_. +* `AAF automated configuration and Certificates `_. * `AAF Certificate Management for Dummies `_. * `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 @@ -177,14 +174,14 @@ Additional PDP-D Customizations Credentials and other configuration parameters can be set as values when deploying the policy (drools) subchart. Please refer to -`PDP-D Default Values `_ +`PDP-D Default Values `_ for the current default values. It is strongly recommended that sensitive 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 @@ -213,7 +210,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 `_