Add descrption of usage client container
authorTomasz Wrobel <tomasz.wrobel@nokia.com>
Mon, 9 Mar 2020 12:09:57 +0000 (13:09 +0100)
committerTomasz Wrobel <tomasz.wrobel@nokia.com>
Mon, 9 Mar 2020 13:50:49 +0000 (14:50 +0100)
Issue-ID: AAF-996
Signed-off-by: Tomasz Wrobel <tomasz.wrobel@nokia.com>
Change-Id: I34cafe8c7ad917a66a251692910d5f6188444c92

certServiceClient/README.md

index c1d56ad..092eb32 100644 (file)
@@ -31,6 +31,30 @@ docker run --name aaf-certservice-client onap/org.onap.aaf.certservice.aaf-certs
 docker run --name aaf-certservice-client nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-client:1.0.0
 ```
 
+### Running client as standalone docker container
+```
+AAFCERT_CLIENT_IMAGE=nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-client:latest
+DOCKER_ENV_FILE= <path to envfile>
+NETWORK_CERT_SERVICE= <docker network of cert service>
+docker run --env-file $DOCKER_ENV_FILE --network $NETWORK_CERT_SERVICE $AAFCERT_CLIENT_IMAGE
+```
+Sample Environment file:
+```aidl
+#Client envs
+REQUEST_TIMEOUT=1000
+OUTPUT_PATH=/var/log
+CA_NAME=RA
+#Csr config envs
+COMMON_NAME=onap.org
+ORGANIZATION=Linux-Foundation
+ORGANIZATION_UNIT=ONAP
+LOCATION=San-Francisco
+STATE=California
+COUNTRY=US
+SANS=example.com:example2.com
+```
+
 ### Logs locally
 
 path: 
@@ -40,4 +64,16 @@ var/log/onap/aaf/certservice-client/certservice-client.log
 ### Logs in Docker container
 ```
 docker logs aaf-certservice-client
+```
+###Exit codes
+```
+0      Success
+1      Invalid client configuration
+2      Invalid CSR data 
+3      Failed key pair generation
+4      Failed CSR generation
+5      API return unsuccessful response
+6      Problem with Http Client connection
+7      Failed PKCS12 conversion
+8      Failed Private Key to PEM Encoding
 ```
\ No newline at end of file