From 0c56e114555b17818d2ee03bb680f27df8158ade Mon Sep 17 00:00:00 2001 From: Pamela Dragosh Date: Tue, 2 Jul 2019 15:01:40 -0400 Subject: [PATCH] Add OOM installation notes Missing details Issue-ID: POLICY-1849 Change-Id: Iac1e6e0af4690b55b13a6a19ad56b153b0b66472 Signed-off-by: Pamela Dragosh --- docs/installation/docker.rst | 5 --- docs/installation/oom.rst | 95 +++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 94 insertions(+), 6 deletions(-) diff --git a/docs/installation/docker.rst b/docs/installation/docker.rst index c64a001a..d9ddd1a1 100644 --- a/docs/installation/docker.rst +++ b/docs/installation/docker.rst @@ -105,8 +105,3 @@ In order to run the containers, you can use *docker-compose*. This uses the *doc **You now have a full standalone ONAP Policy framework up and running!** - - - -End of Document - diff --git a/docs/installation/oom.rst b/docs/installation/oom.rst index a22d7b7e..1bdaa240 100644 --- a/docs/installation/oom.rst +++ b/docs/installation/oom.rst @@ -9,8 +9,101 @@ Policy OOM Installation .. contents:: :depth: 2 +Policy OOM Charts +***************** +The policy K8S charts are located in the `OOM repository `_. +Please refer to the OOM documentation on how to install and deploy ONAP. +Policy Pods +*********** +To get a listing of the Policy Pods, run the following command: -End of Document +.. 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" + +Accessing Policy Containers +*************************** +Accessing the policy docker containers is the same as for any kubernetes container. Here is an example: + +.. code-block:: bash + + kubectl -n onap exec -it dev-policy-policy-xacml-pdp-584844b8cf-9zptx bash + +Rebuilding and/or modifying the Policy Charts +********************************************* +The assumption is you have cloned the charts from the OOM repository into a local directory. + +**Step 1** Go into local copy of OOM charts + +From your local copy, edit any of the values.yaml files in the policy tree to make desired changes. + +**Step 2** Build the charts + +.. code-block:: bash + + make policy + make onap + +**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 + +**Step 4** Delete NFS persisted data for Policy +Sudo to root if you logged in using another account such as ubuntu. + +.. code-block:: bash + + rm -fr /dockerdata-nfs/dev-policy + +**Step 5** Re-Deploy Policy pods +After deploying policy, loop on monitoring the policy pods until they come up. + +.. code-block:: bash + + helm deploy dev-policy local/onap --namespace onap + kubectl get pods -n onap + +Exposing ports +************** +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. + +.. code-block:: bash + + kubectl -n onap expose service policy-api --port=7171 --target-port=6969 --name=api-public --type=NodePort -- 2.16.6