Skip to content
This repository has been archived by the owner on Mar 6, 2019. It is now read-only.

Deprecation Notice

Peter Johnson edited this page Jun 11, 2018 · 2 revisions

Deprecation Notice

This repository has been deprecated in favour of https://github.com/pelias/docker. As such, no further development work will be done in this repository.

We have left the source code and documentation up on Github for reference, but we strongly recommended you to migrate any code referencing this repository to use https://github.com/pelias/docker as soon as possible.

Migration Guide

I was using this repo, why did you deprecate it?

The dockerfiles implementation was a proof-of-concept for running Pelias in Docker, as we saw how external users were adapting and extending it, we discovered that the workflow was far from ideal.

How is the pelias/docker workflow any different to pelias/dockerfiles?

The pelias/docker workflow introduces the concept of 'projects', which allows developers to have many different pelias build configurations and to then quickly switch between them.

This 'composition' based workflow is much more powerful for scripting CI environments and to make changes without having to worry about using submodules or another 'inheritance' model to merge upstream changes.

Additionally, we have cleaned up the scripts and provided a functional bash interface to run tasks as well as a powerful CLI tool.

How can I migrate my existing files to use pelias/docker?

You simply need to create a new directory for your project, then copy your .env, docker-compose.yml & pelias.json files in to your project directory.

If you referenced any other files from pelias.json or docker-compose.yml (such as synonyms) then you need to ensure those files are copied too.

How can I install and configure the new pelias/docker code

Have a read through docs at https://github.com/pelias/docker and install the pelias command.

I migrated and now when I run docker-compose ps or pelias compose ps I dont see my containers?

The docker-compose command has a concept of a project name, which defaults to the name of the current working directory.

If the COMPOSE_PROJECT_NAME of your project does not match the com.docker.compose.project container metadata then the container will not be listed using those commands.

In order list containers created prior to the migration, set COMPOSE_PROJECT_NAME=dockerfiles in your .env file.

The new workflow here is to set COMPOSE_PROJECT_NAME=pelias for all new projects so that they will share the same name regardless of the name of the current working directory.

Alternatively, you can destroy your existing containers and use COMPOSE_PROJECT_NAME=pelias which is forward compatible.

You can inspect the metadata of an existing container using the following command:

docker inspect daa27fa0af7a | grep 'com.docker'