5.1 KiB

Raw Blame History

eDivorce

This is a Django project forked from the openshift/django-ex repository.

eDivorce was developed by the British Columbia Ministry of Justice to help self represented litigants fill out the paperwork for their divorce. It replaces existing fillable PDF forms with a friendly web interface.

The steps in this document assume that you have access to an OpenShift deployment that you can deploy applications on.

Local development

Prerequesites:

Docker
Python 3.5

To run this project in your development machine, follow these steps:

(optional) Create and activate a virtualenv (you may want to use virtualenvwrapper).
Clone this repo:

git clone https://github.com/bcgov/eDivorce.git
Install dependencies:

pip install -r requirements.txt
Create an environment settings file by copying .env.example to .env (.env will be ignored by Git)
Create a development database:

./manage.py migrate
If everything is alright, you should be able to start the Django development server:

./manage.py runserver 0.0.0.0:8000
Start the Weasyprint server server on port 5005
1. Bind the IP address 10.200.10.1 to the lo0 interface on your Mac computer. Weasyprint has been configured to use this IP address to request CSS files from Django (You should only have to do this once).
```
sudo ifconfig lo0 alias 10.200.10.1/24
```
2. Start docker
```
docker run -d -p 5005:5001 aquavitae/weasyprint
```
Open your browser and go to http://127.0.0.1:8000, you will be greeted with the eDivorce homepage.

OpenShift deployment

See: openshift/README.md

Logs

By default your Django application is served with gunicorn and configured to output its access log to stderr. You can look at the combined stdout and stderr of a given pod with this command:

oc get pods         # list all pods in your project
oc logs <pod-name>

This can be useful to observe the correct functioning of your application.

One-off command execution

At times you might want to manually execute some command in the context of a running application in OpenShift. You can drop into a Python shell for debugging, create a new user for the Django Admin interface, or perform any other task.

You can do all that by using regular CLI commands from OpenShift. To make it a little more convenient, you can use the script openshift/scripts/run-in-container.sh that wraps some calls to oc. In the future, the oc CLI tool might incorporate changes that make this script obsolete.

Here is how you would run a command in a pod specified by label:

Log in to the Openshift instance
```
oc login <path> --token=<token>
```
Select the project where you want to run the command
```
oc project <project-name>
```
Inspect the output of the command below to find the name of a pod that matches a given label:
```
 oc get pods -l <your-label-selector>
```
Open a shell in the pod of your choice. Because of how the images produced with CentOS and RHEL work currently, we need to wrap commands with bash to enable any Software Collections that may be used (done automatically inside every bash shell).
```
 oc exec -p <pod-name> -it -- bash
```
Finally, execute any command that you need and exit the shell.

The wrapper script combines the steps above into one. You can use it like this:

./run-in-container.sh ./manage.py migrate          # manually migrate the database
                                                   # (done for you as part of the deployment process)
./run-in-container.sh ./manage.py createsuperuser  # create a user to access Django Admin
./run-in-container.sh ./manage.py shell            # open a Python shell in the context of your app

If your Django pods are labeled with a name other than "django", you can use:

POD_NAME=name ./run-in-container.sh ./manage.py check

If there is more than one replica, you can also specify a POD by index:

POD_INDEX=1 ./run-in-container.sh ./manage.py shell

Or both together:

POD_NAME=django-example POD_INDEX=2 ./run-in-container.sh ./manage.py shell

Data persistence

For local development a SQLite database will be used. For OpenShift deployments data will be stored in a PostgreSQL database, with data files residing on a persistent volume.

License

Copyright 2017 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

5.1 KiB Raw Blame History