summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorToine Siebelink <toine.siebelink@est.tech>2020-11-05 13:03:59 +0000
committerGerrit Code Review <gerrit@onap.org>2020-11-05 13:03:59 +0000
commitc61942632e69165266c8a8834073d993b8b5c34e (patch)
tree5f36a145d1e3b80707b7ed764d6beb4edc1cbdfc
parent3e28a30ecf58f1000159683b8aef78d31bddf981 (diff)
parentffc97e085589fae2e020705910b312d1307627e3 (diff)
Merge "Verify new CPS project setup - Commit code through Nordix - Check if CI jobs are triggered"
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..d1bf49d8cf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# Configuration Persistence Service
+
+This folder contains all files for
+[Configuration Persistence Service](https://wiki.onap.org/pages/viewpage.action?pageId=81406119).
+
+The code here is related to CPS POC, then it must be kept self contained in this cps folder to prevent any impact on
+current ccsdk components and to be ready to be moved in its own repo once CPS becomes a standalone project.
+
+
+## Running Locally
+
+* Run a postgres container instance and create `cpsdb' database:
+
+```
+CREATE USER cps WITH PASSWORD 'cps';
+CREATE DATABASE cpsdb OWNER cps;
+```
+
+* Build (from cps root folder)
+
+```bash
+mvn clean package
+```
+
+* Run (from cps root folder)
+
+```bash
+java -DDB_HOST=localhost -DDB_USERNAME=cps -DDB_PASSWORD=cps -jar cps-rest/target/cps-rest-0.0.1-SNAPSHOT.jar
+```
+
+* Browse
+ * [Swagger UI](http://localhost:8080/swagger-ui/index.html)
+ * OpenAPI Specification in [JSON](http://localhost:8080/api/cps/openapi.json)
+ or [YAML](http://localhost:8080/api/cps/openapi.yaml) format