Migrate a project to Divio Cloud¶
In this tutorial you will take an existing Django project and port it to Divio Cloud.
The project (The Opinions Company) complete with custom applications, database content, media files and styling is contained in a GitHub repository.
Using it will allow you to go through all the required steps for a project migration in a controlled environment, and practise them before applying your knowledge to a project of your own.
In the tutorial, we’ll be using the command line rather than the Divio app. Although nearly every step here could equally well be run via the Divio app, the feedback from the command line tools is more explicit and helps see what exactly is happening.
If you’re interested in knowing how the controls of the Divio app correspond to commands, see The Divio application.
Set the project up locally¶
We’ll begin by setting up the source project locally. Clone the project, and cd into the directory:
git clone email@example.com:divio/the-opinions-company.git cd the-opinions-company
Create and activate a virtual environment:
python3.6 -m venv env source env/bin/activate
Install the project’s dependencies into the virtual environment:
pip install -r requirements.txt
Run migrations to create the empty database tables:
python manage.py migrate
Load the database content from the
python manage.py loaddata database.json
Start the runserver:
python manage.py runserver
You can now open the site at http://localhost:8000. The username and password are
admin. Check that you can log in and use the site and its admin.
Dump database to a JSON file (if required)¶
If you have made some additional changes to the database that you’d like to load into the Divio Cloud project, you can dump them with:
python manage.py dumpdata --natural-foreign --natural-primary --indent 4 > database.json
Migrate to Divio Cloud¶
Create a new Divio Cloud project¶
On the Divio Cloud control panel, create a new project, with the options:
- Python 3
- django CMS
- Blank boilerplate
Once the new project has been provisioned, see its Addons view.
You need to install django CMS Bootstrap 4 (important: make sure you select version 1.0.0)
Select the Installed button, and check the other versions.
|Aldryn django CMS||3.5.x.y|
|django CMS Bootstrap 4||1.1.1|
|django CMS File||2.0.2|
|django CMS Google Map||1.1.0|
|django CMS History||0.5.3|
|django CMS Link||2.1.2|
|django CMS Picture||2.0.6|
|django CMS Snippet||2.0.0|
|django CMS Style||2.0.2|
|django CMS Text CKEditor||3.5.3|
|django CMS Video||2.0.4|
If necessary, downgrade any installed addons to the versions listed above . This is to ensure compatibility with the database provided for the purposes of this tutorial. If you run into an error, particularly when attempting to load the database into your new project, it is probably because one of the addons has been updated and requires a new database schema.
In this case, select the correct version of the addon on the Control Panel, and in your project, run:
git pull # pull down the configuration into the local project docker-compose build web # rebuild the web container
Set the project up locally¶
divio project setup command (the exact command can be found in the Local development
Check the Divio project’s dependencies¶
Paste the entire contents of your original project’s
requirements.txt file into the
requirements.in of the Divio project, after the auto-generated section.
We now have to scan through this line-by-line, to check for conflicts. In the Addons view for the project in the Control Panel, select Installed addons, and for each line you have added, cross-check to see whether it has already been included.
You will find that most are already present, and you’ll also be able to see that in them listed in the auto-generated section in the file.
As you confirm that each one is present, you can remove the corresponding line that you copied over - it’s no longer required. For example (note that our projects, versions and dependencies all change over time, so the actual results you see may be slightly different):
django-cms>=3.5,<3.6 # No need to add this manually # django CMS plugins and addons djangocms-text-ckeditor>=3.6.0 # djangocms-link>=2.1 # djangocms-style>=2.0 # You can expect all of these to be djangocms-googlemap>=1.1 # present already amongst the addons djangocms-snippet>=2.0 # included in the project, so there djangocms-video>=2.0 # is probably no need for them to be djangocms-file>=2.0,<3.0 # added manually to the requirements.in djangocms-picture>=2.0,<3.0 # file. django-filer>=1.3 # djangocms-bootstrap4==1.0.0 #
Some may or may not be explicitly listed amongst the project’s addons, but can be found in the setup.py of django CMS (make sure you’re looking at the right version), so once again, they won’t need to be included, though you should still check that the version numbers are compatible.
# Django dependencies (specified in django CMS's setup.py) Django<2.0 # Already installed by Aldryn Django django-classy-tags>=0.7 # These dependencies are specifed by django-sekizai>=0.9 # django CMS, so will be installed django-treebeard>=4.0,<5.0 # automatically anyway. djangocms-admin-style>=1.2,<1.3 #
requirements.txt file lists some further Python dependencies. You may recognise
some of them (and that, for example,
easy_thumbnails is a dependency of Django Filer). However
if you need to, you can check the Divio Project to see what has already been installed, with
docker-compose run --rm web pip freeze. All the following should already be present, and do not
need to be listed manually:
# Python dependencies html5lib>=0.999999,<0.99999999 # Pillow>=3.0 # Should all be present in the Divio pytz # Project's environment. six # easy_thumbnails #
Finally, there is the Polls application, installed via pip from GitHub:
# polls -e firstname.lastname@example.org:divio/django-polls.git#egg=django-polls
This will need to be specified in the
requirements.in file. However, the
option makes little sense in this context, and our pip setup cannot handle requirements in
this format. Instead, you need to provide the URL of an archive, in this
We use the commit, because otherwise our pip system could cache an older version.
And that is the only requirement you need to add manually to the
polls_cms_integration application is in the project folder of the original project. This
needs to be copied to the same place in the Divio project.
Test the build¶
You can now test whether the project will build:
docker-compose build web
If you run into an error, you most likely either have a dependency version conflict, or the
collectstatic command in the
Dockerfile cannot run, because a required dependency is
missing. This will need to be resolved before you can proceed.
In the original project, all the
INSTALLED_APPS are listed manually. In a Divio project,
most of them will be added automatically by the addons. You need to ensure that your Divio
project includes all those in the original project.
In this case,
both need to be added manually (
the_opinions_company is also listed, but this is just the
project name and doesn’t need to be added).
INSTALLED_APPS.extend([ [...] ])
section so that they will be added.
Our project is quite simple - in a more complex project, you can use diff on the lists of INSTALLED_APPS to help ensure you don’t miss any.
Run migrations to create tables for the new applications:
docker-compose run --rm web python manage.py migrate
Transfer other settings¶
Your original project’s settings need to be transferred to the Divio project. Settings in Divio projects can be handled in multiple ways:
- via an addon’s configuration form, as defined by its aldryn_config.py file, which also provides sensible defaults
- as environment variables
- as plain old settings in The settings.py file
In this project there’s only one other setting we need to be concerned with:
The best way to maintain the
CMS_TEMPLATES setting in a Divio project is via the Aldryn django
CMS addon’s configuration form, and ultimately that is what we will do (in the local version of the
project, you can see this configuration stored in
For now however it’s easier to include the setting in the
settings.py file temporarily, so
CMS_TEMPLATES = ( ('content.html', 'Content'), )
Prepare the Postgres database of the Divio project¶
The database has so far been migrated, but that’s all.
Now you can import the dumped JSON data. Copy
database.json over from the original project, and
docker-compose run --rm web python manage.py loaddata database.json
If this doesn’t work, it’s most likely for one of two reasons:
- you may have performed an operation that writes data to the tables - even logging in just once will do this
- one of the addons in the project does not match the version in the original project - check the versions carefully, and if necessary rebuild the web container with the correct versions.
In either case, you will need to restore the database to its newly-migrated state, following the steps in Reset the database.
Copy site templates¶
Next, we need to copy the two templates
content.html template from
the_opinions_company/templates in the original project to
templates in the Divio project,
as well as the
Copy static files¶
Copy all the folders in
media into the
data directory of the Divio project.
Start the runserver¶
Check the site¶
Once again, check that the site works as expected.
Now you’re ready to push your work to the Cloud.
Push your changes to the Divio Cloud environment¶
Earlier, we added:
CMS_TEMPLATES = ( ('content.html', 'Content'), )
settings.py. That was only a temporary expedient - remove that now, because you don’t
want to push that.
Instead, in your project in the Control Panel, go to the Addons > Aldryn django CMS > Configure, and in the CMS Templates field apply:
Now you can push the rest of your code. Run
git status to see what has been changed.
add the changes you want to push:
git add requirements.in settings.py polls_cms_integration static templates
git commit -m "Set up The Opinions Company as a Divio project"
git pull # merge the changes you made in the Control Panel git push origin develop # push local changes
Push the database:
divio project push db
And the media files:
divio project push media
Deploy the new Divio Cloud project¶
On the Control Panel, you see that there are now a number of undeployed commits, representing the work you have done.
You can hit Deploy on the Control Panel, or run:
divio project deploy
And that’s it! Your project is now running in the Cloud.