3 ### General description
4 More information about the project and all its functionalities you can find under the wiki page:
6 https://wiki.onap.org/display/DW/OOM+Certification+Service
10 * OOM Cert Service Api is a Spring Boot application
12 Use Google code formatter in your IDE.
13 For IntelliJ use [https://plugins.jetbrains.com/plugin/8527-google-java-format]
14 For other IDEs use []https://github.com/google/google-java-format]
16 ### Local project configuration
17 * Create directory on your system /etc/onap/oom/certservice
18 * Copy sample configuration test/resources/cmpServers.json to that directory
21 MANDATORY SEE 'Local project configuration' section
26 ### Running Locally with Developer Tools
27 MANDATORY SEE 'Local project configuration' section
29 mvn spring-boot:run -Pdev
37 ### Building Docker image manually
38 Go to the certService subfolder and execute following statement (1.0.0-SNAPSHOT is related to a current project.version parameter):
40 docker build --build-arg VERSION=1.0.0-SNAPSHOT -t onap/org.onap.oom.certservice.oom-certservice-api .
43 ### Install the package into the local repository
48 ### Building Docker image and install the package into local repository
50 mvn clean install -P docker
53 ### Running Docker container local
55 docker run -p 8080:8080 --name oom-certservice-api --mount type=bind,source=/<absolute_path>/cmpServers.json,target=/etc/onap/
56 oom/certservice/cmpServers.json onap/org.onap.oom.certservice.oom-certservice-api
59 ### Running Docker container from nexus
61 docker run -p 8080:8080 --name oom-certservice-api --mount type=bind,source=/<absolute_path>/cmpServers.json,target=/etc/onap/oom/certservice/cmpServers.json nexus3.onap.org:10001/onap/org.onap.oom.platform.cert-service.oom-certservice-api:1.0.0
67 http://<localhost>:8080/actuator/health
72 curl localhost:8080/actuator/health
74 Should return {"status":"UP"}
80 var/log/onap/oom/certservice/
82 ### Logs in Docker container
84 docker exec -it oom-certservice-api bash
89 cd /var/log/onap/oom/certservice
92 audit.log error.log debug.log
95 API is described by Swagger ( OpenAPI 3.0 ) on endpoint /docs
96 ( endpoint is defined in properties as springdoc.swagger-ui.path )
98 http://localhost:8080/docs
102 during project building yaml file with openAPI 3.0 documentation is generated in target directory with name api-docs.yaml
103 file OpenAPI.yaml located in ./docs/sections/resources directory must be updated be hand if needed