Merge pull request #148 from TanmoySG/readme-change

Fix docker image issues and update migration documentation

README.md

@@ -3,6 +3,10 @@
 wunderDb is a JSON-based in-memory Data Store.
 <!--  For persistent data storage wunderDb loads data from and dumps to filesystem at the start and end of it's lifecycle (startup and shutdown). -->
 
+### Notice
+
+We've fixed the issues with the docker image where graceful shut-down and data persistence were not working while deploying to kubernetes. Please use [wunderDb `v1.5.0`](https://github.com/TanmoySG/wunderDB/pkgs/container/wunderdb/195399419?tag=v1.5.0) and above for better kubernetes support. Thanks!
+
 ## Quickstart
 
 To run wunderDb, download the `wunderdb` binary of the [latest release](https://github.com/TanmoySG/wunderDB/releases) based on your OS and Architecture. Once downloaded, run the binary to start wunderdb.
@@ -53,9 +57,9 @@ wunderDb APIs are completely RESTful and all actions can be performed using simp
 
 - [`wdb-go`](https://github.com/TanmoySG/wdb-go) Go client library for wunderDb. [ [Documentation](https://github.com/TanmoySG/wdb-go#readme) ]
 
-## Migrations
+<!-- ## Migrations
 
-Certain versions of wdb introduces model changes that need additional migrations from the wdb instance admin. See the [`MIGRATION.md`](./documentation/MIGRATION.md) documentation.
+Certain versions of wdb introduces model changes that need additional migrations from the wdb instance admin. See the [`MIGRATION.md`](./documentation/MIGRATION.md) documentation. -->
 
 ## wunderDB-Retro
 

docker-compose.source.yml

@@ -15,9 +15,6 @@ services:
       - PERSISTANT_STORAGE_PATH=/wfs
       - ADMIN_ID=${ADMIN_ID}
       - ADMIN_PASSWORD=${ADMIN_PASSWORD}
-      # optional wdb-tools usage field - pass without quotes ("")
-      - USE_TOOL=true
-      - TOOL_INSTRUCTION=/tools/migrate_databases_primary_key
     volumes:
       - ./local_wdb/wfs:/wfs
       - ./local_wdb/txlogs:/root/wdb/txlogs

docker-compose.yml

@@ -11,9 +11,6 @@ services:
       - PERSISTANT_STORAGE_PATH=/wfs
       - ADMIN_ID=${ADMIN_ID}
       - ADMIN_PASSWORD=${ADMIN_PASSWORD}
-      # optional wdb-tools usage field - pass without quotes ("")
-      - USE_TOOL=true
-      - TOOL_INSTRUCTION=/tools/migrate_databases_primary_key
     volumes:
       - ./local_wdb/wfs:/wfs
       - ./local_wdb/txlogs:/root/wdb/txlogs

documentation/MIGRATION.md

@@ -1,5 +1,7 @@
 # Migrations
 
+With recent changes in the docker image we've discontinued the use of `wdb-tools`. Migration documentation and mechanism witll be updated soon.
+<!-- 
 This document contains background details and instructions to migrate to new models and breaking changes.
 
 ## Migrating existing roles to add `hidden` field
@@ -36,4 +38,4 @@ wdb-tools are commandline tools built to make life easy! To use wdb-tools,
 Simillar to Option-2, to use wdb-tools in wdb-container, you just need to export the `TOOL_INSTRUCTION` and `USE_TOOL` variables. The wdb-image comes pre-packed with the wdb-tools so you dont need to clone it. The tools are stored in the `/tools` directory in wdb-image/container.
 
 - The docker-compose files have the required values set, to use the tool, you just need to change the value of `USE_TOOL` to true (set as false in the compose file)
-- This will run the tool inside the container and start the wdb-server
+- This will run the tool inside the container and start the wdb-server -->