README.md

   1 # Cert service
   2
   3 ### General description
   4
   5 More information about the project and all its functionalities you can find under the wiki page:
   6     ```
   7     https://wiki.onap.org/display/DW/AAF+Certification+Service
   8     ```
   9
  10 Project consists of two submodules:
  11 1. aaf-certservice-api
  12 2. aaf-certservice-client
  13
  14 Detailed information about submodules can be found in ```README.md``` in their directories.
  15
  16 ### Project building
  17 ```
  18 mvn clean package
  19 ```
  20
  21 ### Install the packages into the local repository
  22 ```
  23 mvn clean install
  24 ```
  25
  26 ### Building Docker images and install packages into local repository
  27 ```
  28 mvn clean install -P docker
  29 or
  30 make build
  31 ```
  32
  33 ### Running Docker containers from docker-compose with EJBCA
  34 Docker-compose uses a local image of certservice-api and make run-client uses a local image of certservice-client
  35 Build docker images locally before running docker compose command.
  36 ```
  37 1. Build local images
  38 make build
  39 2. Start Cert Service with configured EJBCA
  40 make start-backend
  41 3. Run Cert Service Client
  42 make run-client
  43 3. Remove client container
  44 make stop-client
  45 4. Stop Cert Service and EJBCA
  46 make stop-backend
  47 ```
  48
  49 ### Running API with Helm
  50 1. Use environment/server with installed kubernetes and helm.
  51 2. Copy certService/helm/aaf-cert-service directory to that environment.
  52 3. Enter that environment
  53 4. Run ```helm install ./aaf-cert-service```
  54
  55
  56 ### AAF CertService CSITs
  57 #### CSIT repository
  58 ```
  59 https://gerrit.onap.org/r/admin/repos/integration/csit
  60 ```
  61
  62 ####How to run tests locally
  63 1. Checkout CSIT repository
  64 2. Configure CSIT local environment
  65 3. Inside CSIT directory execute
  66 ```
  67 sudo ./run-csit.sh plans/aaf/certservice
  68 ```
  69
  70 ####Jenkins build
  71 https://jenkins.onap.org/view/CSIT/job/aaf-master-csit-certservice/
  72
  73 ### Sonar results
  74 ```
  75 https://sonarcloud.io/dashboard?id=onap_aaf-certservice
  76 ```
  77
  78 ### Maven artifacts
  79 All maven artifacts are deployed under nexus uri:
  80 ```
  81 https://nexus.onap.org/content/repositories/snapshots/org/onap/aaf/certservice/
  82 ```
  83
  84 ### Docker artifacts
  85 All docker images are hosted under nexus3 uri:
  86 ```
  87 https://nexus3.onap.org/repository/docker.snapshot/v2/onap/org.onap.aaf.certservice.aaf-certservice-api/
  88 ```