+++ /dev/null
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-.. _clamp-policy-gui-label:
-
-TOSCA Policy GUI
-################
-
-.. contents::
- :depth: 4
-
-1 - How to run the Front-End Gui
-================================
-This section describes how to run the front end on your local machine.
-
-**Prerequisite:**
-
-**Building and running CLAMP**
-
-see
-:ref:`Clamp ACM Smoke Tests <policy-clamp-runtime-smoke-label>`
-
-**Step 1:** Go to the clamp directory
-
-.. code-block:: bash
-
- cd /clamp/extra/bin-for-dev
-
-**Step 2:** Inside the clamp directory run
-
-.. code-block:: bash
-
- ./start-db.sh test
-
-**Step 3:** Check docker container id
-
-.. code-block:: bash
-
- docker ps
-
-**Step 4:** Log into docker container
-
-.. code-block:: bash
-
- docker exec -it 'container_id' bash
-
-**Step 5:** Go into mariadb shell
-
-.. code-block:: bash
-
- mysql -u root -p
-
-**Step 6:** Enter password
-
- strong_pitchou
-
-.. image:: images/01-gui.png
-
-**Step 7:** Go into cldsdb4 database
-
-.. code-block:: bash
-
- use cldsdb4;
-
-**Step 8:** Verify if there is data in the following table 'loop_templates'
-
-.. code-block:: bash
-
- select * from loop_templates;
-
-** If for some reason the database is empty do the go to the '/docker-entrypoint-initdb.d/dump' directory
-
-.. code-block:: bash
-
- ./load-fake-data.sh
-
-**Step 9:** Once the database is up and running need to start the clamp emulator, by running the following command inside the /clamp/extra/bin-for-dev
-
-.. code-block:: bash
-
- ./start-emulator.sh
-
-**Step 10:** Verify if mariadb and the emulator is running
-
-.. code-block:: bash
-
- docker ps
-
-.. image:: images/02-gui.png
-
-**Step 11:** Start the backend service by running the command inside the /clamp/extra/bin-for-dev
-
-.. code-block:: bash
-
- ./start-backend.sh
-
-
-.. _building-ui-label:
-
-2 - Checking out and building the UI
-====================================
-
-**Step 1:** Checkout the UI from the repo
-
-.. code-block:: bash
-
- git clone "https://gerrit.nordix.org/onap/policy/gui"
-
-**Step 2:** Change into the "gui" directory and run the following
-
-.. code-block:: bash
-
- mvn clean install
-
-**Step 3:** Go into the gui-clamp/ui-react directory and run the following
-
-.. code-block:: bash
-
- npm install
-
-**Step 4:** Start the front end UI
-
-.. code-block:: bash
-
- npm start --scripts-prepend-node-path
-
-*If you get the following error*
-
-.. image:: images/03-gui.png
-
-.. code-block:: bash
-
- gedit package.json
-
-Then change ``"version": "${project.version}",`` to ``"version": "2.1.1",``
-
-Save and close, then delete the node_modules directory
-
-.. code-block:: bash
-
- rm -rf node_modules/
-
-Then run again
-
-.. code-block:: bash
-
- npm install
-
-.. code-block:: bash
-
- npm start --scripts-prepend-node-path
-
-**Step 5:** Once the UI starts at localhost:3000 it will ask for credentials:
-
- Login: admin
- Password: password
-
-3 - How to Commission/Decommission the TOSCA Service Template
-=============================================================
-
-This section describes how to commission and decommission the Tosca Service Template
-
-** Prerequisite:
-
-See :ref:`Policy GUI Prerequisites<clamp-policy-gui-label>`
-
-**Step 1:** From the Main Menu Click on TOSCA Automation Composition Dropdown
-
-.. image:: images/04-gui.png
-
-**Step 2:** From the Dropdown Menu Select Upload Automation Composition To Commissioning
-
-.. image:: images/05-gui.png
-
-**Step 3:** On the window Upload Tosca to Commissioning API Click on the input box that says 'Please Select a file'
-
-.. image:: images/06-gui.png
-
-**Step 4:** Once the yaml file is selected click on Upload Tosca Service Template
-
-.. image:: images/07-gui.png
-
-**Step 5:** After the upload there should have a message "Upload Success" in green
-
-.. image:: images/08-gui.png
-
-**Step 6:** To validate that the TOSCA Service Template has been commissioned click on Manage Commissioned Automation Composition Template
-
-.. image:: images/09-gui.png
-
-**Step 7:** In the View Tosca Template Window click on Pull Tosca Service Template
-
-.. image:: images/10-gui.png
-
-**Step 8:** Once the Tosca Service Template has been pulled there should be a json object rendered in the window
-
-.. image:: images/11-gui.png
-
-**Step 9:** Click on Close close the window
-
-**Step 10:** Click on Edit Automation Composition Properties
-
-.. image:: images/12-gui.png
-
-**Step 11:** In the Change ACM Common Properties change the appropriate properties and click on save and there should have a popup saying 'Changes Saved. Commission When Ready...'
-
-.. image:: images/13-gui.png
-
-**Step 12:** After saving the changes click on Commission and should have a Green message saying 'Commissioning Success'
-
-.. image:: images/14-gui.png
-
-**Step 13:** To Decommission the Tosca Service Follow Step 6 and 8
-
-**Step 14:** Once the json objected is rendered in the window click on delete
-
-.. image:: images/11-gui.png
-
-**Step 14:** Once the json objected is rendered in the window click on delete
-
-.. image:: images/11-gui.png
-
-**Step 15:** If the delete is successful it should show a message "Delete Successful"
-
-.. image:: images/15-gui.png
-
-4 - How to Save Instance Properties and Change The Order State
-==============================================================
-
-This section describes how to save the instance properties and change it's order state
-
-** Prerequisite:
-
-see building-ui-label_
-
-**Step 1:** Go to the participant http directory
-
-.. code-block:: bash
-
- cd /clamp/participant/participant-impl/participant-impl-http
-
-**Step 2:** Run he following command
-
-.. code-block:: bash
-
- mvn spring-boot:run -Dspring-boot.run.arguments=--server.port=8080
-
-**Step 3:** Go to the participant kubernetes directory
-
-.. code-block:: bash
-
- cd /clamp/participant/participant-impl/participant-impl-kubernetes
-
-**Step 4:** Run he following command
-
-.. code-block:: bash
-
- mvn spring-boot:run -Dspring-boot.run.arguments=--server.port=8081
-
-**Step 5:** Go to the participant policy directory
-
-.. code-block:: bash
-
- cd /clamp/participant/participant-impl/participant-impl-policy
-
-**Step 6:** Run he following command
-
-.. code-block:: bash
-
- mvn spring-boot:run -Dspring-boot.run.arguments=--server.port=8082
-
-**Step 7:** From the Main Menu Click on Instantiation Management
-
-.. image:: images/16-gui.png
-
-**Step 8:** Once the window for Manage Instance is open click on Create Instance
-
-.. image:: images/17-gui.png
-
-**Step 9:** With the Window Create Instance Properties Insert a Name and change the appropriate properties and click save
-
-.. image:: images/18-gui.png
-
-**Step 10:** After clicking save it should come with a green message saying "Instantiation Properties Success"
-
-.. image:: images/19-gui.png
-
-**Step 11:** To delete an instance repeat Step 7
-
-.. image:: images/16-gui.png
-
-**Step 12:** Once the window for Manage Instance is open click on Delete
-
-.. image:: images/20-gui.png
-
-* NOTE: The only way to delete the instance properties if the order state has to be UNINITIALISED
-
-**Step 13:** To change the state click on Change in Manage Instances Window
-
-.. image:: images/20-gui.png
-
-**Step 14:** After clicking Change there should have a drop down with specific different ordered states
-
-.. image:: images/21-gui.png
-
-**Step 15:** From UNINITIALISED the user can only select Passive Ordered State
-
-.. image:: images/22-gui.png
-
-**Step 16:** Click on Save and a Message in Green "Ordered State Change Success"
-
-.. image:: images/23-gui.png
-
-* NOTE: Can't change from Passive to Running in a local developer machine, can only change in the production environment
-
-End of document
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. _clamp-acm-a1pms-participant:
+
+A1PMS Participant
+######################
+
+The A1PMS participant receives A1 policy service information from the CLAMP runtime and creates the A1 policy service in A1PMS. The participant acts as a wrapper around the A1PMS and creates the policy service.
+
+Supported message Broker are DMaap and Strimzi-Kafka.
+
+.. image:: ../../images/participants/a1pms-participant.png
+
+When an automation composition is initialized, the A1PMS participant starts a A1PMS Automation Composition
+element for the automation composition. It reads the configuration information sent from the
+Automation Composition Runtime and runs a REST client to talk to the A1PMS endpoint receiving
+the REST requests.
+
+Prerequisites for using A1PMS participant:
+------------------------------------------
+
+- A running A1PMS. A1PMS base url should be configured in A1PMS participant to make REST calls.
+
+
+Supported Element Types
+-----------------------
+Supported Element Types for A1PMS participant will be used to define the A1PMS participant Element Definition Types in tosca template.
+Participant Supported Element Types is defined in A1PMS participant application.yaml.
+
+.. code-block:: YAML
+
+ participantSupportedElementTypes:
+ -
+ typeName: org.onap.policy.clamp.acm.A1PMSAutomationCompositionElement
+ typeVersion: 1.0.1
+
+Defining a TOSCA CL definition for A1PMS participant:
+-----------------------------------------------------
+
+A *Policy Service Entity* describes a A1PMS policy service that is managed by the A1PMS participant. A
+Policy Service Entity can be created, Read, and Deleted. The user defines
+the A1 Policy Service Entities that it wants its A1PMS Automation Composition Element to manage and
+provides the parameters to manage each A1 Policy Service Entity.
+
+Sample tosca template defining a participant and a AC element definition. :download:`click here <tosca/tosca-a1pms-participant.yml>`
+
+
+Configuring a Automation Composition Element on the A1PMS participant for a Automation Composition
+-------------------------------------------------------------------------------------------------------
+
+The user defines the following properties in the TOSCA template for the a1pms participant:
+
+.. list-table::
+ :widths: 15 10 50
+ :header-rows: 1
+
+ * - Property
+ - Type
+ - Description
+ * - a1PolicyServiceEntityId
+ - ToscaConceptIdentifier
+ - The name and version of the A1 Policy Service that needs to be managed by the A1PMS participant
+ * - clientId
+ - String
+ - The identity of the service
+ * - callbackUrl
+ - String
+ - The callback for notifying of Near-RT RIC state changes
+ * - keepAliveIntervalSeconds
+ - Integer
+ - Keep alive interval for the service. This is used to enable optional heartbeat supervision of the service. If set (> 0) the registered service should regularly invoke a 'keepalive' REST call. When a service fails to invoke this 'keepalive' call within the configured time, the service is considered unavailable. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means timeout supervision is disabled.
+
+Sample Automation Composition instances.
+In that example the user fills the properties defined in the TOSCA for the A1PMS participant :download:`click here <tosca/automation-composition-a1pms.yml>`
+
+A1PMS participant Interactions:
+-------------------------------
+The A1PMS participant interacts with Automation Composition Runtime on the northbound via Message Broker. It interacts with the A1PMS on the southbound for performing A1PMS service relation operations.
+
+The communication for the Automation Composition updates and state change requests are sent from the Automation Composition Runtime to the participant via Message Broker.
+The participant performs appropriate operations on the A1PMS via REST based on the received messages from the Automation Composition Runtime.
+
+
+A1PMS participant Workflow:
+---------------------------
+Once the participant is started, it sends a "REGISTER" event to the Message Broker topic which is then consumed by the Automation Composition Runtime to register this participant on the runtime database.
+The user can commission the tosca definitions from the Policy Gui to the Automation Composition Runtime.
+Once the automation composition definitions are available in the runtime database, the user can prime them and further updates the participant with these definitions via Message Broker.
+After primed, the Automation Composition can be instantiated with the default state "UNDEPLOYED" from the Policy Gui.
+
+When the state of the Automation Composition is changed from "UNDEPLOYED" to "DEPLOYED" from the Policy Gui, the a1pms participant receives the automation composition state change event from the runtime and creates the A1 policy services associated with each Automation Composition Elements.
+
+When the state of the Automation Composition is changed from "DEPLOYED" to "UNDEPLOYED" back, the participant deletes the A1 policy services that are part of the Automation Composition Element.
--- /dev/null
+tosca_definitions_version: tosca_simple_yaml_1_3
+data_types:
+ onap.datatypes.ToscaConceptIdentifier:
+ derived_from: tosca.datatypes.Root
+ properties:
+ name:
+ type: string
+ required: true
+ version:
+ type: string
+ required: true
+ org.onap.datatypes.policy.clamp.acm.a1PmsAutomationCompositionElement.A1PolicyServiceEntity:
+ version: 1.0.0
+ derived_from: tosca.datatypes.Root
+ properties:
+ a1PolicyServiceEntityId:
+ type: onap.datatypes.ToscaConceptIdentifier
+ type_version: 1.0.0
+ required: true
+ description: The name and version of a Configuration Entity to be handled by the A1 PMS Automation Composition Element
+ clientId:
+ type: string
+ required: true
+ description: Client Id to be created
+ callbackUrl:
+ type: string
+ required: true
+ description: The callback URL to get registered
+ keepAliveIntervalSeconds:
+ type: integer
+ required: true
+ description: Keep alive interval time for the callback URL
+
+node_types:
+ org.onap.policy.clamp.acm.Participant:
+ version: 1.0.1
+ derived_from: tosca.nodetypes.Root
+ properties:
+ provider:
+ type: string
+ required: false
+ org.onap.policy.clamp.acm.AutomationCompositionElement:
+ version: 1.0.1
+ derived_from: tosca.nodetypes.Root
+ properties:
+ provider:
+ type: string
+ required: false
+ participantType:
+ type: onap.datatypes.ToscaConceptIdentifier
+ required: true
+ startPhase:
+ type: integer
+ required: false
+ constraints:
+ - greater-or-equal: 0
+ metadata:
+ common: true
+ description: A value indicating the start phase in which this automation composition element will be started, the
+ first start phase is zero. Automation Composition Elements are started in their start_phase order and stopped
+ in reverse start phase order. Automation Composition Elements with the same start phase are started and
+ stopped simultaneously
+ org.onap.policy.clamp.acm.AutomationComposition:
+ version: 1.0.1
+ derived_from: tosca.nodetypes.Root
+ properties:
+ provider:
+ type: string
+ required: false
+ elements:
+ type: list
+ required: true
+ entry_schema:
+ type: onap.datatypes.ToscaConceptIdentifier
+ org.onap.policy.clamp.acm.A1PMSAutomationCompositionElement:
+ version: 1.0.1
+ derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
+ properties:
+ policyServiceEntities:
+ type: list
+ required: true
+ entry_schema:
+ type: org.onap.datatypes.policy.clamp.acm.a1pmsAutomationCompositionElement.A1PolicyServiceEntity
+ type_version: 1.0.0
+ description: The configuration entities of A1 policy services
+topology_template:
+ node_templates:
+ org.onap.policy.clamp.acm.A1PMSAutomationCompositionParticipant:
+ version: 2.3.4
+ type: org.onap.policy.clamp.acm.Participant
+ type_version: 1.0.1
+ description: Participant for A1 PMS requests
+ properties:
+ provider: ONAP
+
+ onap.policy.clamp.ac.element.A1PMSAutomationCompositionElement:
+ version: 1.2.3
+ type: org.onap.policy.clamp.acm.A1PMSAutomationCompositionElement
+ type_version: 1.0.1
+ description: Automation composition element for the A1 PMS Requests
+ properties:
+ provider: ONAP
+
+ org.onap.domain.sample.A1PMSAutomationCompositionDefinition:
+ version: 1.2.3
+ type: org.onap.policy.clamp.acm.AutomationComposition
+ type_version: 1.0.0
+ description: Automation composition for A1PMS request
+ properties:
+ provider: ONAP
+ elements:
+ - name: onap.policy.clamp.ac.element.A1PMSAutomationCompositionElement
+ version: 1.2.3
\ No newline at end of file
Code Review / policy / parent.git / commitdiff
