From 875030c88db766ee65d60f61d1e28e31a23db604 Mon Sep 17 00:00:00 2001 From: brunomilitzer Date: Wed, 1 Jun 2022 16:02:29 +0100 Subject: Documented and Tested API & PAP form Istanbul to Jakarta Issue-ID: POLICY-4221 Issue-ID: POLICY-4222 Change-Id: Icca5521045c24908642ca32362f45dcf32825407 Signed-off-by: brunomilitzer --- .../policy-upgrade/images/01-api-pap-upgrade.png | Bin 0 -> 30754 bytes .../policy-upgrade/images/02-api-pap-upgrade.png | Bin 0 -> 8524 bytes .../policy-upgrade/images/03-api-pap-upgrade.png | Bin 0 -> 35029 bytes .../policy-upgrade/images/04-api-pap-upgrade.png | Bin 0 -> 17130 bytes .../policy-upgrade/images/05-api-pap-upgrade.png | Bin 0 -> 10732 bytes .../policy-upgrade/images/06-api-pap-upgrade.png | Bin 0 -> 10498 bytes .../policy-upgrade/images/07-api-pap-upgrade.png | Bin 0 -> 113698 bytes .../policy-upgrade/images/08-api-pap-upgrade.png | Bin 0 -> 10609 bytes .../policy-upgrade/images/09-api-pap-upgrade.png | Bin 0 -> 74252 bytes .../policy-upgrade/images/10-api-pap-upgrade.png | Bin 0 -> 10832 bytes docs/clamp/acm/policy-upgrade/policy-upgrade.rst | 231 ++++++++++++++++++++- docs/development/devtools/clamp-sdc.rst | 4 +- 12 files changed, 226 insertions(+), 9 deletions(-) create mode 100644 docs/clamp/acm/policy-upgrade/images/01-api-pap-upgrade.png create mode 100644 docs/clamp/acm/policy-upgrade/images/02-api-pap-upgrade.png create mode 100644 docs/clamp/acm/policy-upgrade/images/03-api-pap-upgrade.png create mode 100644 docs/clamp/acm/policy-upgrade/images/04-api-pap-upgrade.png create mode 100644 docs/clamp/acm/policy-upgrade/images/05-api-pap-upgrade.png create mode 100644 docs/clamp/acm/policy-upgrade/images/06-api-pap-upgrade.png create mode 100644 docs/clamp/acm/policy-upgrade/images/07-api-pap-upgrade.png create mode 100644 docs/clamp/acm/policy-upgrade/images/08-api-pap-upgrade.png create mode 100644 docs/clamp/acm/policy-upgrade/images/09-api-pap-upgrade.png create mode 100644 docs/clamp/acm/policy-upgrade/images/10-api-pap-upgrade.png diff --git a/docs/clamp/acm/policy-upgrade/images/01-api-pap-upgrade.png b/docs/clamp/acm/policy-upgrade/images/01-api-pap-upgrade.png new file mode 100644 index 00000000..7c84292a Binary files /dev/null and b/docs/clamp/acm/policy-upgrade/images/01-api-pap-upgrade.png differ diff --git a/docs/clamp/acm/policy-upgrade/images/02-api-pap-upgrade.png b/docs/clamp/acm/policy-upgrade/images/02-api-pap-upgrade.png new file mode 100644 index 00000000..41433c68 Binary files /dev/null and b/docs/clamp/acm/policy-upgrade/images/02-api-pap-upgrade.png differ diff --git a/docs/clamp/acm/policy-upgrade/images/03-api-pap-upgrade.png b/docs/clamp/acm/policy-upgrade/images/03-api-pap-upgrade.png new file mode 100644 index 00000000..79e9582c Binary files /dev/null and b/docs/clamp/acm/policy-upgrade/images/03-api-pap-upgrade.png differ diff --git a/docs/clamp/acm/policy-upgrade/images/04-api-pap-upgrade.png b/docs/clamp/acm/policy-upgrade/images/04-api-pap-upgrade.png new file mode 100644 index 00000000..56811741 Binary files /dev/null and b/docs/clamp/acm/policy-upgrade/images/04-api-pap-upgrade.png differ diff --git a/docs/clamp/acm/policy-upgrade/images/05-api-pap-upgrade.png b/docs/clamp/acm/policy-upgrade/images/05-api-pap-upgrade.png new file mode 100644 index 00000000..54dfd144 Binary files /dev/null and b/docs/clamp/acm/policy-upgrade/images/05-api-pap-upgrade.png differ diff --git a/docs/clamp/acm/policy-upgrade/images/06-api-pap-upgrade.png b/docs/clamp/acm/policy-upgrade/images/06-api-pap-upgrade.png new file mode 100644 index 00000000..21369115 Binary files /dev/null and b/docs/clamp/acm/policy-upgrade/images/06-api-pap-upgrade.png differ diff --git a/docs/clamp/acm/policy-upgrade/images/07-api-pap-upgrade.png b/docs/clamp/acm/policy-upgrade/images/07-api-pap-upgrade.png new file mode 100644 index 00000000..80ad99b2 Binary files /dev/null and b/docs/clamp/acm/policy-upgrade/images/07-api-pap-upgrade.png differ diff --git a/docs/clamp/acm/policy-upgrade/images/08-api-pap-upgrade.png b/docs/clamp/acm/policy-upgrade/images/08-api-pap-upgrade.png new file mode 100644 index 00000000..afdd1f52 Binary files /dev/null and b/docs/clamp/acm/policy-upgrade/images/08-api-pap-upgrade.png differ diff --git a/docs/clamp/acm/policy-upgrade/images/09-api-pap-upgrade.png b/docs/clamp/acm/policy-upgrade/images/09-api-pap-upgrade.png new file mode 100644 index 00000000..23b7dc89 Binary files /dev/null and b/docs/clamp/acm/policy-upgrade/images/09-api-pap-upgrade.png differ diff --git a/docs/clamp/acm/policy-upgrade/images/10-api-pap-upgrade.png b/docs/clamp/acm/policy-upgrade/images/10-api-pap-upgrade.png new file mode 100644 index 00000000..c641bff8 Binary files /dev/null and b/docs/clamp/acm/policy-upgrade/images/10-api-pap-upgrade.png differ diff --git a/docs/clamp/acm/policy-upgrade/policy-upgrade.rst b/docs/clamp/acm/policy-upgrade/policy-upgrade.rst index 481c0c0f..840e3f9f 100644 --- a/docs/clamp/acm/policy-upgrade/policy-upgrade.rst +++ b/docs/clamp/acm/policy-upgrade/policy-upgrade.rst @@ -6,10 +6,13 @@ TOSCA Policy Testing Upgrade ############################ .. contents:: - :depth: 4 + :depth: 3 -1 - Istanbul -============ +Automation Composition +********************** + +Istanbul +++++++++ **Step 1:** Clone Policy Clamp @@ -50,7 +53,7 @@ TOSCA Policy Testing Upgrade **Step 6:** Open up Postman and import the following collections - `Download `_ + `Download Istanbul Postman Collections `_ **Step 7:** Open up the folder Control Loop Istanbul/Commissioning @@ -306,8 +309,8 @@ TOSCA Policy Testing Upgrade **Step 13:** For monitoring endpoints go to Control Loop Istanbul/Monitoring folder -2 - Jakarta -=========== +Jakarta ++++++++ **Step 1:** Clone Policy Clamp @@ -348,7 +351,7 @@ TOSCA Policy Testing Upgrade **Step 6:** Open up Postman and import the following collections - `Download `_ + `Download Jakarta Postman Collections `_ **Step 7:** Open up the folder Automation Composition Jakarta/Commissioning @@ -520,3 +523,217 @@ TOSCA Policy Testing Upgrade **Step 13:** For monitoring endpoints go to Automation Composition Jakarta/Monitoring folder +PAP & API +********* + +Istanbul +++++++++ + +**Step 1:** Clone Policy Docker + +.. code-block:: bash + + git clone "https://gerrit.onap.org/r/policy/docker" + +**Step 2:** Go to the CSIT directory + +.. code-block:: bash + + cd docker/csit + +**Step 3:** Run prepare csit script + +.. code-block:: bash + + ./prepare-csit.sh + +**Step 4:** Modify the compose-grafana.yml file + +remove everything from xacml-pdp downwards to grafana + +add the following in api after the keyword expose + +.. code-block:: bash + + ports: + - "6970:6969" + +add the following in pap after the keyword expose + +.. code-block:: bash + + ports: + - "6971:6969" + +**Step 5:** Run start grafana script + +.. code-block:: bash + + ./start-grafana.sh + +**Step 6:** Once api and pap has started check run the postman script Policy Framework Lifecycle API/Lifecycle Api Healthcheck at port 6970 + +.. image:: images/01-api-pap-upgrade.png + +**Step 7:** Log into mariadb container + +.. code-block:: bash + + docker exec -it mariadb sh + +**Step 8:** Log into mariadb container + +.. code-block:: bash + + docker exec -it mariadb sh + + +**Step 9:** Connect to mariadb + +.. code-block:: bash + + mysql -u policy_user -p + +**Step 10:** Enter mariadb password + +.. image:: images/02-api-pap-upgrade.png + +**password:** policy_user + +**Step 11:** View all schemas + +.. code-block:: bash + + show schemas; + +.. image:: images/03-api-pap-upgrade.png + +**Step 12:** Select policyadmin schema + +.. code-block:: bash + + use policyadmin; + +**Step 13:** View all tables + +.. code-block:: bash + + show tables; + +.. image:: images/04-api-pap-upgrade.png + +**Step 14:** Change schema to migration + +.. code-block:: bash + + use migration; + +**Step 15:** View migration tables + +.. code-block:: bash + + show tables; + +.. image:: images/05-api-pap-upgrade.png + +**Step 16:** Select tables from schema_versions + +.. code-block:: bash + + select * from schema_versions; + +.. image:: images/06-api-pap-upgrade.png + +'*' Notice the version 1000 is the latest + +**Step 17:** Go inside the db-migrator container + +.. code-block:: bash + + docker exec -it policy-db-migrator sh + +**Step 18:** See what environment variables is set on the container + +.. code-block:: bash + + printenv + +**Step 19:** If SQL_HOST, SQL_DB, SQL_USER, SQL_PASSWORD & SCRIPT_DIRECTORY is not set do the following + +.. code-block:: bash + :linenos: + + export SQL_HOST=mariadb + export SQL_DB=policyadmin + export SQL_USER=policy_user + export SQL_PASSWORD=policy_user + export SCRIPT_DIRECTORY=sql + +**Step 20:** To downgrade to Istanbul go to the following directory /opt/app/policy/bin and use the following script + +.. code-block:: bash + + ./prepare_downgrade policyadmin + +**Step 21:** To downgrade to Istanbul go to the following directory /opt/app/policy/bin and use the following script + +.. code-block:: bash + + ./db-migrator -s policyadmin -o downgrade -f 1000 -t 0800 + +**Step 22:** Go back to the mariaddb container + +.. code-block:: bash + + docker exec -it mariadb sh + +**Step 23:** Log back into mariadb + +.. code-block:: bash + + mysql -u policy_user -p + +**Step 24:** See if the downgrade has been successfully + +.. code-block:: bash + :linenos: + + use migration; + select * from policyadmin_schema_changelog; + select * from schema_versions; + +.. image:: images/07-api-pap-upgrade.png + +* + +.. image:: images/08-api-pap-upgrade.png + +* + +.. image:: images/01-api-pap-upgrade.png + +**Step 25:** To upgrade to Jakarta repeat steps 17, 18 & 19 + +**Step 26:** Got to the following directory /opt/app/policy/bin and use the following script + +.. code-block:: bash + + ./prepare_upgrade.sh policyadmin + +**Step 27:** Got to the following directory /opt/app/policy/bin and use the following script + +.. code-block:: bash + + ./db-migrator -s policyadmin -o upgrade -f 0800 -t 0900 + +**Step 28:** Repeat steps 22, 23 & 24 + +.. image:: images/09-api-pap-upgrade.png + +* + +.. image:: images/10-api-pap-upgrade.png + +* + +.. image:: images/01-api-pap-upgrade.png \ No newline at end of file diff --git a/docs/development/devtools/clamp-sdc.rst b/docs/development/devtools/clamp-sdc.rst index d871cc9c..07f030a6 100644 --- a/docs/development/devtools/clamp-sdc.rst +++ b/docs/development/devtools/clamp-sdc.rst @@ -105,7 +105,7 @@ SDC provides a graphical interface for onboarding/designing resources (such as V .. image:: images/sdc_distribute.png - An Automation Composition is created by commissioning a Tosca template with Automation Composition definitions. -This commissioned tosca service template can be further used from Policy-GUI for instantiating the Automation Composition with the state "UNINITIALISED". + This commissioned tosca service template can be further used from Policy-GUI for instantiating the Automation Composition with the state "UNINITIALISED". - Instantiate the commissioned Automation Composition definitions from the Policy Gui under 'Instantiation Management'. @@ -113,5 +113,5 @@ This commissioned tosca service template can be further used from Policy-GUI for - Verification: The automation composition is created with default state "UNINITIALISED" without errors. - .. image:: images/cl-instantiation.png + .. image:: images/ac-instantiation.png -- cgit 1.2.3-korg