Code Review
/
oom
/
platform
/
cert-service.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Merge "[OOM CERT-SERVICE DOCS] Align release notes to template"
[oom/platform/cert-service.git]
/
README.md
diff --git
a/README.md
b/README.md
index
8fabbee
..
0f4531f
100644
(file)
--- a/
README.md
+++ b/
README.md
@@
-4,12
+4,14
@@
More information about the project and all its functionalities you can find under the wiki page:
```
More information about the project and all its functionalities you can find under the wiki page:
```
- https://wiki.onap.org/display/DW/
AAF
+Certification+Service
+ https://wiki.onap.org/display/DW/
OOM
+Certification+Service
```
```
-Project consists of two submodules:
-1. aaf-certservice-api
-2. aaf-certservice-client
+Project consists of four submodules:
+1. oom-certservice-api
+2. oom-certservice-client
+3. oom-certservice-post-processor
+4. oom-certservice-k8s-external-provider
Detailed information about submodules can be found in ```README.md``` in their directories.
Detailed information about submodules can be found in ```README.md``` in their directories.
@@
-30,6
+32,14
@@
or
make build
```
make build
```
+### Generating certificates
+There are example certificates already generated in certs/ directory.
+In order to generate new certificates, first remove existing ones.
+Then execute following command from certs(!) directory:
+```
+ make
+```
+
### Running Docker containers from docker-compose with EJBCA
Docker-compose uses a local image of certservice-api and make run-client uses a local image of certservice-client
Build docker images locally before running docker compose command.
### Running Docker containers from docker-compose with EJBCA
Docker-compose uses a local image of certservice-api and make run-client uses a local image of certservice-client
Build docker images locally before running docker compose command.
@@
-40,20
+50,11
@@
make build
make start-backend
3. Run Cert Service Client
make run-client
make start-backend
3. Run Cert Service Client
make run-client
-3. Remove client container
-make stop-client
4. Stop Cert Service and EJBCA
make stop-backend
```
4. Stop Cert Service and EJBCA
make stop-backend
```
-
-### Running API with Helm
-1. Use environment/server with installed kubernetes and helm.
-2. Copy certService/helm/aaf-cert-service directory to that environment.
-3. Enter that environment
-4. Run ```helm install ./aaf-cert-service```
-
-###
AAF
CertService CSITs
+###
OOM
CertService CSITs
#### CSIT repository
```
https://gerrit.onap.org/r/admin/repos/integration/csit
#### CSIT repository
```
https://gerrit.onap.org/r/admin/repos/integration/csit
@@
-64,25
+65,30
@@
https://gerrit.onap.org/r/admin/repos/integration/csit
2. Configure CSIT local environment
3. Inside CSIT directory execute
```
2. Configure CSIT local environment
3. Inside CSIT directory execute
```
-sudo ./run-csit.sh plans/
aaf
/certservice
+sudo ./run-csit.sh plans/
oom-platform-cert-service
/certservice
```
####Jenkins build
```
####Jenkins build
-https://jenkins.onap.org/view/CSIT/job/
aaf
-master-csit-certservice/
+https://jenkins.onap.org/view/CSIT/job/
oom-platform-cert-service
-master-csit-certservice/
### Sonar results
```
### Sonar results
```
-https://sonarcloud.io/dashboard?id=onap_
aaf-cert
service
+https://sonarcloud.io/dashboard?id=onap_
oom-platform-cert-
service
```
### Maven artifacts
All maven artifacts are deployed under nexus uri:
```
```
### Maven artifacts
All maven artifacts are deployed under nexus uri:
```
-https://nexus.onap.org/content/repositories/snapshots/org/onap/
aaf
/certservice/
+https://nexus.onap.org/content/repositories/snapshots/org/onap/
oom
/certservice/
```
### Docker artifacts
All docker images are hosted under nexus3 uri:
```
```
### Docker artifacts
All docker images are hosted under nexus3 uri:
```
-https://nexus3.onap.org/repository/docker.snapshot/v2/onap/org.onap.aaf.certservice.aaf-certservice-api/
-```
\ No newline at end of file
+https://nexus3.onap.org/repository/docker.snapshot/v2/onap/org.onap.oom.certservice.oom-certservice-api/
+```
+
+### How to release containers
+```
+https://github.com/lfit/releng-global-jjb/blob/master/docs/jjb/lf-release-jobs.rst
+```