X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docker-compose%2FREADME.md;h=623968f33b2e1fc4ae9b626329be2096f7b6de1f;hb=ee1ca9a51fb57c33814e21785ce98f8b563f44f8;hp=3d68c3ff4bb0a861ee283423acff26b5e136fef0;hpb=b1ccfce0b229d544bf08b1c197a2365b40369796;p=cps.git

diff --git a/docker-compose/README.md b/docker-compose/README.md
index 3d68c3ff4..623968f33 100644
--- a/docker-compose/README.md
+++ b/docker-compose/README.md
@@ -1,34 +1,120 @@
-# Docker Compose deployment example for local enviroments, CPS deployment is done via OOM
+<!--
+  ============LICENSE_START=======================================================
+   Copyright (C) 2020 Pantheon.tech
+   Modifications Copyright (C) 2020-2021 Nordix Foundation.
+   Modifications Copyright (C) 2021 Bell Canada.
+  ================================================================================
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
 
-To run the application locally using `docker-compose`, execute following command from this `docker-compose` folder:
+       http://www.apache.org/licenses/LICENSE-2.0
 
-Compile without generating the docker images
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+  SPDX-License-Identifier: Apache-2.0
+  ============LICENSE_END=========================================================
+-->
+
+# Building and running CPS locally
+
+## Building Java Archive only
+
+Following command builds all Java components to `cps-application/target/cps-application-x.y.z-SNAPSHOT.jar` JAR file
+without generating any docker images:
+
+```bash
+mvn clean install -Pcps-docker -Pncmp-docker -Pcps-ncmp-docker -Djib.skip
+```
+
+## Building Java Archive and Docker images
+
+* Following command builds the JAR file and also generates the Docker image for all CPS components:
 
 ```bash
-mvn clean install -Pcps-docker -Pxnf-docker -Pcps-xnf-docker -Djib.skip
+mvn clean install -Pcps-docker -Pncmp-docker -Pcps-ncmp-docker
 ```
 
-Generate the docker images
+* Following command builds the JAR file and generates the Docker image for specified CPS component:
+  (with `<docker-profile>` being one of `cps-docker`, `ncmp-docker` or `cps-ncmp-docker`):
 
 ```bash
-mvn clean install -Pcps-docker -Pxnf-docker -Pcps-xnf-docker
+mvn clean install -P<docker-profile>
 ```
 
-for generate a specific type of docker images
+## Running Docker containers
+
+`docker-compose/docker-compose.yml` file is provided to be run with `docker-compose` tool and images previously built.
+It starts both Postgres database and CPS services.
+
+1. Edit `docker-compose.yml`
+   1. uncomment desired service to be deployed, by default `cps-and-ncmp` is enabled. You can comment it and uncomment `cps-standalone` or `ncmp-standalone`.
+   2. To send data-updated events to kafka,
+      * uncomment the `zookeeper` and `kafka` services.
+      * uncomment environment variables
+        * `notification.data-updated.enabled: 'true'`
+        * `KAFKA_BOOTSTRAP_SERVER: kafka:9092`
+        * `NOTIFICATION_DATASPACE_FILTER_PATTERNS: '.*'`
+2. Execute following command from `docker-compose` folder:
 
+Use one of the below version type that has been generated in the local system's docker image list after the build.
 ```bash
-mvn clean install -Pcps-docker
+VERSION=latest DB_USERNAME=cps DB_PASSWORD=cps docker-compose up -d
+or
+VERSION=<version> DB_USERNAME=cps DB_PASSWORD=cps docker-compose up -d
 ```
 
-Run the containers
+## Running or debugging Java built code
+
+Before running CPS, a Postgres database instance needs to be started. This can be done with following
+command:
 
 ```bash
-VERSION=0.0.1-SNAPSHOT DB_HOST=dbpostgresql DB_USERNAME=cps DB_PASSWORD=cps docker-compose up -d
+docker run --name postgres -p 5432:5432 -d \
+  -e POSTGRES_DB=cpsdb -e POSTGRES_USER=cps -e POSTGRES_PASSWORD=cps \
+  postgres:12.4-alpine
 ```
 
-Run application from Intellj IDE
+Then CPS can be started either using a Java Archive previously built or directly from Intellij IDE.
+
+### Running from Jar Archive
+
+Following command starts the application using JAR file:
+
+```bash
+DB_HOST=localhost DB_USERNAME=cps DB_PASSWORD=cps CPS_CORE_USERNAME=cpsuser CPS_CORE_PASSWORD=cpsr0cks! \
+  java -jar cps-application/target/cps-application-x.y.z-SNAPSHOT.jar
+```
+
+### Running from IntelliJ IDE
+
+Here are the steps to run or debug the application from Intellij:
+
+1. Enable the desired maven profile form Maven Tool Window
+2. Run a configuration from `Run -> Edit configurations` with following settings:
+   * `Environment variables`: `DB_HOST=localhost;DB_USERNAME=cps;DB_PASSWORD=cps
+                                CPS_CORE_USERNAME=cpsuser CPS_CORE_PASSWORD=cpsr0cks!`
+
+## Accessing services
+
+Swagger UI and Open API specifications are available to discover service endpoints and send requests.
+
+* `http://localhost:<port-number>/swagger-ui.html`
+* `http://localhost:<port-number>/api-docs/cps-core/openapi.yaml`
+* `http://localhost:<port-number>/api-docs/cps-ncmp/openapi.yaml`
+* `http://localhost:<port-number>/api-docs/cps-ncmp/openapi-inventory.yaml`
+
+with <port-number> being either `8080` if running the plain Java build or retrieved using following command
+if running from `docker-compose`:
+
+```bash
+docker inspect \
+  --format='{{range $p, $conf := .NetworkSettings.Ports}} {{$p}} -> {{(index $conf 0).HostPort}} {{end}}' \
+  <cps-docker-container>
+```
 
-you need first to enable the maven profile desired under tab Maven
-then go to Run -> Edit configurations
- 1- Working directory -> select docker-compose folder e.g.  ~/workspace/onap/cps/docker-compose/
- 2- Enviroment variables -> add variables configuration e.g. DB_HOST=127.0.0.1;DB_USERNAME=cps;DB_PASSWORD=cps
\ No newline at end of file
+Enjoy CPS !