X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=certService%2FREADME.md;h=645ca06129ed22f7536048c4a7eceb1b24893383;hb=1740a80eab8ebb9598b7e9a19632a17491811be2;hp=4780a904269720800446b13f5edc7ce76bbf4aed;hpb=7bf4e60bca87ae68d37a7632fa5c51e16608574e;p=oom%2Fplatform%2Fcert-service.git diff --git a/certService/README.md b/certService/README.md index 4780a904..645ca061 100644 --- a/certService/README.md +++ b/certService/README.md @@ -45,7 +45,7 @@ docker build --build-arg VERSION=1.0.0-SNAPSHOT -t onap/org.onap.aaf.certservice mvn clean install ``` -### Building Docker image and install the package into the local repository +### Building Docker image and install the package into local repository ``` mvn clean install -P docker ``` @@ -59,19 +59,7 @@ docker run -p 8080:8080 --name aaf-certservice-api --mount type=bind,source=//cmpServers.json,target=/etc/onap/aaf/certservice/cmpServers.json nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-api:1.0.0 ``` - -### Running Docker container from docker-compose with EJBCA -Docker-compose uses nexus image of certservice. -``` -docker-compose up -``` -### Running with Helm -1. Use environment/server with installed kubernetes and helm. -2. Copy helm/aaf-cert-service directory to that environment. -3. Enter that environment -4. Run ```helm install ./aaf-cert-service``` - ### Health Check Browser: ``` @@ -84,23 +72,6 @@ curl localhost:8080/actuator/health ``` Should return {"status":"UP"} -### AAF CertService CSITs -#### CSIT repository -``` -https://gerrit.onap.org/r/admin/repos/integration/csit -``` - -####How to run tests locally -1. Checkout CSIT repository -2. Configure CSIT local environment -3. Inside CSIT directory execute -``` -sudo ./run-csit.sh plans/aaf/certservice -``` - -####Jenkins build -https://jenkins.onap.org/view/CSIT/job/aaf-master-csit-certservice/ - ### Logs locally path: @@ -117,24 +88,7 @@ path: cd /var/log/onap/aaf/certservice ``` You should see: -audit.log error.log trace.log - -### Sonar results -``` -https://sonarcloud.io/dashboard?id=onap_aaf-certservice -``` - -### Maven artifacts -All maven artifacts are deployed under nexus uri: -``` -https://nexus.onap.org/content/repositories/snapshots/org/onap/aaf/certservice/ -``` - -### 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/ -``` +audit.log error.log debug.log ### RestAPI API is described by Swagger ( OpenAPI 3.0 ) on endpoint /docs @@ -143,7 +97,6 @@ API is described by Swagger ( OpenAPI 3.0 ) on endpoint /docs http://localchost:8080/docs ``` -### Sonar results -``` -https://sonarcloud.io/dashboard?id=onap_aaf-certservice -``` +### OpenAPI +during project building yaml file with openAPI 3.0 documentation is generated in target directory with name api-docs.yaml +file OpenAPI.yaml located in certService directory must be update be hand if needed