From 833a2096df92eec273dc807cc930aee6e7cbc40e Mon Sep 17 00:00:00 2001 From: Saryu Shah Date: Thu, 3 May 2018 17:50:48 +0000 Subject: Updated policy documentation Updated policy documentation ------------------------------------------------------------- Change-Id: I840d17df857bb14fdc7e96e3c5f984037944c889 Issue-ID: POLICY-536 Signed-off-by: Saryu Shah --- docs/platform/index.rst | 6 +++--- docs/platform/installAmsterController.rst | 8 ++++---- docs/platform/installBeijingController.rst | 24 ++++++++++++------------ docs/release-notes.rst | 1 + 4 files changed, 20 insertions(+), 19 deletions(-) diff --git a/docs/platform/index.rst b/docs/platform/index.rst index 3f58f353e..fe8f4a3b9 100644 --- a/docs/platform/index.rst +++ b/docs/platform/index.rst @@ -9,10 +9,9 @@ Policy Engine Platform architecture.rst offeredapis.rst policygui.rst - deployment.rst -Policy Installation -------------------- +Policy Installation and Deployment +---------------------------------- .. toctree:: :maxdepth: 1 @@ -21,6 +20,7 @@ Policy Installation installationVM.rst installAmsterController.rst installBeijingController.rst + deployment.rst Policy Software Architecture ---------------------------- diff --git a/docs/platform/installAmsterController.rst b/docs/platform/installAmsterController.rst index d294865f9..6ee7e38e7 100644 --- a/docs/platform/installAmsterController.rst +++ b/docs/platform/installAmsterController.rst @@ -264,15 +264,15 @@ We now install the Amsterdam policies for the vCPE, vFirewall, vDNS & VOLTE use bin/create-cl-amsterdam - - Type Y when asked for confirmation of parameters - - Accept /tmp as the install directory - - Type Y to agree to creation of a Maven Artifact + # - Type Y when asked for confirmation of parameters + # - Accept /tmp as the install directory + # - Type Y to agree to creation of a Maven Artifact **Step 6:** Maven artifact creation now proceeds. After some minutes, confirmation is requested for deployment of rules into Maven. .. code-block:: bash - - Type Y to deploy the rules. + # - Type Y to deploy the rules. The rules are deployed into Maven. Expect the rule deployment process to take a number of minutes, perhaps 10 minutes. diff --git a/docs/platform/installBeijingController.rst b/docs/platform/installBeijingController.rst index deb2ebb35..cdda5eb13 100644 --- a/docs/platform/installBeijingController.rst +++ b/docs/platform/installBeijingController.rst @@ -1,8 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -Installation of Beijing Controller and vCPE Policy -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Installation of Beijing Controller and Policies +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. contents:: :depth: 2 @@ -78,10 +78,10 @@ Install the Beijing policy controller vi apps-controlloop-installer - Change the line - "features enable controlloop-amsterdam" - to - "features enable controlloop-beijing" + # Change the line + # "features enable controlloop-amsterdam" + # to + # "features enable controlloop-beijing" **Step 6:** Stop the policy engine @@ -307,15 +307,15 @@ We now install the Beijing policies for the vCPE, vFirewall, vDNS & VOLTE use ca bin/create-cl-beijing - - Type Y when asked for confirmation of parameters - - Accept /tmp as the install directory - - Type Y to agree to creation of a Maven Artifact + # - Type Y when asked for confirmation of parameters + # - Accept /tmp as the install directory + # - Type Y to agree to creation of a Maven Artifact **Step 6:** Maven artifact creation now proceeds. After some minutes, confirmation is requested for deployment of rules into Maven. .. code-block:: bash - - Type Y to deploy the rules. + # - Type Y to deploy the rules. The rules are deployed into Maven. Expect the rule deployment process to take a number of minutes, perhaps 10 minutes. @@ -341,8 +341,8 @@ We now install the Beijing policies for the vCPE, vFirewall, vDNS & VOLTE use ca bin/push-policies-beijing - When the script prompts for the path to the properties file, enter the following: - /opt/app/policy/config/beijing-controller.properties + # When the script prompts for the path to the properties file, enter the following: + # /opt/app/policy/config/beijing-controller.properties **Step 10:** Now verify that the Beijing policies are loaded, there should be four facts (one per use case) in the Drools PDP diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 91ec7697f..284145c98 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -101,6 +101,7 @@ The Beijing release for POLICY delivered the following Epics. For a full list of * POLICY-753 Policy Health Check failed with multi-node cluster * POLICY-763 PDP-D throwing NullPointerException for multiple vDNS and VOLTE messages injected in parallel * POLICY-765 junit test for guard fails intermittently + * POLICY-773 brmsgw failure pushing notification when executing update-vfw-op-policy.sh -- cgit 1.2.3-korg