Name: docker-ckan
Owner: Open Knowledge International
Description: Docker Compose setup for CKAN
Created: 2018-01-18 10:02:21.0
Updated: 2018-05-22 10:38:20.0
Pushed: 2018-04-06 06:51:59.0
Size: 34
Language: Python
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Note: :warning: This is a work in progress. There is likely to be issues so use with caution :warning:
This is a set of Docker images and configuration files to run a CKAN site
It is largely based on two existing projects:
It includes the following images, all based on Alpine Linux:
The site is configured via env vars (the base CKAN image loads ckanext-envvars), that you can set in the .env file.
Copy the included .env.example and rename it to .env to modify it depending on your own needs.
Using the default values on the .env.example file will get you a working CKAN instance. There is a sysadmin user created by default with the values defined in CKAN_SYSADMIN_NAME and CKAN_SYSADMIN_PASSWORD(ckan_admin and test by default). I shouldn't be telling you this but obviously don't run any public CKAN instance with the default settings.
To build the images:
docker-compose build
To start the containers:
docker-compose up
To develop local extensions use the docker-compose.dev.yml file:
To build the images:
docker-compose -f docker-compose.dev.yml build
To start the containers:
docker-compose -f docker-compose.dev.yml up
See CKAN Images for more details of what happens when using development mode.
To run a container and be able to add a breakpoint with pdb or ipdb, run the ckan-dev container with the --service-ports option:
docker-compose -f docker-compose.dev.yml run --service-ports ckan-dev
This will start a new container, displaying the standard output in your terminal. If you add a breakpoint in a source file in the src folder (import pdb; pdb.set_trace()) you will be able to inspect it in this terminal next time the code is executed.
+-------------------------+ +----------+
| | | |
| openknowledge/ckan-base +----------------> ckan | (production)
| | | |
+-----------+-------------+ +----------+
|
|
+-----------v------------+ +----------+
| | | |
| openknowledge/ckan-dev +-----------------> ckan | (development)
| | | |
+------------------------+ +----------+
The Docker images used to build your CKAN project are located in the ckan/ folder. There are two Docker files:
Dockerfile: this is based on openknowledge/ckan-base (with the Dockerfile on the ckan-base/ folder), an image with CKAN with all its dependencies, properly configured and running on uWSGI (production setup)
Dockerfile.dev: this is based on openknowledge/ckan-dev (with the Dockerfile on the ckan-dev/ folder), wich extends openknowledge/ckan-base to include:
Any extension cloned on the src folder will be installed in the CKAN container when booting up Docker Compose (docker-compose up). This includes installing any requirements listed in a requirements.txt (or pip-requirements.txt) file and running python setup.py develop.
The CKAN image used will development requirements needed to run the tests .
CKAN will be started running on the paster development server, with the --reload option to watch changes in the extension files.
Make sure to add the local plugins to the CKAN__PLUGINS env var in the .env file.
From these two base images you can build your own customized image tailored to your project, installing any extensions and extra requirements needed.
To perform extra initialization steps you can add scripts to your custom images and copy them to the /docker-entrypoint.d folder (The folder should be created for you when you build the image). Any *.sh and *.py file in that folder will be executed just after the main initialization script (prerun.py) is executed and just before the web server and supervisor processes are started.
For instance, consider the following custom image:
docker-entrypoint.d
??? setup_validation.sh
Dockerfile
Dockerfile.dev
We want to install an extension like ckanext-validation that needs to create database tables on startup time. We create a setup_validation.sh script in a docker-entrypoint.d folder with the necessary commands:
in/bash
eate DB tables if not there
er --plugin=ckanext-validation validation init-db -c $CKAN_INI
And then in our Dockerfile we install the extension and copy the initialization scripts:
openknowledge/ckan-dev:2.7
pip install -e git+https://github.com/frictionlessdata/ckanext-validation.git#egg=ckanext-validation && \
pip install -r https://raw.githubusercontent.com/frictionlessdata/ckanext-validation/master/requirements.txt
docker-entrypoint.d/* /docker-entrypoint.d/