Skip to content

Latest commit

 

History

History
executable file
·
209 lines (137 loc) · 7 KB

README.md

File metadata and controls

executable file
·
209 lines (137 loc) · 7 KB
Raw

ckan-docker

Developing and deploying CKAN with Docker, an http://appcivico.com/ implementation.

this is a fork of https://github.com/ckan/ckan-docker but with some different directories and configuration.

Usage for deploy a new instance

  1. Clone this repository and walk into the directory.
  2. ./unzip-sources.sh # decompress source code into the correct paths
  3. You should edit docker-compose.yml and change where you want to persist the data. default to ../data-mount
  4. ./build-images.sh # build the Dockerfiles (go take a coffee)
  5. ./generate-configs.sh # generate ckan.ini and copy an custom_config.ini + who.ini into _config/
  6. docker-compose up --no-recreate -d

CKAN instance mounts

defaults to:

  • ./_config/ will be mounted on /etc/ckan/default/
  • ./_config/apache.conf to /etc/ckan/default/apache.conf
  • ./_config/apache.wsgi to /etc/ckan/default/apache.wsgi
  • ./_etc/supervisor/conf.d to /etc/supervisor/conf.d

CKAN has more volumes from docker/data

defaults to:

  • ../data-mount/var-lib-ckan:/var/lib/ckan
  • ../data-mount/etc-postgres:/etc/postgresql/9.3/main
  • ../data-mount/var-lib-postgres/:/var/lib/postgresql/9.3/main
  • ../data-mount/solr-data:/opt/solr/example/solr/ckan/data

Any modification on the right part of : should be avoided if you won't change Dockefiles or knowing what you are doing.

WARNING: do not use data-mount inside of this directory, or will have errors with Docker because of permissions.

WARNING: if you don't have the database initialized yet, you have to run the postgres container before CKAN, otherwise, you can get postgres dump not complete.

docker-compose -f docker-compose-data-and-postgres.yml  up

wait for the last "CREATE ROLE" appear and press CTRL+C to shutdown.

Adding a admin user

after docker-compose up

docker exec -it ckandocker_ckan_1 /bin/bash
cd /usr/lib/ckan/default
virtualenv .
. bin/activate

paster --plugin=ckan sysadmin add admin --config=${CKAN_CONFIG}/${CONFIG_FILE}

Intro

Dockerfiles, Docker-compose service definition 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)
  • Docker-compose (to manage run containers on developts)
  • Data into a diferent directory (to store Postgres data & CKAN FileStore & Solr separately)
  • Bash script to make config and build directories after instances run.

Other contrib containers:

  • Nginx (1.7.6 official) as a caching reverse proxy
  • Datapusher configured to work with the CKAN instance

Requirements

Name Version Comment
Docker >= 1.3 works with Boot2docker 1.3
Docker-compose >= 1.1.0 on the host or with Dockerfile provided
OS any linux as long as you can run Docker 1.3

Reference

Structure

├── Dockerfile (CKAN Dockerfile)
├── README.md
├── _etc (config copied to /etc)
│   ├── apache2
│   ├── ckan
│   ├── cron.d
│   ├── my_init.d
│   ├── 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-...
├── source-codes/ with zip tarballs for ckan 2.4 and pages
├── docker
│   ├── ckan
│   ├── data
│   ├── compose
│   ├── nginx
│   ├── insecure_key (baseimage insecure SSH key)
│   ├── postgres
│   └── solr
└── docker-compose.yml (CKAN services definition)

Directories

the content from the directories prefixed with _ need to be edited / configured as required before building the Dockerfiles.

_etc

contains configuration files that are copied to /etc in the container. see _etc/README

_solr

contains your custom Solr schema (for your version of CKAN, & extensions installed). see _solr/README

_src

contains your packages source code (CKAN & extensions). see _src/README

_service-provider

contains any service providers (e.g. datapusher) with their Dockerfiles. see _service-provider/README.

docker

contains the Dockerfiles and any supporting files

source-codes

contains source zip code of:

  • CKAN Release 2.4
  • ckanext-pages (master branch downloaded 2015-07-27, tested and is stable)
  • datapusher (stable branch downloaded 2015-07-28)

Files

Dockerfiles

The Dockerfiles are currently based on phusion/baseimage:0.9.16.

Read this to find out more about phusion baseimage

CKAN Dockerfile

The app container runs the following services

  • Apache
  • Postfix
  • Supervisor
  • Cron
Postgres Dockerfile

The database container runs Postgres 9.3 and PostGIS 2.1. It supports the datastore & ckanext-spatial

Data Dockerfile

It exposes two volumes to store the Postgres data ($PGDATA) & CKAN FileStore AND Solr. This means you can recreate / app containers without losing your data.

Solr Dockerfile

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 <path to>/_src/ckan/ckan/config/solr/schema.xml so it mounts the schema corresponding to your version of CKAN.

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

docker-compose.yml

Defines the set of services required to run CKAN. Read the docker-compose.yml reference to understand and edit.

Running commands inside the container

The simplest thing to do is to use the docker exec command, for example:

docker exec -it NAME_OF_CONTAINER /bin/bash

Managing Docker images & containers

You should use docker-compose 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)

Sources