Update README file
authorNsukami Patrick <ndkpatt at gmail dot com>
Thu, 16 May 2019 08:11:21 +0000
changeset 98 cc77e09651c2
parent 97 cb8d771b5375
child 99 305c3f1242b6
Update README file
README.rst
--- a/README.rst	Thu May 16 08:10:14 2019 +0000
+++ b/README.rst	Thu May 16 08:11:21 2019 +0000
@@ -1,2 +1,47 @@
 Expense tracking application built on the CubicWeb framework.
 =============================================================
+
+Developping with docker
+=======================
+
+Assuming you have a postgresql running on your machine where you can connect
+with peer authentication, run "make dev" it will spawn an interactive shell
+inside a docker container with the code mounted in develop mode. It mean you
+can edit the code locally and run it in the container.
+
+Some useful commands::
+
+* ``cubicweb-ctl db-create -a fresh`` will create and initialize the
+  database
+
+* ``cubicweb-ctl pyramid -D -l info fresh`` will start the instance on
+  http://localhost:8080
+
+Deploying on kubernetes
+=======================
+
+To create the initial database from an existing empty database::
+
+   kubectl run -it fresh-dbcreate \
+      --env CW_DB_HOST=db \
+      --env CW_DB_USER=user \
+      --env CW_DB_PASSWORD=pass \
+      --env CW_DB_NAME=fresh \
+      --image=hub.extranet.logilab.fr/logilab/fresh --command -- \
+      cubicweb-ctl db-create --automatic --create-db=n fresh
+   kubectl delete deployment fresh-dbcreate
+
+
+Then generate a secret named "fresh" from where environment variables are set::
+
+   kubectl create secret generic fresh-env \
+      --from-literal CW_DB_HOST=db
+      --from-literal CW_DB_USER=user \
+      --from-literal CW_DB_PASSWORD=pass \
+      --from-literal CW_DB_NAME=fresh \
+      --from-literal CW_BASE_URL=https://fresh.example.com
+
+
+Then deploy fresh with::
+
+   kubectl apply -f deployment.yaml