certServiceClient/README.md

   1 # Cert service client
   2
   3 ### Project building
   4 ```
   5 mvn clean package
   6 ```
   7
   8 ### Building Docker image manually
   9 Go to the certServiceClient subfolder and execute following statement (1.0.0-SNAPSHOT is related to a current project.version parameter):
  10 ```
  11 docker build --build-arg VERSION=1.0.0-SNAPSHOT -t onap/org.onap.aaf.certservice.aaf-certservice-client .
  12 ```
  13
  14 ### Install the package into the local repository
  15 ```
  16 mvn clean install
  17 ```
  18
  19 ### Building Docker image and  install the package into the local repository
  20 ```
  21 mvn clean install -P docker
  22 ```
  23
  24 ### Running Docker container local
  25 ```
  26 docker run --name aaf-certservice-client onap/org.onap.aaf.certservice.aaf-certservice-client
  27 ```
  28
  29 ### Running Docker container from nexus
  30 ```
  31 docker run --name aaf-certservice-client nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-client:1.0.0
  32 ```
  33
  34 ### Running client as standalone docker container
  35 ```
  36 AAFCERT_CLIENT_IMAGE=nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-client:latest
  37 DOCKER_ENV_FILE= <path to envfile>
  38 NETWORK_CERT_SERVICE= <docker network of cert service>
  39
  40 docker run --env-file $DOCKER_ENV_FILE --network $NETWORK_CERT_SERVICE $AAFCERT_CLIENT_IMAGE
  41 ```
  42 Sample Environment file:
  43 ```aidl
  44 #Client envs
  45 REQUEST_TIMEOUT=1000
  46 OUTPUT_PATH=/var/log
  47 CA_NAME=RA
  48 #Csr config envs
  49 COMMON_NAME=onap.org
  50 ORGANIZATION=Linux-Foundation
  51 ORGANIZATION_UNIT=ONAP
  52 LOCATION=San-Francisco
  53 STATE=California
  54 COUNTRY=US
  55 SANS=example.com:example2.com
  56 ```
  57
  58 ### Logs locally
  59
  60 path:
  61 ```
  62 var/log/onap/aaf/certservice-client/certservice-client.log
  63 ```
  64 ### Logs in Docker container
  65 ```
  66 docker logs aaf-certservice-client
  67 ```
  68 ###Exit codes
  69 ```
  70 0       Success
  71 1       Invalid client configuration
  72 2       Invalid CSR data
  73 3       Failed key pair generation
  74 4       Failed CSR generation
  75 5       API return unsuccessful response
  76 6       Problem with Http Client connection
  77 7       Failed PKCS12 conversion
  78 8       Failed Private Key to PEM Encoding
  79 ```