This package provides multi-tenant support for Kiwi TCMS and is a wrapper around django-tenants. You can use it to host different organizations on the same application server or host multiple product instances used by different teams. Each tenant is able to see only the information created by themselves.
IMPORTANT: multi-tenancy is backed by PostgreSQL schemas! It will not work with a different database backend.
WARNING: current tenant is decided based on the FQDN by which you are accessing Kiwi TCMS!
The following changes need to be introduced into a downstream Docker image or your Python virtualenv where the main Kiwi TCMS instance is hosted:
pip install kiwitcms-tenants
then make sure KIWI_TENANTS_DOMAIN
ENV variable is specified !!! The rest of the settings are installed into tcms_settings_dir/multi_tenant.py
and Kiwi TCMS will pick them up automatically!
When starting your multi-tenant Kiwi TCMS instance for the first time you also need to create information about the so called public tenant. That is the default tenant on which your application runs:
./manage.py create_tenant --schema_name public
--name "Public tenant"
--paid_until 2050-12-31
--on_trial False
--owner_id 1
--organization "Testing department"
--domain-domain public.tenants.example.org
--domain-is_primary True
WARNING: schema_name public is special, the rest is up to you. owner_id is usually the ID of the first superuser in the database which means you must have executed createsuperuser
first!
You can use create_tenant afterwards to create other tenants for various teams or projects. Non-public tenants can also be created via the web interface as well.
You need wildcard DNS resolution to be configured for *.tenants.example.org
!
If using AWS Route 53 create an A record with Name==*.tenants
for the example.org
domain and point it to the IP address of your Kiwi TCMS instance.
Once DNS has been configured you should be able to query for various domains with tools like dig
and nslookup
:
$ dig public.tenant.kiwitcms.org
; <<>> DiG 9.11.4-P2-RedHat-9.11.4-12.P2.el7 <<>> public.tenant.kiwitcms.org
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 58543
;; flags: qr rd ra; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 1
;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 4096
;; QUESTION SECTION:
;public.tenant.kiwitcms.org. IN A
;; ANSWER SECTION:
public.tenant.kiwitcms.org. 36 IN A 100.24.231.234
;; Query time: 35 msec
;; SERVER: 10.38.5.26#53(10.38.5.26)
;; WHEN: Tue Nov 19 14:04:09 EET 2019
;; MSG SIZE rcvd: 71
$ nslookup linux.tenant.kiwitcms.org
Server: 10.38.5.26
Address: 10.38.5.26#53
Non-authoritative answer:
Name: linux.tenant.kiwitcms.org
Address: 100.24.231.234
All sub-domains should resolve to the same IP address!
See Migrating Single-Tenant to Multi-Tenant section in the official django-tenants documentation! It has been contributed by the Kiwi TCMS team and that was the procedure we've used to migrate the previous demo website (ST) to its new MT version!
- Slightly adjust default values for settings
TENANT_APPS
andMULTITENANT_RELATIVE_MEDIA_ROOT
to match Kiwi TCMS and installations prior to turning this package into a plugin. This will avoid dusrupting existing deployments!
- Turn into proper Kiwi TCMS plugin and install settings overrides under
tcms_settings_dir/
(compatible with Kiwi TCMS v8.2 or later)- does not need
MENU_ITEMS
andROOT_URLCONF
override anymore - does not need to load
tcms_tenants
inINSTALLED_APPS
manually - only need to specify
KIWI_TENANTS_DOMAIN
env variable!
- does not need
- Require
tcms_tenants.add_tenant
permission forNewTenantView
- Reimplement
NewTenantView
asFormView
- Refactor
redirect_to()
to class based view - Add tests for admin.py. Closes #5 Issue #5
- Replace
datetime.now
withtimezone.now
for better support of installations with enabled timezone config - Enable pylint. Closes Issue #17
- Enable flake8
- Update django-tenants from 3.0.0 to 3.0.1. Fixes Issue #60
- Bump django-tenants from 2.2.3 to 3.0.0
- Tested successfully against Kiwi TCMS v7.3 with Django 3.0
- Set
tcms_tenants.tests.LoggedInTestCase.tenant.owner.password
to "password" so it can be reused by downstream tests
- New translations for Slovenian
- Replace ugettext_lazy with gettext_lazy for Django 3.0
- Start shipping
tcms_tenants.tests
to be used by other multi-tenant add-on packages - Confirmed working against Kiwi TCMS v7.2
- Document how to configure multi-tenancy
- Document ST to MT migration
- Add helper method
create_oss_tenant()
- Internal updates to
TENANT_APPS
while testing
- New translations for Russian
- Add
Tenant.organization
field - When creating tenant set site.name to tenant.domain.domain
- Allow overriding create tenant form URL via additional context variable named
form_action_url
- Send email when a new tenant is created
- Add middleware which can be used to block unpaid tenants
- Rewrite middleware without deprecated
MiddlewareMixin
, Refers to Issue #17 - Add more tests
- Remove
django.contrib.contenttypes
fromTENANT_APPS
- Make it easier to override
NewTenantView
- Use
DateTimeField
instead ofDateField
- Show first primary domain in Admin
- Massive speed up tests
- Pylint fixes
- Bring back
tenant_url
template tag with optionalschema_name
parameter
- Fix failing tests
- Fix packaging for missing migrations directory
- Add view which facilitates GitHub login & redirects. Callers are supposed to perform OAuth login via public tenant and then redirect to this view which will send the browser to the actual tenant! This will resolve problems with
redirect_uri
mismatch that we're seeing from GitHub b/c you can only specify one redirect uri - pylint fixes
- Remove unused
templatetags/
directory
- Tenant object now has an owner
- Update django-tenants to 2.2.3
- New translations for Slovenian
- Don't ship
test_project/
files in wheel package
- Update to django-tenants 2.2.0 for Django 2.2 support
- Rename setting
TCMS_TENANTS_DOMAIN
toKIWI_TENANTS_DOMAIN
- Support creating of tenants via web interface
- Support for deleting tenants only by super-user
- Support for authorizing other users to access the current tenant
- Middleware which returns 403 Forbidden when non-authorized user tries to access a tenant
- Support for overriding the
tcms_tenants/new.html
template to provide SLA, terms and conditions, etc.