bullish/README.md
Ameya Shenoy d1e5d96fcf
fix: move secrets to a k8s secret
Signed-off-by: Ameya Shenoy <shenoy.ameya@gmail.com>
2021-02-13 09:37:06 +05:30

3.5 KiB

License: AGPL v3

Backend: Docker Pulls - Backend Docker Image Size Backend (tag)

Frontend Docker Pulls - Frontend Docker Image Size Frontend (tag)

Usage

  • Local setup is supported via Docker Compose

Development Architecture

docker-compose up -d

Build

  • Build images for dev
docker-compose build
  • Build images for prod
./prod-build.sh

Logging

To get the logs of all containers

docker logs -f

To get the logs of a particular container

docker logs -f container-name

Here container-name can be either of backend, frontend, redis, postgresql, rqworker or rqscheduler.

Debugging

  • To goto Django's shell to debug you may use
docker-compose exec backend python manage.py shell
  • To create migrations
docker-compose exec backend python manage.py makemigrations
  • To run migrate
docker-compose exec backend python manage.py migrate

Similarly all django commands can be run this way.

Deploy

The recommended way for deploy is on Kubernetes. You can find the related files

Production Architecture

in k8s directory.

Before deploy create a secret.yaml file in k8s/app, with base 64 encoded secrets. A sample file named sample-secret.yaml has been committed listing all the required variables. Change the secrets preset in the file before using it.

  • One time deploy
# Deploy ingress
kubectl apply -f k8s/ingress/ingress-https.yaml

# Deploy secrets
kubectl apply -f k8s/app/secret.yaml

# Deploy Postgres and Redis DB
kubectl apply -f k8s/app/redis.yaml
kubectl apply -f k8s/app/postgres.yaml

# Deploy Backend
kubectl apply -f k8s/app/backend.yaml
kubectl apply -f k8s/app/rqworker.yaml
kubectl apply -f k8s/app/rqscheduler.yaml

# Deploy Frontend
kubectl apply -f k8s/app/frontend.yaml
  • Subsequent deploys can be done by rolloing out a restart since all pods have a imagePullPolicy set to Always
# Push containers to Docker Hub and Deploy to K8s
./prod-deploy.sh

Contribution

Have better suggestions to optimize the image? Found some typos? Go ahead and send in a Pull Request! Contributions of any kind welcome!

License

The code in this repository has been released under the GNU Affero General Public License v3

Attributions