Merge "Update README of CertServiceClient"
[oom/platform/cert-service.git] / certServiceClient / README.md
1 # Cert service client
2
3 ### Project building
4 ```
5 mvn clean package
6 ```
7     
8     
9 ### Install the package into the local repository
10 ```
11 mvn clean install
12 ```     
13     
14 ### Building Docker image and  install the package into the local repository
15 ```
16 mvn clean install -P docker
17 ```   
18
19 ### Nexus container image
20 ```
21 nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-client:latest
22 ```
23
24 ### Running local client application as standalone docker container
25 CertService API and client must be running in same network.
26
27 You need certificate and trust anchors (in JKS format) to connect to CertService API via HTTPS. Information how to generate truststore and keystore files you can find in CertService main README.
28
29 Information how to run you can find in CertService main README and official documentation, see [Read The Docs](https://onap-doc.readthedocs.io/projects/onap-aaf-certservice/en/latest/sections/usage.html)
30
31
32 ### Logs locally
33
34 path: 
35 ```
36 var/log/onap/aaf/certservice-client/certservice-client.log
37 ```    
38 ### Logs in Docker container
39 ```
40 docker logs aaf-certservice-client
41 ```
42 ###Exit codes
43 ```
44 0       Success
45 1       Invalid client configuration
46 2       Invalid CSR configuration 
47 3       Fail in key pair generation
48 4       Fail in  CSR generation
49 5       CertService HTTP unsuccessful response
50 6       Internal HTTP Client connection problem
51 7       Fail in PEM conversion
52 8       Fail in Private Key to PEM Encoding
53 9       Wrong TLS configuration
54 10      File could not be created