Add support for render.com (#304)

Ivaylo-Bachvarov · web-flow · commit 21fc5bf902f0 · 2023-01-28T21:26:46.000+02:00
* Init a render file

* Update render.yaml

* Fix envs

* Fix redis

* Temp fix

* Fix

* Fix

* Fix

* Fix

* Add docker path

* Change healtcheck

* render.yaml

* Fix services region

* Add bin bash to entrypoints

* Improve render.yaml

* Executeables

* Add logging

* Fix web

* Change health check

* Add CELERY_BROKER_URL

* Deploy on master

* Add section for Render in the README.md

* Skip deploy_to_heroku job.

The project is not hosted on Heroku any more.
diff --git a/.github/workflows/django.yml b/.github/workflows/django.yml
@@ -64,7 +64,8 @@ jobs:
   deploy_to_heroku:
     runs-on: ubuntu-latest
     needs: build
-    if: github.ref == 'refs/heads/master'
+    # The project is currently hosted on render.com
+    if: false
     steps:
       - uses: actions/checkout@v3
         with:
diff --git a/README.md b/README.md
@@ -31,6 +31,7 @@
 - [Helpful commands for local development with docker-compose](#helpful-commands-for-local-development-with-docker-compose)
 - [Deployment](#deployment)
   * [Heroku](#heroku)
+  * [Render](#render)
   * [AWS ECS](#aws-ecs)
 - [Linters and Code Formatters](#linters-and-code-formatters)
 
@@ -53,7 +54,7 @@ Few important things:
   - `mypy` is ran as a build step in [`.github/workflows/django.yml`](.github/workflows/django.yml)
   - ⚠️ The provided configuration is quite minimal. **You should figure out your team needs & configure accordingly** - <https://mypy.readthedocs.io/en/stable/config_file.html>
 - It comes with GitHub Actions support, [based on that article](https://hacksoft.io/github-actions-in-action-setting-up-django-and-postgres/)
-- It can be easily deployed to Heroku or AWS ECS.
+- It can be easily deployed to Heroku, Render or AWS ECS.
 - It comes with an example list API, that uses [`django-filter`](https://django-filter.readthedocs.io/en/stable/) for filtering & pagination from DRF.
 - It comes with examples for writing tests with fakes & factories, based on the following articles - <https://www.hacksoft.io/blog/improve-your-tests-django-fakes-and-factories>, <https://www.hacksoft.io/blog/improve-your-tests-django-fakes-and-factories-advanced-usage>
 
@@ -296,16 +297,14 @@ docker-compose run django python manage.py shell
 
 ## Deployment
 
-This project is ready to be deployed either on **Heroku** or **AWS ECS**.
+This project is ready to be deployed either on **Heroku** **Render** or **AWS ECS**.
 
 ### Heroku
 
 Deploying a Python / Django application on Heroku is quite straighforward & this project is ready to be deployed.
 
 To get an overview of how Heroku deployment works, we recommend reading this first - <https://devcenter.heroku.com/articles/deploying-python>
 
-There's a current deployment that can be found here - <https://django-styleguide.hacksoft.io/>
-
 **Files related to Heroku deployment:**
 
 1. `Procfile`
@@ -332,6 +331,23 @@ On top of that, we've added `gunicorn.conf.py` with some example settings.
 1. Worker settings - <https://docs.gunicorn.org/(en/latest/settings.html#worker-processes>
 1. A brief description of the architecture of Gunicorn - <https://docs.gunicorn.org/en/latest/design.html>
 
+### Render
+
+To get an overview of how Render deployment works, we recommend reading this first - <https://render.com/docs/deploy-django>
+
+There's a current deployment that can be found here - <https://django-styleguide.hacksoft.io/>
+
+**Files related to Heroku deployment:**
+
+1. `render.yaml`
+    - Describes the setup. Also known as [Render Blueprint](https://render.com/docs/blueprint-spec)
+1. `docker/*_entrypoint.sh`
+    - Entrypoint for every different process type.
+1. `docker/production.Dockerfile`
+    - Dockerfile for production build.
+1. `requirements.txt`
+    - Heroku requires a root-level `requirements.txt`, so we've added that.
+
 ### AWS ECS
 
 _Coming soon_
@@ -397,4 +413,4 @@ build:
 In order to test if your local setup is up to date, you can either:
 
 1. Try making a commit, to see if `pre-commit` is going to be triggered.
-1. Or run `black --check .` and `isort --check .` in the project root directory.
+1. Or run `black --check .` and `isort --check .` in the project root directory.
diff --git a/docker/beats_entrypoint.sh b/docker/beats_entrypoint.sh
@@ -1,2 +1,3 @@
+#!/bin/bash
 echo "--> Starting beats process"
 celery -A styleguide_example.tasks worker -l info --without-gossip --without-mingle --without-heartbeat
diff --git a/docker/celery_entrypoint.sh b/docker/celery_entrypoint.sh
@@ -1,2 +1,3 @@
+#!/bin/bash
 echo "--> Starting celery process"
 celery -A styleguide_example.tasks beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler
diff --git a/docker/web_entrypoint.sh b/docker/web_entrypoint.sh
@@ -1,2 +1,3 @@
+#!/bin/bash
 echo "--> Starting web process"
-gunicorn config.wsgi:application -b 0.0.0.0:80
+gunicorn config.wsgi:application -b 0.0.0.0:$PORT
diff --git a/render.yaml b/render.yaml
@@ -0,0 +1,83 @@
+services:
+  - type: web
+    name: web
+    env: docker
+    region: frankfurt
+    plan: starter
+    branch: master
+    dockerCommand: ./docker/web_entrypoint.sh
+    dockerfilePath: ./docker/production.Dockerfile
+    numInstances: 1
+    healthCheckPath: /admin/login/
+    envVars:
+      - fromGroup: app-settings
+      - key: CELERY_BROKER_URL
+        fromService:
+          type: redis
+          name: redis
+          property: connectionString
+      - key: DATABASE_URL
+        fromDatabase:
+          name: postgres
+          property: connectionString
+
+  - type: worker
+    name: celery
+    env: docker
+    region: frankfurt
+    plan: starter
+    branch: master
+    dockerCommand: ./docker/celery_entrypoint.sh
+    dockerfilePath: ./docker/production.Dockerfile
+    numInstances: 1
+    envVars:
+      - fromGroup: app-settings
+      - key: CELERY_BROKER_URL
+        fromService:
+          type: redis
+          name: redis
+          property: connectionString
+      - key: DATABASE_URL
+        fromDatabase:
+          name: postgres
+          property: connectionString
+
+  - type: worker
+    name: beats
+    env: docker
+    region: frankfurt
+    plan: starter
+    branch: master
+    dockerCommand: ./docker/celery_entrypoint.sh
+    dockerfilePath: ./docker/production.Dockerfile
+    numInstances: 1
+    envVars:
+      - fromGroup: app-settings
+      - key: CELERY_BROKER_URL
+        fromService:
+          type: redis
+          name: redis
+          property: connectionString
+      - key: DATABASE_URL
+        fromDatabase:
+          name: postgres
+          property: connectionString
+
+  - type: redis
+    region: frankfurt
+    name: redis
+    plan: free
+    ipAllowList: []
+
+databases:
+  - name: postgres
+    region: frankfurt
+    plan: free
+    postgresMajorVersion: 14
+
+
+envVarGroups:
+  - name: app-settings
+    envVars:
+      - key: test
+        value: 1

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
	`1`	`+#!/bin/bash`
`1`	`2`	`echo "--> Starting beats process"`
`2`	`3`	`celery -A styleguide_example.tasks worker -l info --without-gossip --without-mingle --without-heartbeat`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
	`1`	`+#!/bin/bash`
`1`	`2`	`echo "--> Starting celery process"`
`2`	`3`	`celery -A styleguide_example.tasks beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler`