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 four submodules:
  11 1. oom-certservice-api
  12 2. oom-certservice-client
  13 3. oom-certservice-post-processor
  14 4. oom-certservice-k8s-external-provider
  15
  16 Detailed information about submodules can be found in ```README.md``` in their directories.
  17
  18 ### Project building
  19 ```
  20 mvn clean package
  21 ```
  22
  23 ### Install the packages into the local repository
  24 ```
  25 mvn clean install
  26 ```
  27
  28 ### Building Docker images and install packages into local repository
  29 ```
  30 mvn clean install -P docker
  31 or
  32 make build
  33 ```
  34
  35 ### Generating certificates
  36 There are example certificates already generated in certs/ directory.
  37 In order to generate new certificates, first remove existing ones.
  38 Then execute following command from certs(!) directory:
  39 ```
  40  make
  41 ```
  42
  43 ### Running Docker containers from docker-compose with EJBCA
  44 Docker-compose uses a local image of certservice-api and make run-client uses a local image of certservice-client
  45 Build docker images locally before running docker compose command.
  46 ```
  47 1. Build local images
  48 make build
  49 2. Start Cert Service with configured EJBCA
  50 make start-backend
  51 3. Run Cert Service Client
  52 make run-client
  53 4. Stop Cert Service and EJBCA
  54 make stop-backend
  55 ```
  56
  57 ### OOM CertService CSITs
  58 #### CSIT repository
  59 ```
  60 https://gerrit.onap.org/r/admin/repos/integration/csit
  61 ```
  62
  63 ####How to run tests locally
  64 1. Checkout CSIT repository
  65 2. Configure CSIT local environment
  66 3. Inside CSIT directory execute
  67 ```
  68 sudo ./run-csit.sh plans/oom-platform-cert-service/certservice
  69 ```
  70
  71 ####Jenkins build
  72 https://jenkins.onap.org/view/CSIT/job/oom-platform-cert-service-master-csit-certservice/
  73
  74 ### Sonar results
  75 ```
  76 https://sonarcloud.io/dashboard?id=onap_oom-platform-cert-service
  77 ```
  78
  79 ### Maven artifacts
  80 All maven artifacts are deployed under nexus uri:
  81 ```
  82 https://nexus.onap.org/content/repositories/snapshots/org/onap/oom/certservice/
  83 ```
  84
  85 ### Docker artifacts
  86 All docker images are hosted under nexus3 uri:
  87 ```
  88 https://nexus3.onap.org/repository/docker.snapshot/v2/onap/org.onap.oom.certservice.oom-certservice-api/
  89 ```
  90
  91 ### How to release containers
  92 ```
  93 https://github.com/lfit/releng-global-jjb/blob/master/docs/jjb/lf-release-jobs.rst
  94 ```