diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/apex/APEX-OnapPf-Guide.rst | 88 | ||||
| -rw-r--r-- | docs/design/design.rst | 7 | ||||
| -rw-r--r-- | docs/installation/oom.rst | 41 | ||||
| -rw-r--r-- | docs/pap/response/group-query-pap-resp.json | 10 |
4 files changed, 90 insertions, 56 deletions
diff --git a/docs/apex/APEX-OnapPf-Guide.rst b/docs/apex/APEX-OnapPf-Guide.rst index 24291859..5e75f325 100644 --- a/docs/apex/APEX-OnapPf-Guide.rst +++ b/docs/apex/APEX-OnapPf-Guide.rst @@ -369,45 +369,49 @@ Format of the configuration file (OnapPfConfig.json) explained .. container:: colist arabic - +-----------------------------------+-----------------------------------+ - | **1** | parameters for setting up the | - | | rest server such as host, port | - | | userName and password. | - +-----------------------------------+-----------------------------------+ - | **2** | https flag if enabled will enable | - | | https support by the rest server. | - +-----------------------------------+-----------------------------------+ - | **3** | time interval in which PDP-A | - | | has to send heartbeats to PAP. | - | | Specified in milliseconds. | - +-----------------------------------+-----------------------------------+ - | **4** | Type of the pdp. | - +-----------------------------------+-----------------------------------+ - | **5** | List of policy types supported by | - | | the PDP. | - +-----------------------------------+-----------------------------------+ - | **6** | List of topics' details from | - | | which messages are received. | - +-----------------------------------+-----------------------------------+ - | **7** | Topic name of the source to which | - | | PDP-A listens to for messages | - | | from PAP. | - +-----------------------------------+-----------------------------------+ - | **8** | List of servers for the source | - | | topic. | - +-----------------------------------+-----------------------------------+ - | **9** | The source topic infrastructure. | - | | For e.g. dmaap, noop, ueb | - +-----------------------------------+-----------------------------------+ - | **10** | List of topics' details to which | - | | messages are sent. | - +-----------------------------------+-----------------------------------+ - | **11** | Topic name of the sink to which | - | | PDP-A sends messages. | - +-----------------------------------+-----------------------------------+ - | **12** | List of servers for the sink | - | | topic. | - +-----------------------------------+-----------------------------------+ - | **13** | The sink topic infrastructure. | - | | For e.g. dmaap, noop, ueb | - +-----------------------------------+-----------------------------------+ + +-----------------------------------+-------------------------------------------------+ + | **1** | parameters for setting up the | + | | rest server such as host, port | + | | userName and password. | + +-----------------------------------+-------------------------------------------------+ + | **2** | https flag if enabled will enable | + | | https support by the rest server. | + +-----------------------------------+-------------------------------------------------+ + | **3** | time interval in which PDP-A | + | | has to send heartbeats to PAP. | + | | Specified in milliseconds. | + +-----------------------------------+-------------------------------------------------+ + | **4** | Type of the pdp. | + +-----------------------------------+-------------------------------------------------+ + | **5** | List of policy types supported by | + | | the PDP. A trailing “.*” can be used to | + | | specify multiple policy types; for example, | + | | “onap.policies.controlloop.operational.apex.*” | + | | would match any policy type beginning with | + | | “onap.policies.controlloop.operational.apex.” | + +-----------------------------------+-------------------------------------------------+ + | **6** | List of topics' details from | + | | which messages are received. | + +-----------------------------------+-------------------------------------------------+ + | **7** | Topic name of the source to which | + | | PDP-A listens to for messages | + | | from PAP. | + +-----------------------------------+-------------------------------------------------+ + | **8** | List of servers for the source | + | | topic. | + +-----------------------------------+-------------------------------------------------+ + | **9** | The source topic infrastructure. | + | | For e.g. dmaap, noop, ueb | + +-----------------------------------+-------------------------------------------------+ + | **10** | List of topics' details to which | + | | messages are sent. | + +-----------------------------------+-------------------------------------------------+ + | **11** | Topic name of the sink to which | + | | PDP-A sends messages. | + +-----------------------------------+-------------------------------------------------+ + | **12** | List of servers for the sink | + | | topic. | + +-----------------------------------+-------------------------------------------------+ + | **13** | The sink topic infrastructure. | + | | For e.g. dmaap, noop, ueb | + +-----------------------------------+-------------------------------------------------+ diff --git a/docs/design/design.rst b/docs/design/design.rst index da0c3dc3..84beb9e1 100644 --- a/docs/design/design.rst +++ b/docs/design/design.rst @@ -396,7 +396,10 @@ pdp_subgroups R M N/A A list of PDP subgroups ->pdp_type R M N/A The PDP type of this PDP subgroup, currently xacml, drools, or apex ->supported_policy_types R N/A N/A A list of the policy types supported by the PDPs in this PDP - subgroup + subgroup. A trailing “.*” can be used to specify multiple + policy types; for example, “onap.policies.monitoring.*” + would match any policy type beginning with + “onap.policies.monitoring.” ->policies R M N/A The list of policies running on the PDPs in this PDP subgroup ->->(name) R M N/A The name of a TOSCA policy running in this PDP subgroup ->->policy_type R N/A N/A The TOSCA policy type of the policy @@ -861,7 +864,7 @@ services O List of String One or more services the policy appli resources O List of String The unique ID for the Control Loop geography O List of String The target VNF the actor is executing the recipe on -================= ======= ======== ================================================================== +================= ======= ============== ================================================================== This example below shows the JSON body of an Optimize Decision API call. diff --git a/docs/installation/oom.rst b/docs/installation/oom.rst index 748a37bc..44588df9 100644 --- a/docs/installation/oom.rst +++ b/docs/installation/oom.rst @@ -61,8 +61,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 -Rebuilding and/or modifying the Policy Charts -********************************************* +Installing or Upgrading Policy +****************************** 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 @@ -99,6 +99,12 @@ After deploying policy, loop on monitoring the policy pods until they come up. helm deploy dev-policy local/onap --namespace onap kubectl get pods -n onap +Restarting a faulty component +***************************** +Each policy component can be restarted independently by issuing the following command: + +kubectl delete pod <policy-pod> -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. @@ -107,7 +113,36 @@ 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 -Customizing PDP-D Installations +Overriding certificate stores +******************************* +Each policy component keystore and or truststore can be overriden. The procedure will be applicable +to an installation that requires certificates other than the pre-packaged AAF derived ones +that come with the official ONAP distribution. + +To override a default keystore, the new certificate store (policy-keystore) file should be placed at the +appropriate helm chart locations below: + +* **oom/kubernetes/policy/charts/drools/resources/secrets/policy-keystore** drools pdp keystore override. +* **oom/kubernetes/policy/charts/policy-apex-pdp/resources/config/policy-keystore** apex pdp keystore override. +* **oom/kubernetes/policy/charts/policy-api/resources/config/policy-keystore** api keystore override. +* **oom/kubernetes/policy/charts/policy-distribution/resources/config/policy-keystore** distribution keystore override. +* **oom/kubernetes/policy/charts/policy-pap/resources/config/policy-keystore** pap keystore override. +* **oom/kubernetes/policy/charts/policy-xacml-pdp/resources/config/policy-keystore** xacml pdp keystore override. + +In the event that the truststore (policy-truststore) needs to be overriden as well, place it at the appropriate +location below: + +* **oom/kubernetes/policy/charts/drools/resources/configmaps/policy-truststore** drools pdp truststore override. +* **oom/kubernetes/policy/charts/policy-apex-pdp/resources/config/policy-truststore** apex pdp truststore override. +* **oom/kubernetes/policy/charts/policy-api/resources/config/policy-truststore** api truststore override. +* **oom/kubernetes/policy/charts/policy-distribution/resources/config/policy-truststore** distribution truststore override. +* **oom/kubernetes/policy/charts/policy-pap/resources/config/policy-truststore** pap truststore override. +* **oom/kubernetes/policy/charts/policy-xacml-pdp/resources/config/policy-truststore** xacml pdp truststore override. + +After these changes, follow the procedures in the :ref:`Installing or Upgrading Policy` section to make usage of +the new stores effective. + +Additional PDP-D Customizations ******************************* Credentials and other configuration parameters can be set as values diff --git a/docs/pap/response/group-query-pap-resp.json b/docs/pap/response/group-query-pap-resp.json index eb8b1dbe..cbdf508f 100644 --- a/docs/pap/response/group-query-pap-resp.json +++ b/docs/pap/response/group-query-pap-resp.json @@ -134,15 +134,7 @@ "version": "1.0.0" }, { - "name": "onap.policies.monitoring.cdap.tca.hi.lo.app", - "version": "1.0.0" - }, - { - "name": "onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server", - "version": "1.0.0" - }, - { - "name": "onap.policies.monitoring.docker.sonhandler.app", + "name": "onap.policies.monitoring.*", "version": "1.0.0" }, { |