X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=certServiceClient%2FREADME.md;h=63d9780b481d7ab306ac8a008162e57168fa5bb3;hb=8ceb792397f1581352f2f67cd5f4a958ac644ae1;hp=849db4f1230e25dc12702908e8bd819df0b79423;hpb=2cb675d164848fbe327344b26b9501a038aae79c;p=oom%2Fplatform%2Fcert-service.git diff --git a/certServiceClient/README.md b/certServiceClient/README.md index 849db4f1..63d9780b 100644 --- a/certServiceClient/README.md +++ b/certServiceClient/README.md @@ -18,46 +18,26 @@ mvn clean install -P docker ### Nexus container image ``` -nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-client:latest +nexus3.onap.org:10001/onap/org.onap.oom.platform.cert-service.oom-certservice-client:latest ``` ### Running local client application as standalone docker container -``` -AAFCERT_CLIENT_IMAGE=onap/org.onap.aaf.certservice.aaf-certservice-client -DOCKER_ENV_FILE= -NETWORK_CERT_SERVICE= - -docker run --name aaf-certservice-client --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 -KEYSTORE_PATH=/etc/onap/aaf/certservice/certs/certServiceClient-keystore.jks -KEYSTORE_PASSWORD=secret -TRUSTSTORE_PATH=/etc/onap/aaf/certservice/certs/truststore.jks -TRUSTSTORE_PASSWORD=secret -``` +CertService API and client must be running in same network. + +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. + +Information how to run you can find in CertService main README and official documentation, see [Read The Docs](https://docs.onap.org/projects/onap-oom-platform-cert-service/en/latest/sections/usage.html) + ### Logs locally path: ``` -var/log/onap/aaf/certservice-client/certservice-client.log +var/log/onap/oom/certservice-client/certservice-client.log ``` ### Logs in Docker container ``` -docker logs aaf-certservice-client +docker logs oom-certservice-client ``` ###Exit codes ``` @@ -68,6 +48,7 @@ docker logs aaf-certservice-client 4 Fail in CSR generation 5 CertService HTTP unsuccessful response 6 Internal HTTP Client connection problem -7 Fail in PKCS12 conversion +7 Fail in PEM conversion 8 Fail in Private Key to PEM Encoding 9 Wrong TLS configuration +10 File could not be created