Contents
This page describes the steps required to launch a single-node local test instance using self-signed certificates.
Pre-requisites
The only pre-requisites are a recent version of Docker Engine and Docker Compose on the host system.
Configure environment
First, clone the repository:
git clone https://github.com/cedadev/esgf-docker.git
cd esgf-docker
A single-node test installation requires the following environment variables to be set:
export ESGF_HOSTNAME=local.esgf.org
export ESGF_CONFIG=/path/to/empty/config/directory
export ESGF_DATA=/path/to/data/directory
The hostname should be a DNS name that resolves to the non-loopback address
of the current machine (i.e. not 127.0.0.1). This is because the containers
make HTTP calls to ESGF_HOSTNAME, so it cannot be localhost or any other
DNS name that has been configured to resolve to 127.0.0.1, as that would cause
the container to try to contact itself.
The Java SSL implementation does not like IP addresses as hostnames, so ESGF_HOSTNAME
must be a domain name and not an IP address.
To create a domain name to IP mapping on the local machine, just add an entry to
/etc/hosts on Linux, or /private/etc/hosts on Mac. Alternatively, you can
use an xip.io domain, which are of the form <ip address>.xip.io.
To find out the IP addresses of the current machine, use either ifconfig or ip addr
depending on which command is available.
On a Mac, the Docker daemon can only mount files in your home directory into containers.
This means you need to make sure that the ESGF_CONFIG directory is in your
home directory.
## Pull the container images from Docker Hub
You only need to pull the images from Docker Hub when they have changed, or if you are deploying for the first time:
docker-compose pull
Generate configuration
Once you have exported the environment variables, run the following commands to generate deployment secrets, self-signed certificates and the trusted certificate bundle:
docker-compose run esgf-setup generate-secrets
docker-compose run esgf-setup generate-test-certificates
docker-compose run esgf-setup create-trust-bundle
Launch containers
After generating the configuration, you are ready to launch the containers using Docker Compose:
docker-compose up -d
This will pull all the images from Docker Hub (unless they are already available locally) and launch the containers in order.
Once all the containers are running normally, navigate to https://$ESGF_HOSTNAME
in a browser and you should see the CoG interface. You can view the container
logs using commands of the form:
docker-compose logs [-f] esgf-{cog,index-node,idp-node,orp,slcs,...}
where the optional -f means “follow”, as in tail -f.
Try to log in with the OpenID https://$ESGF_HOSTNAME/esgf-idp/openid/rootAdmin.
To find the rootAdmin password that was randomly generated for you, run the
following command:
echo "$(cat "$ESGF_CONFIG/secrets/rootadmin-password")"
Stopping containers
To stop the containers:
docker-compose stop
To remove all the containers and associated data volumes:
docker-compose down -v