@contiamo/dev

Contiamo Dev

Get the dev environment fast!

Getting started

Prerequisites

Local development is supported via Docker Compose.

Before you start, you must install Docker and Docker-Compose.

Additionally, the development requires access to our private docker registry. To access this ask the Ops team for permissions. Once permissions have been granted you must install the gcloud CLI.

Once installed, run

make docker-auth pull

This will attempt to

1. authenticate with Google,
2. configure your Docker installation to use the new Google credentials, and
3. pull the required Docker images,

Starting The Environment

Finally, to start the development environment, run

make start

Once the environment has started, you should see a message with a URL and credentials, like this

Dev ui         :	 http://localhost:9898/contiamo/profile
Email          :	 [e-mail]
Password       :	 localdev

Pantheon Local Development

Local Pantheon debug development is supported by port redirection. This requires the pantheon-redir Docker image, run

make build

Additionally, so that Pantheon can correctly resolve the storage database service, you must modify your /etc/hosts file to include

127.0.0.1 metadb

You can easily do this with sudo echo "127.0.0.1 metadb" >> /etc/hosts.

To start the Pantheon dev environment use

export PANTHEON_TAG=redir
make start

This will replace the Pantheon image with a simple port redirection image that will enable transparent redirect of 8765 and 4300. You can then start your local Pantheon debug build, e.g. from your IDE, and have it bind to those ports on localhost.

Stopping

You can always cleanly stop the environment using

make stop

Any data in the databases will be preserved between stop and start.

Cleaning up

If you need to reclaim space or want to restart your environment from scratch use

make clean

This will stop your current environment and remove any Docker volumes related to it. This includes any data your dev db.

Custom Images

The Compose file supports overriding the Docker tag used for a service by setting several environment variables:

Server	Variable	Default
datastore	DATASTORE_TAG	dev
idp	IDP_TAG	latest
pantheon	PANTHEON_TAG	latest
contiamo-ui	CONTIAMOUI_TAG	latest