Set up and configure the Django web application framework.
Note
See the full Salt Formulas installation and usage instructions.
Install Django from the system package manager. Note, the Django version available varies by platform.
Example usage:
include:
- django
mysite:
git:
- latest
- name: [email protected]/mysite
- target: /var/www/mysite
- require:
- pkg: djangoInstall Django via pip.
Example usage:
include:
- django.pip
mysite:
git:
- latest
- name: [email protected]/mysite
- target: /var/www/mysite
- require:
- pip: django_pipThis formula also provides an example of how Salt can be used to deploy a Django app in a single command, using the OverState System. It installs Django into a virtualenv, using pip with a requirements.txt.
This example makes use of the following three files:
- pillar.example - Pillar data
- overstate.single - Single-host OverState deployment stages
- overstate.multi - Multi-host OverState deployment stages
Deploying this example will require that the relevant files from above (the Pillar data and appropriate OverState config file) are copied to the Master and edited as necessary. The Pillar data will need to be available to all involved minions.
Additionally, this example makes use of several other Salt formulae:
An easy way to use these would be to add them as gitfs sources. It is not recommended to add the master copy of the repo (the one within the saltstack-formulas account), as others may be pushing to this repository. Instead, it's safer to fork the repository on GitHub, and use the fork as a gitfs remote. For example:
gitfs_remotes:
- https://github.com/yourusername/django-formula.git
- https://github.com/yourusername/apache-formula.git
- https://github.com/yourusername/git-formula.git
- https://github.com/yourusername/mysql-formula.git
- https://github.com/yourusername/pip-formula.git
- https://github.com/yourusername/virtualenv-formula.gitIt is also a good idea, though not mandatory, to create a branch and use that to make any needed changes. This allows you to pull from the saltstack-formulas version of the repo into your local fork's master branch, and evaluate the changes without causing conflicts with whatever changes you made.
$ git branch
* master
$ git checkout -b deployment
Switched to a new branch 'deployment'
$ git push -u origin deployment This would need to be repeated for each gitfs remote.
To deploy the entire stack (Apache, MySQL, Django, application) to a single host, run the following command:
# salt-run state.over deployment /path/to/overstate.singleTo deploy using one database server (and one or more web servers), run the following command:
# salt-run state.over deployment /path/to/overstate.multiNote
If you did not create a separate deployment branch as recommended above, then replace deployment with base in the above salt-run commands.
The easiest way to create Django's settings.py file using data from Pillar is to simply transform a dictionary in YAML into a dictionary in Python.
/srv/salt/mysite.sls:
include:
- django.pip
mysite:
git:
- latest
- name: [email protected]/mysite
- target: /var/www/mysite
- require:
- pip: django_pip
mysite_settings:
file:
- managed
- name: /var/www/mysite/settings.py
- contents: |
globals().update({{ salt['pillar.get']('mysite:settings') | python() | indent(8) }})
- require:
- git: mysite/srv/pillar/mysite.sls:
mysite:
settings:
ROOT_URLCONF: mysite.urls
SECRET_KEY: 'gith!)on!_dq0=2l(otd67%#0urmrk6_d0!zu)i9fn=!8_g5(c'
DATABASES:
default:
ENGINE: django.db.backends.mysql
NAME: mysitedb
USER: mysiteuser
PASSWORD: mysitepass
HOST: localhost
PORT: 3306
TEMPLATE_DIRS:
- /var/www/mysite/django-tutorial/templates
STATICFILES_DIRS:
- /var/www/mysite/django-tutorial/static
STATIC_ROOT: /var/www/mysite/django-tutorial/staticrootA more traditional (and flexible) method of creating the settings.py file is to actually create the file as a template.
/srv/salt/mysite/mysite.sls:
include:
- django.pip
mysite:
git:
- latest
- name: [email protected]/mysite
- target: /var/www/mysite
- require:
- pip: django_pip
mysite_settings:
file:
- managed
- name: /var/www/mysite/settings.py
- source: salt://mysite/files/settings-tmpl.py
- template: jinja
- require:
- git: mysite/srv/salt/mysite/files/settings-tmpl.py:
{# Data can be defined inline, in Grains, in Pillar, etc #}
{% set db_settings = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'HOST': 'localhost',
'NAME': 'polldb',
'PASSWORD': 'pollpass',
'PORT': 3306,
'USER': 'polluser',
}
} %}
{% set staticfiles_dirs_settings = [
'/var/www/poll/django-tutorial/static',
] %}
{% set template_dirs_settings = [
'/var/www/poll/django-tutorial/templates',
] %}
ROOT_URLCONF = mysite.urls
{# Have Salt automatically generate the SECRET_KEY for this minion #}
SECRET_KEY = '{{ salt['grains.get_or_set_hash']('mysite:SECRET_KEY', 50) }}'
DATABASES = {{ db_settings | python() }}
TEMPLATE_DIRS = {{ template_dirs_settings | python() }}
STATICFILES_DIRS = {{ staticfiles_dirs_settings | python() }}
STATIC_ROOT = /var/www/mysite/django-tutorial/staticrootA wait state can be used to trigger django-admin.py syncdb or django-admin.py collectstatic automatically. The following example runs both commands whenever the Git repository containing the "mysite" Django project is updated.
include:
- django.pip
mysite:
git:
- latest
- name: [email protected]/mysite
- target: /var/www/mysite
- require:
- pip: django_pip
mysite_syncdb:
module:
- wait
- name: django.syncdb
- settings_module: "mysite.settings"
- bin_env: /path/to/virtualenv # optional
- pythonpath: /path/to/mysite_project # optional
- watch:
- git: mysite
mysite_collectstatic:
module:
- wait
- name: django.collectstatic
- settings_module: "mysite.settings"
- bin_env: /path/to/virtualenv # optional
- pythonpath: /path/to/mysite_project # optional
- watch:
- git: mysite
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent