Document changes for API springboot migration
Issue-ID: POLICY-3925
Signed-off-by: Rashmi Pujar <rashmi.pujar1@bell.ca>
Change-Id: Ie517af1fd40c3eafcc758d3fd421a5ce8ca22517
diff --git a/docs/api/api.rst b/docs/api/api.rst
index 5aa3885..273b875 100644
--- a/docs/api/api.rst
+++ b/docs/api/api.rst
@@ -5,8 +5,11 @@
.. THIS IS USED INTERNALLY IN POLICY ONLY
.. _api-label:
-Policy Life Cycle API
-#####################
+1. Policy Life Cycle API
+########################
+
+1.1 Overview
+------------
.. contents::
:depth: 2
@@ -105,6 +108,8 @@
The group types of targets in TOSCA are groups of TOSCA nodes, not PDP groups; the *target* concept in TOSCA is
equivalent to the Policy Enforcement Point (PEP) concept
+1.2 Preloaded policy types and policies
+---------------------------------------
To ease policy creation, we preload several widely used policy types in policy database. Below is a table listing the preloaded policy types.
@@ -169,10 +174,14 @@
"vFirewallCDS.Operational.Tosca", `vFirewallCDS.policy.operational.input.tosca.yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vFirewallCDS.policy.operational.input.tosca.yaml>`_
+2. APIs exposed
+###############
+
+2.1 Global API Table
+--------------------
+
Below is a global API table from where swagger JSON for different types of policy design API can be downloaded.
-Global API Table
-----------------
.. csv-table::
:header: "API name", "Swagger JSON"
:widths: 10,5
@@ -183,8 +192,8 @@
"Tosca Policy API", ":download:`link <swagger/policy-api.json>`"
"Tosca NodeTemplate API", ":download:`link <swagger/nodetemplates-api.json>`"
-API Swagger
------------
+2.2 API Swagger
+---------------
It is worth noting that we use basic authorization for API access with username and password set to *policyadmin* and *zb!XztG34* respectively.
Also, the new APIs support both *http* and *https*.
@@ -219,8 +228,8 @@
.. swaggerv2doc:: swagger/policy-api.json
-Creating MetadataSet for policy
---------------------------------
+2.3 Creating MetadataSet for policy
+-----------------------------------
The policy type implementation in tosca policy can be independently persisted to the database as metadataSets via the Tosca node template Apis .
The policy type implementation data can be excluded from the policy properties section of the tosca policy and the user can specify only the "metadataSetName" and "metadataSetVersion"
@@ -289,8 +298,8 @@
or policy type at a time for safety purpose. If client has the need to delete multiple or a group of policies or policy types,
they will need to delete them one by one.
-Sample API Curl Commands
--------------------------
+2.4 Sample API Curl Commands
+----------------------------
From an API client perspective, using *http* or *https* does not make much difference to the curl command.
Here we list some sample curl commands (using *http*) for POST, GET and DELETE monitoring and operational policies that are used in vFirewall use case.
@@ -324,3 +333,11 @@
Delete version 1.0.0 of vFirewall Monitoring Policy::
curl --user 'policyadmin:zb!XztG34' -X DELETE "http://{ip}:{port}/policy/api/v1/policies/onap.vfirewall.tca/versions/1.0.0" -H "Accept: application/json" -H "Content-Type: application/json"
+
+
+3. Policy API application configuration
+#######################################
+
+Starting from Jakarta Release policy-api is a Springboot based microservice.
+
+The policy-api application configuration is packaged as a K8S ConfigMap object via `Policy-API OOM charts <https://gerrit.onap.org/r/gitweb?p=oom.git;a=blob;f=kubernetes/policy/components/policy-api/resources/config/apiParameters.yaml;h=c08b035d53f299fe0e08b45bd95a760283acce66;hb=refs/heads/master>`_
diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst
index 787af68..9012caf 100644
--- a/docs/development/devtools/devtools.rst
+++ b/docs/development/devtools/devtools.rst
@@ -253,9 +253,10 @@
information on doing so. Once the mariadb is up and running, a configuration file must be provided to the api in order for it to know how to
connect to the mariadb. You can locate the default configuration file in the packaging of the api component:
-`Default API Configuration <https://gerrit.onap.org/r/gitweb?p=policy/api.git;a=blob;f=packages/policy-api-tarball/src/main/resources/etc/defaultConfig.json;h=042fb9d54c79ce4dad517e2564636632a8ecc550;hb=refs/heads/master>`_
+`Default Policy API Configuration <https://gerrit.onap.org/r/gitweb?p=policy/api.git;a=blob;f=packages/policy-api-tarball/src/main/resources/etc/apiParameters.yaml;h=2c19199a8a889cb0ab203334182662fe15e1635e;hb=refs/heads/master>`_
-You will want to change the fields pertaining to "host", "port" and "databaseUrl" to your local environment settings.
+You will want to change the fields pertaining to "host", "port" and "databaseUrl" to your local environment settings and start the
+policy-api springboot application either using your IDE of choice or using the run goal from Spring Boot Maven plugin: *mvn spring-boot:run*.
Running the API component using Docker Compose
++++++++++++++++++++++++++++++++++++++++++++++
@@ -347,6 +348,10 @@
Generating Swagger Documentation
********************************
+
+1. Using Swagger2Markup maven plugin from Policy Parent Integration POM
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
The `Policy Parent Integration POM <https://github.com/onap/policy-parent/blob/master/integration/pom.xml>`_ contains a *generateSwaggerDocs* profile. This
profile can be activated on any module that has a Swagger endpoint. When active, this profile creates a tarball in Nexus with the name
*<project-artifactId>-swagger-docs.tar.gz*. The tarball contains the following files:
@@ -394,6 +399,16 @@
See `this unit test case <https://github.com/onap/policy-clamp/blob/master/runtime/src/test/java/org/onap/policy/clamp/clds/it/HttpsItCase.java>`_
for the full example.
+2. Accessing Swagger documentation for springboot based policy applications
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Springfox Swagger2 maven dependency aids with auto-generation of Swagger documentation.
+
+Using the Swagger-UI maven dependency Swagger HTML documentation can be accessed at the root url.
+
+- The generated swagger.json can be accessed at: *https://service_IP:service_port/v2/api-docs*
+- Swagger UI can be accessed at: *https://service_IP:service_port/swagger-ui/index.html*
+
Running the DMaaP Simulator during Development
**********************************************
It is sometimes convenient to run the DMaaP simulator during development. You can run it from the command line using Maven or from within your IDE.