<!--
============LICENSE_START=======================================================
Copyright (C) 2020 Pantheon.tech
- Modifications (C) 2020-2021 Nordix Foundation.
+ 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.
`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` and uncomment desired service to be deployed, by default `cps-and-ncmp`
- is enabled. You can comment it and uncomment `cps-standalone` or `ncmp-standalone`.
+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.
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
-```
+```
## Running or debugging Java built code
```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
```
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:<port-number>/swagger-ui/index.html`
-* `http://localhost:<port-number>/v3/api-docs?group=cps-docket`
+* `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`: