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/OOM+Certification+Service
   8     ```
   9
  10 Project consists of three submodules:
  11 1. oom-certservice-api
  12 2. oom-certservice-client
  13 3. oom-truststore-merger
  14
  15 Detailed information about submodules can be found in ```README.md``` in their directories.
  16
  17 ### Project building
  18 ```
  19 mvn clean package
  20 ```
  21
  22 ### Install the packages into the local repository
  23 ```
  24 mvn clean install
  25 ```
  26
  27 ### Building Docker images and install packages into local repository
  28 ```
  29 mvn clean install -P docker
  30 or
  31 make build
  32 ```
  33
  34 ### Generating certificates
  35 There are example certificates already generated in certs/ directory.
  36 In order to generate new certificates, first remove existing ones.
  37 Then execute following command from certs(!) directory:
  38 ```
  39  make
  40 ```
  41
  42 ### Running Docker containers from docker-compose with EJBCA
  43 Docker-compose uses a local image of certservice-api and make run-client uses a local image of certservice-client
  44 Build docker images locally before running docker compose command.
  45 ```
  46 1. Build local images
  47 make build
  48 2. Start Cert Service with configured EJBCA
  49 make start-backend
  50 3. Run Cert Service Client
  51 make run-client
  52 4. Stop Cert Service and EJBCA
  53 make stop-backend
  54 ```
  55
  56 ### OOM 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/oom-platform-cert-service/certservice
  68 ```
  69
  70 ####Jenkins build
  71 https://jenkins.onap.org/view/CSIT/job/oom-platform-cert-service-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/oom/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.oom.certservice.oom-certservice-api/
  88 ```
  89
  90 ### How to release containers
  91 ```
  92 https://github.com/lfit/releng-global-jjb/blob/master/docs/jjb/lf-release-jobs.rst
  93 ```