X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docker-compose%2FREADME.md;h=8cc6e57d591c4fc498792e65be54e7b67adce18e;hb=61957a55567c6dc68bec2f93b0b66ad397d5bae9;hp=11ccf6150b58f13845525161c85133feb8126945;hpb=15b93e7ad7db7372d51c4c1ad45f95d463aaaffc;p=cps.git diff --git a/docker-compose/README.md b/docker-compose/README.md index 11ccf6150..8cc6e57d5 100644 --- a/docker-compose/README.md +++ b/docker-compose/README.md @@ -2,6 +2,8 @@ ============LICENSE_START======================================================= Copyright (C) 2020 Pantheon.tech Modifications Copyright (C) 2020-2021 Nordix Foundation. + Modifications Copyright (C) 2021 Bell Canada. + Modifications Copyright (C) 2022 TechMahindra Ltd. ================================================================================ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -52,11 +54,12 @@ 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 + 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. @@ -85,6 +88,7 @@ Following command starts the application using JAR file: ```bash DB_HOST=localhost DB_USERNAME=cps DB_PASSWORD=cps CPS_USERNAME=cpsuser CPS_PASSWORD=cpsr0cks! \ + DMI_USERNAME=cpsuser DMI_PASSWORD=cpsr0cks! \ java -jar cps-application/target/cps-application-x.y.z-SNAPSHOT.jar ``` @@ -95,14 +99,17 @@ 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_USERNAME=cpsuser CPS_PASSWORD=cpsr0cks!` + CPS_USERNAME=cpsuser CPS_PASSWORD=cpsr0cks! + DMI_USERNAME=cpsuser DMI_PASSWORD=cpsr0cks!` ## Accessing services Swagger UI and Open API specifications are available to discover service endpoints and send requests. -* `http://localhost:/swagger-ui/index.html` -* `http://localhost:/v3/api-docs?group=cps-docket` +* `http://localhost:/swagger-ui.html` +* `http://localhost:/api-docs/cps-core/openapi.yaml` +* `http://localhost:/api-docs/cps-ncmp/openapi.yaml` +* `http://localhost:/api-docs/cps-ncmp/openapi-inventory.yaml` with being either `8080` if running the plain Java build or retrieved using following command if running from `docker-compose`: