From c580fa4be394aef387c37841dcd6a089064d7d58 Mon Sep 17 00:00:00 2001 From: "saul.gill" Date: Thu, 6 Apr 2023 09:14:11 +0100 Subject: Removed policy upgrade from acm docs Removed policy upgrade page and images from acm docs Page was in the wrong place and had outdated info Issue-ID: POLICY-4614 Change-Id: Ifbaecfec2732dd2129bdcc9cbd1602cc1d50dbb6 Signed-off-by: saul.gill --- docs/clamp/acm/policy-upgrade/policy-upgrade.rst | 739 ----------------------- 1 file changed, 739 deletions(-) delete mode 100644 docs/clamp/acm/policy-upgrade/policy-upgrade.rst (limited to 'docs/clamp/acm/policy-upgrade/policy-upgrade.rst') diff --git a/docs/clamp/acm/policy-upgrade/policy-upgrade.rst b/docs/clamp/acm/policy-upgrade/policy-upgrade.rst deleted file mode 100644 index eb9b5038..00000000 --- a/docs/clamp/acm/policy-upgrade/policy-upgrade.rst +++ /dev/null @@ -1,739 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. _clamp-policy-upgrade-label: - -TOSCA Policy Testing Upgrade -############################ - -.. contents:: - :depth: 3 - -Automation Composition -********************** - -Istanbul -++++++++ - - -**Step 1:** Clone Policy Clamp - -.. code-block:: bash - - git clone "https://gerrit.onap.org/r/policy/clamp" - -**Step 2:** Change Master Branch to Istanbul - -.. code-block:: bash - - git checkout -b origin/istanbul - -**Step 3:** Run Maven Clean Install - -.. code-block:: bash - - mvn clean install - -**Step 3:** Create the Database by going to /clamp/runtime/extra/bin-for-dev - -.. code-block:: bash - - ./start-db.sh test - -**Step 4:** Start Clamp Runtime by going to /clamp/runtime/extra/bin-for-dev - -.. code-block:: bash - - ./start-backend.sh - -**Step 5:** Start Control Loop Runtime by going to /clamp/runtime-controlloop - -.. code-block:: bash - - java -jar target/policy-clamp-runtime-controlloop-6.1.5-SNAPSHOT - -**Step 6:** Open up Postman and import the following collections - - `Download Istanbul Postman Collections `_ - -**Step 7:** Open up the folder Control Loop Istanbul/Commissioning - - Select POST Commission Tosca Service Template and run it. - - *- Should receive the following result* - -.. code-block:: json - :linenos: - - { - "errorDetails": null, - "affectedInstanceProperties": [ - { - "name": "PMSH_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.PMSH_MonitoringPolicyControlLoopElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.sample.GenericK8s_ControlLoopDefinition", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.database.PMSH_K8SMicroserviceControlLoopElement_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.database.Local_K8SMicroserviceControlLoopElement_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.policy.controlloop.PolicyControlLoopParticipant", - "version": "2.3.1" - }, - { - "name": "org.onap.controlloop.HttpControlLoopParticipant", - "version": "2.3.4" - }, - { - "name": "org.onap.domain.database.Http_PMSHMicroserviceControlLoopElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.PMSH_OperationalPolicyControlLoopElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.database.Local_K8SMicroserviceControlLoopElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.PMSH_MonitoringPolicyControlLoopElement_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.DerivedPolicyControlLoopElement_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.k8s.controlloop.K8SControlLoopParticipant", - "version": "2.3.4" - }, - { - "name": "org.onap.domain.pmsh.DerivedDerivedPolicyControlLoopElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.PMSH_OperationalPolicyControlLoopElement_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.sample.GenericK8s_ControlLoopDefinition_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.policy.controlloop.PolicyControlLoopParticipant_Instance1", - "version": "2.3.1" - }, - { - "name": "org.onap.k8s.controlloop.K8SControlLoopParticipant_Instance1", - "version": "2.3.4" - }, - { - "name": "org.onap.controlloop.HttpControlLoopParticipant_Instance1", - "version": "2.3.4" - }, - { - "name": "org.onap.domain.pmsh.DerivedDerivedPolicyControlLoopElement_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.database.Http_PMSHMicroserviceControlLoopElement_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.database.PMSH_K8SMicroserviceControlLoopElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.DerivedPolicyControlLoopElement", - "version": "1.2.3" - } - ] - } - -**Step 8:** To try out other endpoints try out the other postman collections inside commission folder - -**Step 9:** To decommission the Tosca Service Template Select DELETE Tosca Service Template - - *- Should receive the following result* - -.. code-block:: json - :linenos: - - { - "errorDetails": null, - "affectedControlLoopDefinitions": [ - { - "name": "ToscaServiceTemplateSimple", - "version": "1.0.0" - } - ] - } - -**Step 10:** For Instance Properties select the following folder in postman Control Loop Istanbul/Instantiation - - Select POST Instance Properties - - *- Should receive the following result* - -.. code-block:: json - :linenos: - - { - "errorDetails": null, - "affectedInstanceProperties": [ - { - "name": "PMSH_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.PMSH_MonitoringPolicyControlLoopElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.sample.GenericK8s_ControlLoopDefinition", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.database.PMSH_K8SMicroserviceControlLoopElement_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.database.Local_K8SMicroserviceControlLoopElement_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.policy.controlloop.PolicyControlLoopParticipant", - "version": "2.3.1" - }, - { - "name": "org.onap.controlloop.HttpControlLoopParticipant", - "version": "2.3.4" - }, - { - "name": "org.onap.domain.database.Http_PMSHMicroserviceControlLoopElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.PMSH_OperationalPolicyControlLoopElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.database.Local_K8SMicroserviceControlLoopElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.PMSH_MonitoringPolicyControlLoopElement_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.DerivedPolicyControlLoopElement_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.k8s.controlloop.K8SControlLoopParticipant", - "version": "2.3.4" - }, - { - "name": "org.onap.domain.pmsh.DerivedDerivedPolicyControlLoopElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.PMSH_OperationalPolicyControlLoopElement_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.sample.GenericK8s_ControlLoopDefinition_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.policy.controlloop.PolicyControlLoopParticipant_Instance1", - "version": "2.3.1" - }, - { - "name": "org.onap.k8s.controlloop.K8SControlLoopParticipant_Instance1", - "version": "2.3.4" - }, - { - "name": "org.onap.controlloop.HttpControlLoopParticipant_Instance1", - "version": "2.3.4" - }, - { - "name": "org.onap.domain.pmsh.DerivedDerivedPolicyControlLoopElement_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.database.Http_PMSHMicroserviceControlLoopElement_Instance1", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.database.PMSH_K8SMicroserviceControlLoopElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.DerivedPolicyControlLoopElement", - "version": "1.2.3" - } - ] - } - -**Step 11:** To try out other endpoints try out the other postman collections inside Instantiation folder - -**Step 12:** To delete Instance properties select DELETE Instance Properties - - *- Should receive the following result* - -.. code-block:: json - :linenos: - - { - "errorDetails": null, - "affectedControlLoops": [ - { - "name": "PMSH_Instance1", - "version": "1.2.3" - } - ] - } - -**Step 13:** For monitoring endpoints go to Control Loop Istanbul/Monitoring folder - -Jakarta -+++++++ - - -**Step 1:** Clone Policy Clamp - -.. code-block:: bash - - git clone "https://gerrit.onap.org/r/policy/clamp" - -**Step 2:** Change Master Branch to Jakarta - -.. code-block:: bash - - git checkout -b origin/jakarta - -**Step 3:** Run Maven Clean Install - -.. code-block:: bash - - mvn clean install - -**Step 3:** Create the Database by going to /clamp/runtime/extra/bin-for-dev - -.. code-block:: bash - - ./start-db.sh test - -**Step 4:** Start Clamp Runtime by going to /clamp/runtime/extra/bin-for-dev - -.. code-block:: bash - - ./start-backend.sh - -**Step 5:** Start Automation Composition Runtime by going to /clamp/runtime-acm - -.. code-block:: bash - - java -jar target/policy-clamp-runtime-acm-6.3.0-SNAPSHOT.jar - -**Step 6:** Open up Postman and import the following collections - - `Download Jakarta Postman Collections `_ - -**Step 7:** Open up the folder Automation Composition Jakarta/Commissioning - - Select POST Commission Tosca Service Template and run it. - - *- Should receive the following result* - -.. code-block:: json - :linenos: - - { - "errorDetails": null, - "affectedAutomationCompositionDefinitions": [ - { - "name": "org.onap.domain.database.Http_PMSHMicroserviceAutomationCompositionElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.database.PMSH_K8SMicroserviceAutomationCompositionElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.PMSH_MonitoringPolicyAutomationCompositionElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.PMSH_OperationalPolicyAutomationCompositionElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.sample.GenericK8s_AutomationCompositionDefinition", - "version": "1.2.3" - }, - { - "name": "org.onap.policy.clamp.acm.HttpParticipant", - "version": "2.3.4" - }, - { - "name": "org.onap.policy.clamp.acm.KubernetesParticipant", - "version": "2.3.4" - }, - { - "name": "org.onap.policy.clamp.acm.PolicyParticipant", - "version": "2.3.1" - } - ] - } - -**Step 8:** To try out other endpoints try out the other postman collections inside commission folder - -**Step 9:** To decommission the Tosca Service Template Select DELETE Tosca Service Template - - *- Should receive the following result* - -.. code-block:: json - :linenos: - - { - "errorDetails": null, - "affectedAutomationCompositionDefinitions": [ - { - "name": "ToscaServiceTemplateSimple", - "version": "1.0.0" - } - ] - } - -**Step 10:** For Instance Properties select the following folder in postman Automation Composition Jakarta/Instantiation - - Select POST Instance Properties - - *- Should receive the following result* - -.. code-block:: json - :linenos: - - { - "errorDetails": null, - "affectedInstanceProperties": [ - { - "name": "ATT", - "version": "2.3.4" - }, - { - "name": "org.onap.domain.sample.GenericK8s_AutomationCompositionDefinition", - "version": "1.2.3" - }, - { - "name": "org.onap.policy.clamp.acm.PolicyParticipant", - "version": "2.3.1" - }, - { - "name": "org.onap.domain.pmsh.PMSH_OperationalPolicyAutomationCompositionElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.PMSH_MonitoringPolicyAutomationCompositionElement", - "version": "1.2.3" - }, - { - "name": "org.onap.policy.clamp.acm.HttpParticipant", - "version": "2.3.4" - }, - { - "name": "org.onap.policy.clamp.acm.KubernetesParticipant-ATT", - "version": "2.3.4" - }, - { - "name": "org.onap.policy.clamp.acm.KubernetesParticipant", - "version": "2.3.4" - }, - { - "name": "org.onap.domain.database.Http_PMSHMicroserviceAutomationCompositionElement-ATT", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.PMSH_OperationalPolicyAutomationCompositionElement-ATT", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.database.Http_PMSHMicroserviceAutomationCompositionElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.database.PMSH_K8SMicroserviceAutomationCompositionElement-ATT", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.pmsh.PMSH_MonitoringPolicyAutomationCompositionElement-ATT", - "version": "1.2.3" - }, - { - "name": "org.onap.policy.clamp.acm.PolicyParticipant-ATT", - "version": "2.3.1" - }, - { - "name": "org.onap.policy.clamp.acm.HttpParticipant-ATT", - "version": "2.3.4" - }, - { - "name": "org.onap.domain.database.PMSH_K8SMicroserviceAutomationCompositionElement", - "version": "1.2.3" - }, - { - "name": "org.onap.domain.sample.GenericK8s_AutomationCompositionDefinition-ATT", - "version": "1.2.3" - } - ] - } - -**Step 11:** To try out other endpoints try out the other postman collections inside Instantiation folder - -**Step 12:** To delete Instance properties select DELETE Instance Properties - - *- Should receive the following result* - -.. code-block:: json - :linenos: - - { - "errorDetails": null, - "affectedAutomationCompositionDefinitions": [ - { - "name": "ToscaServiceTemplateSimple", - "version": "1.0.0" - } - ] - } - -**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 -- cgit 1.2.3-korg