aboutsummaryrefslogtreecommitdiffstats
path: root/certService/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'certService/README.md')
-rw-r--r--certService/README.md175
1 files changed, 83 insertions, 92 deletions
diff --git a/certService/README.md b/certService/README.md
index 5a650f1c..f9478bed 100644
--- a/certService/README.md
+++ b/certService/README.md
@@ -13,138 +13,129 @@ More information about the project and all its functionalities you can find unde
For IntelliJ use [https://plugins.jetbrains.com/plugin/8527-google-java-format]
For other IDEs use []https://github.com/google/google-java-format]
-### Running Locally
- ```
- mvn spring-boot:run
+### Local project configuration
+ * Create directory on your system /etc/onap/aaf/certservice
+ * Copy sample configuration test/resources/cmpServers.json to that directory
- ```
-
+### Running Locally
+MANDATORY SEE 'Local project configuration' section
+```
+mvn spring-boot:run
+```
+
### Running Locally with Developer Tools
- ```
- mvn spring-boot:run -Pdev
-
- ```
+MANDATORY SEE 'Local project configuration' section
+```
+mvn spring-boot:run -Pdev
+```
### Project building
- ```
- mvn clean package
-
- ```
+```
+mvn clean package
+```
### Building Docker image manually
Go to the certService subfolder and execute following statement (1.0.0-SNAPSHOT is related to a current project.version parameter):
- ```
- docker build --build-arg VERSION=1.0.0-SNAPSHOT -t onap/org.onap.aaf.certservice.aaf-certservice-api .
- ```
+```
+docker build --build-arg VERSION=1.0.0-SNAPSHOT -t onap/org.onap.aaf.certservice.aaf-certservice-api .
+```
### Install the package into the local repository
- ```
- mvn clean install
-
- ```
+```
+mvn clean install
+```
### Building Docker image and install the package into the local repository
- ```
- mvn clean install -P docker
-
- ```
+```
+mvn clean install -P docker
+```
### Running Docker container local
- ```
- docker run -p 8080:8080 --name aaf-certservice-api onap/org.onap.aaf.certservice.aaf-certservice-api
-
- ```
+```
+docker run -p 8080:8080 --name aaf-certservice-api onap/org.onap.aaf.certservice.aaf-certservice-api
+```
### Running Docker container from nexus
- ```
- docker run -p 8080:8080 --name aaf-certservice-api nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-api:1.0.0
-
- ```
+```
+docker run -p 8080:8080 --name aaf-certservice-api nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-api:1.0.0
+```
### Running Docker container from docker-compose with EJBCA
- Docker-compose uses nexus image of certservice.
-
- ```
- docker-compose up
-
- ```
+Docker-compose uses nexus image of certservice.
+```
+docker-compose up
+```
+
+### Running with Helm
+1. Use environment/server with installed kubernetes and helm.
+2. Copy helm/aaf-cert-service directory to that environment.
+3. Enter that environment
+4. Run ```helm install ./aaf-cert-service```
### Health Check
- Browser:
-
- ```
- http://<localhost>:8080/actuator/health
+Browser:
+```
+http://<localhost>:8080/actuator/health
+```
- ```
-
- Curl:
-
- ```
- curl localhost:8080/actuator/health
-
- ```
+Curl:
+```
+curl localhost:8080/actuator/health
+```
Should return {"status":"UP"}
### Running CSITs
Pull csit repository
-
- ```
- https://gerrit.onap.org/r/admin/repos/integration/csit
-
- ```
+```
+https://gerrit.onap.org/r/admin/repos/integration/csit
+```
Go to created directory and run
-
- ```
- sudo ./run-csit.sh plans/aaf/cert-service
-
- ```
+```
+sudo ./run-csit.sh plans/aaf/cert-service
+```
### Logs locally
path:
-
- ```
- var/log/onap/aaf/certservice/
- ```
+```
+var/log/onap/aaf/certservice/
+```
### Logs in Docker container
- ```
- docker exec -it aaf-certservice-api bash
- ```
+```
+docker exec -it aaf-certservice-api bash
+```
path:
-
- ```
- cd /var/log/onap/aaf/certservice
- ```
+```
+cd /var/log/onap/aaf/certservice
+```
You should see:
audit.log error.log trace.log
### Sonar results
- ```
- https://sonarcloud.io/dashboard?id=onap_aaf-certservice
- ```
+```
+https://sonarcloud.io/dashboard?id=onap_aaf-certservice
+```
- ### Maven artifacts
- All maven artifacts are deployed under nexus uri:
- ```
- https://nexus.onap.org/content/repositories/snapshots/org/onap/aaf/certservice/
- ```
+### Maven artifacts
+All maven artifacts are deployed under nexus uri:
+```
+https://nexus.onap.org/content/repositories/snapshots/org/onap/aaf/certservice/
+```
- ### Docker artifacts
- All docker images are hosted under nexus3 uri:
- ```
- https://nexus3.onap.org/repository/docker.snapshot/v2/onap/org.onap.aaf.certservice.aaf-certservice-api/
- ```
+### Docker artifacts
+All docker images are hosted under nexus3 uri:
+```
+https://nexus3.onap.org/repository/docker.snapshot/v2/onap/org.onap.aaf.certservice.aaf-certservice-api/
+```
### RestAPI
API is described by Swagger ( OpenAPI 3.0 ) on endpoint /docs
( endpoint is defined in properties as springdoc.swagger-ui.path )
-
- ```
- http://localchost:8080/docs
-
- ```
+```
+http://localchost:8080/docs
+```
### Sonar results
- ```
- https://sonarcloud.io/dashboard?id=onap_aaf-certservice
- ```
+```
+https://sonarcloud.io/dashboard?id=onap_aaf-certservice
+```