optimal architecture for multitenant application on django

by

We built a multitenancy platform using the following architecture. I hope you can find some useful hints.

  • Each tenant gets sub-domain (t1.example.com)
  • Using url rewriting the requests for the Django application are rewritten to something like example.com/t1
  • All url definitions are prefixed with something like (r'^(?P<tenant_id>[\w\-]+)
  • A middleware processes and consumes the tenant_id and adds it to the request (e.g. request.tenant=”t1″)
  • Now you have the current tenant available in each view without specifying the tenant_id argument every view
  • In some cases you don’t have the request available. I solved this issue by binding the tenant_id to the current thread (similar to the current language using threading.local )
  • Create decorators (e.g a tenant aware login_required), middlewares or factories to protect views and select the right models
  • Regarding to the databases I used two different scenarios:
    • Setup multiple databases and configure a routing according to current tenant. I used this first but switched to one database after about one year. The reasons were the following:
      • We didn’t need a high secure solution to separate the data
      • The different tenants used almost all the same models
      • We had to manage a lot of databases (and didn’t built an easy update/migration process)
    • Use one database with some simple mapping tables for i.e. users and different models. To add additional and tenant specific model fields we use model inheritance.

Regarding the environment we use the following setup:

From my point of view this setup has the following pro’s and con’s:

Pro:

  • One application instance knowing the current tenant
  • Most parts of the project don’t have to bother with tenant specific issues
  • Easy solution for sharing entities between all tenants (e.g. messages)

Contra:

  • One quite large database
  • Some very similar tables due to the model inheritance
  • Not secured on the database layer

Of course the best architecture strongly depends on your requirements as number of tenants, the delta of your models, security requirements and so on.

Update: As we reviewed our architecture, I suggest to not rewrite the URL as indicated in point 2-3. I think a better solutions is to put the tenant_id as a Request Header and extract (point 4) the tenant_id out of the request with something like request.META.get('TENANT_ID', None). This way you get neutral URLs and it’s much easier to use Django built-in functions (e.g. {% url ...%} or reverse()) or external apps.

More Related Contents:

  1. Hi I am new to Django Framework.getting error :No Module Named
  2. How to upload a file in Django? [closed]
  3. How do I do an OR filter in a Django query?
  4. Django rest framework, use different serializers in the same ModelViewSet
  5. Setting the selected value on a Django forms.ChoiceField
  6. Load a Django template tag library for all views by default
  7. Output Django queryset as JSON
  8. Prevent Django SQLite db from being overwritten while pushing to Heroku
  9. Django: How can I call a view function from template?
  10. The right place to keep my signals.py file in a Django project
  11. How do you use the django-filter package with a list of parameters?
  12. How to Unit test with different settings in Django?
  13. django – why is the request.POST object immutable?
  14. Heroku – Handling static files in Django app
  15. django – get() returned more than one topic
  16. django: Purpose of django.utils.functional.SimpleLazyObject?
  17. Django, request.user is always Anonymous User
  18. Django migration error :you cannot alter to or from M2M fields, or add or remove through= on M2M fields
  19. Django CSRF framework cannot be disabled and is breaking my site
  20. django filter older than day(s)?
  21. Django comparing model instances for equality
  22. django form resubmitted upon refresh
  23. send_mass_emails with EmailMultiAlternatives
  24. Django REST Framework image upload
  25. How to iterate over nested dictionaries in django templates
  26. Docker-compose with django could not translate host name “db” to address: Name or service not known
  27. Django on Google App Engine
  28. Django static files on heroku
  29. Django: dynamic database file
  30. User groups and permissions

Leave a Comment