Developing and deploying CKAN with Docker
Dockerfiles, Fig service defintition & Vagrantfile to develop & deploy CKAN, Postgres, Solr & datapusher using Docker.
Docker containers included:
- CKAN (should work with any version 2.x)
- Postgres (Postgres 9.3 and PostGIS 2.1, CKAN datastore & spatial extension supported)
- Solr (4.10.1, custom schemas & spatial extension supported)
- Fig [optional] (to manage the containers)
Other contrib containers:
- Nginx (1.7.6 official) as a caching reverse proxy
- Datapusher
| Name | Version | Comment |
|---|---|---|
| Docker | >= 1.3 | works with Boot2docker 1.3 |
| Fig | >= 1.0 | on the host or with Dockerfile provided |
| Vagrant | >= 1.6 | if you intend to use Vagrant |
| OS | any | as long as you can run Docker 1.3 |
├── Dockerfile (CKAN Dockerfile)
├── README.md
├── Vagrantfile (CKAN Vagrantfile)
├── _etc (config copied to /etc)
│ ├── apache2
│ ├── ckan
│ ├── cron.d
│ ├── my_init.d
│ ├── nginx
│ ├── postfix
│ └── supervisor
├── _service-provider (any service provider such as datapusher)
│ └── datapusher
├── _solr
│ └── schema.xml (version specific & custom schema)
├── _src (CKAN source code & extensions)
│ ├── ckan
│ └── ckanext-...
├── docker
│ ├── ckan
│ ├── fig
│ ├── insecure_key (baseimage insecure SSH key)
│ ├── postgres
│ └── solr
├── fig.yml (CKAN services definition)
└── vagrant
└── docker-host (Linux Docker host if required)
the content from the directories prefixed with _ need to be edited / configured as required before building the Dockerfiles.
contains configuration files that are copied to /etc in the container. see _etc/README
contains your custom Solr schema (for your version of CKAN, & extensions installed). see _solr/README
contains your packages source code (CKAN & extensions). see _src/README
contains any service providers (e.g. datapusher) with their Dockerfiles. see _service-provider/README.
contains the Dockerfiles and any supporting files
contains the Docker host if the host cannot run Docker containers natively (OS X & Windows)
The Dockerfiles are currently based on phusion/baseimage:0.9.15.
SSH is supported using an insecure key which is enabled by default for development purposes. You should disable it in production use for obvious reasons.
Read this to find out more about phusion baseimage
The app container runs the following services
- Apache
- Postfix
- Supervisor
- Cron
The database container runs Postgres 9.3 and PostGIS 2.1. It supports the datastore & ckanext-spatial
The Solr container runs version 4.10.1. This can easily be changed by customising SOLR_VERSION in the Dockerfile.
By detault the schema.xml of the upstream version (2.3) is copied in the container. This can be overriden at runtime by mounting it as a volume.
This default path of the volume is _src/ckan/ckan/config/solr/schema.xml so it mounts the schema corresponding to your version of CKAN.
For example for Fig:
solr:
build: docker/solr
hostname: solr
domainname: localdomain
ports:
- "8983:8983"
volumes:
- ./_src/ckan/ckan/config/solr/schema.xml:/opt/solr/example/solr/ckan/conf/schema.xml
If you need a custom schema, put it in <full path to>/_solr and change the path in the fig or vagrant file, for example:
volumes:
- <my path to>/_solr/schema.xml:/opt/solr/example/solr/ckan/conf/schema.xml
The container is cross version compatible. You need mount the appropriate schema.xml as a volume, or build a child image, which will copy the schema.xml next to your Dockerfile.
Read the ckanext-spatial documentation to add the required fields to your Solr schema if you use ckanext-spatial
The Fig container runs Fig version 1.0 & the latest Docker within a container.
The Docker socket needs to be mounted as a volume to control Docker on the host. A source folder must be mounted to access the fig definition
see docker/Fig/Readme to find out how to use
Defines VMs provided by Docker, a Virtual Box docker-host is used if the host can't run Docker containers natively. This is an alternative to Boot2Docker.
Defines the set of services required to run CKAN. Read the fig.yml reference to understand and edit.
- Clone your code in the
_srcdirectory (see _src/README) - Clone the datapusher in
_service-provider(see _service-provider/README) - Set the full path of the volumes in fig.yml
- Run
upwith Fig or Vagrant
If you have if >= 1.0 installed, just type
fig up
Otherwise, install Fig on your host or use the container provided
Build fig the fig container
docker build --tag="fig_container" docker/fig
Run it
docker run -it -d --name="fig-cli" -p 2375 -v /var/run/docker.sock:/tmp/docker.sock -v $(pwd):/src fig_container
Build & Run the services defined in fig.yml
docker exec -it fig-cli fig up
If you are using boot2docker, add entries in your hosts file e.g. 192.168.59.103 ckan.localdomain
You can now access CKAN at http://ckan.localdomain:8080/ (Apache) & http://ckan.localdomain/ (Ngnix)
Build & run
vagrant up --provider=docker --no-parallel
You can now access CKAN at http://localhost:8080/ (Apache)
You can also SSH inside the container if you have left the --enable-insecure-key option in the run command.
vagrant ssh ckan
SSH insecure key can be disabled by removing the --enable-insecure-key option from the run command.
The simplest thing to do is to use the docker exec command, for example:
docker exec -it src_ckan_1 /bin/bash
You can also SSH inside the container if you have left the --enable-insecure-key option in the run command.
ssh -i docker/insecure_key -p 2222 [email protected]
SSH insecure key can be disabled by removing the --enable-insecure-key option from the run command.
You should use fig to manage your containers & images, this will ensure they are started/stopped in order
If you want to quickly remove all untagged images:
docker images -q --filter "dangling=true" | xargs docker rmi
If you want to quickly remove all stopped containers
docker rm $(docker ps -a -q)