X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdevelopment%2Fdevtools%2Fdevtools.rst;h=1ecd2bc497fefbc8a044694330b125ed7db6c6ef;hb=0659d1742f78a72aeb8bad7849e0a922ef81815e;hp=9012caf8359e43f2791355288a7bdd4bd5441922;hpb=2061a3615aa6e8d6810b9ac74402726ce077668e;p=policy%2Fparent.git diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst index 9012caf8..1ecd2bc4 100644 --- a/docs/development/devtools/devtools.rst +++ b/docs/development/devtools/devtools.rst @@ -13,7 +13,6 @@ Policy Platform Development Tools This article explains how to build the ONAP Policy Framework for development purposes and how to run stability/performance tests for a variety of components. To start, the developer should consult the latest ONAP Wiki to familiarize themselves with developer best practices and how-tos to setup their environment, see `https://wiki.onap.org/display/DW/Developer+Best+Practices`. - This article assumes that: * You are using a *\*nix* operating system such as linux or macOS. @@ -27,7 +26,7 @@ The procedure documented in this article has been verified to work on a MacBook Cloning All The Policy Repositories *********************************** -Run a script such as the script below to clone the required modules from the `ONAP git repository `_. This script clones all the ONAP Policy Framework repositories. +Run a script such as the script below to clone the required modules from the `ONAP git repository `_. This script clones all the ONAP Policy Framework repositories. ONAP Policy Framework has dependencies to the ONAP Parent *oparent* module, the ONAP ECOMP SDK *ecompsdkos* module, and the A&AI Schema module. @@ -246,7 +245,7 @@ Another example on how to run the MariaDb is using the docker compose file used `Example Compose Script to run MariaDB `_ Running the API component standalone -+++++++++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++++++++ Assuming you have successfully built the codebase using the instructions above. The only requirement for the API component to run is a running MariaDb database instance. The easiest way to do this is to run the docker image, please see the mariadb documentation for the latest @@ -265,6 +264,20 @@ An example of running the api using a docker compose script is located in the Po `Policy CSIT API Docker Compose `_ +Running the PAP component standalone +++++++++++++++++++++++++++++++++++++ + +Once you have successfully built the PAP codebase, a running MariaDb database and DMaaP instance will also be required to start up the application. +For MariaDb instance, the easiest way is to run the docker image, please see the mariadb documentation for the latest +information on doing so. For DMaaP, the easiest way during development is to run the DMaaP simulator which is explained in the below sections. +Once the mariadb and DMaaP are running, a configuration file must be provided to the PAP component in order for it to know how to +connect to the mariadb and DMaaP along with other relevant configuration details. You can locate the default configuration file in the packaging of the PAP component: + +`Default PAP Configuration `_ + +Update the fields related to MariaDB, DMaaP and the RestServer for the application as per your local environment settings. +Then to start the application, just run the Spring Boot application using IDE or command line. + Running the Smoke Tests *********************** @@ -283,15 +296,8 @@ familiar with the Policy Framework components and test any local changes. api-smoke.rst pap-smoke.rst apex-smoke.rst - distribution-smoke.rst - -.. drools-smoke.rst - -.. xacml-smoke.rst - -.. distribution-smoke.rst @@ -327,6 +333,8 @@ the Policy Framework works in a full ONAP deployment. policy-cds.rst + clamp-sdc.rst + .. api-pairwise.rst @@ -346,60 +354,61 @@ the Policy Framework works in a full ONAP deployment. distribution-pairwise.rst -Generating Swagger Documentation -******************************** +Testing OpenSuse docker images +****************************** -1. Using Swagger2Markup maven plugin from Policy Parent Integration POM -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +Policy Framework offers docker images in two flavors: Alpine and OpenSuse. +Alpine images are used in OOM for ONAP deployments. +The OpenSuse images are built manually if needed, by running Maven with the -Pdockersuse profile. +To test these images, CSITs will be run. -The `Policy Parent Integration POM `_ 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 -*-swagger-docs.tar.gz*. The tarball contains the following files: +1. Build the OpenSuse image you want by running Maven with -Pdockersuse: -.. code-block:: bash + .. code-block:: bash - swagger/swagger.html - swagger/swagger.json - swagger/swagger.pdf + cd policy/apex-pdp + mvn clean install -Pdockersuse -The profile is activated when: + The image onap/policy-apex-pdp:latest will be produced. -1. The following property is defined at the top of the *pom.xml* file for a module +2. To avoid ambiguity, tag the image as opensuse: .. code-block:: bash - - post-integration-test + docker tag onap/policy-apex-pdp:latest onap/policy-apex-pdp:opensuse - See the `CLAMP runtime POM `_ for an example of the usage of this property. +3. Clone policy/docker repo. -2. Unit tests are being executed in the build, in other words when the *skipTests* flag is *false*. +4. Modify docker/csit/docker-compose-all.yml to use the tagged OpenSuse image. -You **must** create a unit test in your module that generates the following file: + Replace: -.. code-block:: bash + .. code-block:: yaml - src/test/resources/swagger/swagger.json + apex-pdp: + image: nexus3.onap.org:10001/onap/policy-apex-pdp:${POLICY_APEX_PDP_VERSION} -Typically, you do this by starting your REST endpoint in a unit test, issuing a REST call to get the Swagger API documentation. The test case below is an example -of such a test case. + with: -.. code-block:: java + .. code-block:: yaml - @Test - public void testSwaggerJson() throws Exception { - ResponseEntity httpsEntity = getRestTemplate() - .getForEntity("https://localhost:" + this.httpsPort + "/restservices/clds/api-doc", String.class); - assertThat(httpsEntity.getStatusCode()).isEqualTo(HttpStatus.OK); - assertThat(httpsEntity.getBody()).contains("swagger"); - FileUtils.writeStringToFile(new File("target/swagger/swagger.json"), httpsEntity.getBody(), - Charset.defaultCharset()); - } + apex-pdp: + image: onap/policy-apex-pdp:opensuse + +5. Run the project CSIT. For apex-pdp: + + .. code-block:: bash -See `this unit test case `_ -for the full example. + cd docker/csit + ./run-project-csit.sh apex-pdp -2. Accessing Swagger documentation for springboot based policy applications + Automated tests will be run, and log files displayed. + + +Generating Swagger Documentation +******************************** + +1. Accessing Swagger documentation for springboot based policy applications +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Springfox Swagger2 maven dependency aids with auto-generation of Swagger documentation. @@ -453,3 +462,15 @@ You may specify a local configuration file instead of *src/test/resources/simPar } ] } + +Bringing up Strimzi-Kafka Deploment with Policy Framework +********************************************************* + +This page will explain how to setup a local Kubernetes cluster and minimal helm setup to run and deploy Policy Framework on a single host. + +This is meant for a development purpose only as we are going to use microk8s in this page + +.. toctree:: + :maxdepth: 1 + + strimzi-policy.rst