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 ### Generating certificates
  34 There are example certificates already generated in certs/ directory.
  35 In order to generate new certificates, first remove existing ones.
  36 Then execute following command from certs(!) directory:
  37 ```
  38  make
  39 ```
  40
  41 ### Running Docker containers from docker-compose with EJBCA
  42 Docker-compose uses a local image of certservice-api and make run-client uses a local image of certservice-client
  43 Build docker images locally before running docker compose command.
  44 ```
  45 1. Build local images
  46 make build
  47 2. Start Cert Service with configured EJBCA
  48 make start-backend
  49 3. Run Cert Service Client
  50 make run-client
  51 3. Remove client container
  52 make stop-client
  53 4. Stop Cert Service and EJBCA
  54 make stop-backend
  55 ```
  56
  57 ### Running API with Helm
  58 1. Use environment/server with installed kubernetes and helm.
  59 2. Copy certService/helm/aaf-cert-service directory to that environment.
  60 3. Enter that environment
  61 4. Run ```helm install ./aaf-cert-service```
  62
  63
  64 ### AAF CertService CSITs
  65 #### CSIT repository
  66 ```
  67 https://gerrit.onap.org/r/admin/repos/integration/csit
  68 ```
  69
  70 ####How to run tests locally
  71 1. Checkout CSIT repository
  72 2. Configure CSIT local environment
  73 3. Inside CSIT directory execute
  74 ```
  75 sudo ./run-csit.sh plans/aaf/certservice
  76 ```
  77
  78 ####Jenkins build
  79 https://jenkins.onap.org/view/CSIT/job/aaf-master-csit-certservice/
  80
  81 ### Sonar results
  82 ```
  83 https://sonarcloud.io/dashboard?id=onap_aaf-certservice
  84 ```
  85
  86 ### Maven artifacts
  87 All maven artifacts are deployed under nexus uri:
  88 ```
  89 https://nexus.onap.org/content/repositories/snapshots/org/onap/aaf/certservice/
  90 ```
  91
  92 ### Docker artifacts
  93 All docker images are hosted under nexus3 uri:
  94 ```
  95 https://nexus3.onap.org/repository/docker.snapshot/v2/onap/org.onap.aaf.certservice.aaf-certservice-api/
  96 ```