A containerized THREDDS Data Server built on top a security hardened Tomcat container maintained by Unidata. This project was initially developed by Axiom Data Science and now lives at Unidata.
TDM Update: If you are looking for the TDM Docker container, it has moved into its own repository.
unidata/thredds-docker:4.6.10
unidata/thredds-docker:4.6.8
unidata/thredds-docker:4.6.6
unidata/thredds-docker:5.0-SNAPSHOT
Quickstart
docker run -d -p 80:8080 unidata/thredds-docker
One way to run Docker containers is with docker-machine. This is a common scenario if you are running Docker on your local OS X or Windows development system. You can use docker-machine
to run the thredds-docker
container. You will need to allocate at least 4GBs of RAM to the VM that will run this container. For example, here we are creating a VirtualBox Docker machine instance with 6GBs of RAM:
$ docker-machine create --virtualbox-memory "6144" thredds
Running pre-create checks...
Creating machine...
...
...
Docker is up and running!
To see how to connect your Docker Client to the Docker Engine running on this virtual machine, run: docker-machine env thredds
At this point, you can issue the following command to connect to your new thredds
Docker client.
$ eval $(docker-machine env thredds)
In the next section, we use docker-compose
to start the thredds-docker
container.
Note that if you are running the TDS with docker-machine
, you will have to find the local IP address of that TDS with docker-machine ip thredds
which may return something like 192.168.99.100
. So connecting to that TDS will entail navigating to http://192.168.99.100/thredds/catalog.html
in your browser.
To run the THREDDS Docker container, beyond a basic Docker setup, we recommend installing docker-compose. docker-compose
serves two purposes:
- Reduce headaches involving unwieldy
docker
command lines where you are runningdocker
with multiple volume mountings and port forwards. In situations like these,docker
commands become difficult to issue and read. Instead, the lengthydocker
command is captured in adocker-compose.yml
that is easy to read, maintain, and can be committed to version control. - Coordinate the running of two or more containers to, for example, orchestrate the TDS and TDM. This can be useful for taking into account the same volume mountings, for example.
However, docker-compose
use is not mandatory. For example, this container can be started with
docker run -d -p 80:8080 unidata/thredds-docker
There is an example docker-compose.yml in this repository.
This project contains a docker-compose
environment file named compose.env
. This file contains default values for docker-compose
to launch the TDS and TDM. You can configure these parameters:
| Parameter | Environment Variable | Default Value |
|-----------------------------+-----------------------+------------------------------|
| TDS Content Root | TDS_CONTENT_ROOT_PATH | /usr/local/tomcat/content |
| TDS JVM Max Heap Size (xmx) | THREDDS_XMX_SIZE | 4G |
| TDS JVM Min Heap Size (xms) | THREDDS_XMS_SIZE | 4G |
| TDM Password | TDM_PW | CHANGEME! |
| TDS HOST | TDS_HOST | http://thredds.yourhost.net/ |
| TDM JVM Max Heap Size (xmx) | TDM_XMX_SIZE | 6G |
| TDM JVM Min Heap Size (xms) | TDM_XMS_SIZE | 1G |
If you wish to update your configuration, you can either update the compose.env
file or create your own environments file by copying compose.env
. If using your own file, you can export the suffix of the file name into an environment variable named THREDDS_COMPOSE_ENV_LOCAL
.
For example:
cp compose.env compose_local.env
export THREDDS_COMPOSE_ENV_LOCAL=_local
< edit compose_local.env >
docker-compose up thredds-production
Configuration information may be found in the Docker Swarm readme.
Tomcat web applications and the TDS can require large amounts of memory to run. This container is setup to run Tomcat with a default 4 gigabyte memory allocation. When running this container, ensure your VM or hardware can accommodate this memory requirement.
Define directory and file paths for log files, Tomcat, THREDDS, and data in docker-compose.yml for the thredds-production
image.
Once you have completed your setup you can run the container with:
docker-compose up -d thredds-production
The output of such command should be something like:
Creating thredds
To stop this container:
docker-compose stop thredds-production
To clean the slate and remove the container (not the image, the container):
docker-compose rm -f thredds-production
THREDDS container is based off of the canonical Tomcat container (tomcat:jre8) with some additional security hardening measures. Tomcat configurability can be done by mounting over the appropriate directories in CATALINA_HOME
(/usr/local/tomcat
).
The Java (JAVA_OPTS
) are configured in ${CATALINA_HOME}/bin/javaopts.sh
(see javaopts.sh). See the docker-compose
section above for configuring some of the environment variables of this file.
To mount your own content/thredds
directory with docker-compose.yml
:
volumes:
- /path/to/your/thredds/directory:/usr/local/tomcat/content/thredds
If you just want to change a few files, you can mount them individually. Please note that the THREDDS cache is stored in the content directory. If you choose to mount individual files, you should also mount a cache directory.
volumes:
- /path/to/your/tomcat/logs/:/usr/local/tomcat/logs/
- /path/to/your/thredds/logs/:/usr/local/tomcat/content/thredds/logs/
- /path/to/your/tomcat-users.xml:/usr/local/tomcat/conf/tomcat-users.xml
- /path/to/your/thredds/directory:/usr/local/tomcat/content/thredds
- /path/to/your/data/directory1:/path/to/your/data/directory1
- /path/to/your/data/directory2:/path/to/your/data/directory2
threddsConfig.xml
- the THREDDS configuration file (comments are in-line in the file)wmsConfig.xml
- the ncWMS configuration filecatalog.xml
- the root catalog THREDDS loads
Please see Tomcat parent container repository for HTTP over SSL instructions.
By default, Tomcat will start with two user accounts. The passwords are equal to the user name.
tdm
- used by the THREDDS Data Manager for connecting to THREDDSadmin
- can be used by everything else (has full privileges)
Let's say you want to upgrade to the Docker THREDDS Container, and you already have a TDS configured with
- Directory containing TDS configuration files (e.g.
threddsConfig.xml
,wmsConfig.xml
and THREDDS catalog.xml
files) in/usr/local/tomcat/content/thredds
- Folders containing NetCDF and other data files read by the TDS in
/data1
and/data2
- Tomcat users configured in
/usr/local/tomcat/conf/tomcat-users.xml
Then you could issue this command to fire up the new Docker TDS container (remember to stop the old TDS first):
docker-compose stop thredds-production
docker-compose up -d thredds-production
At this point you should be able to do:
curl localhost:80/thredds/catalog.html
# or whatever port you mapped to outside the container in the docker-compose.yml
and get back a response that looks something like
<!DOCTYPE html PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN'
'http://www.w3.org/TR/html4/loose.dtd'>
<html>
<head>
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'><title>TdsStaticCatalog http://localhost/thredds/catalog.html</title>
<link rel='stylesheet' href='/thredds/tdsCat.css' type='text/css' >
</head>
...
</html>
If you encounter a problem there, you can also:
docker ps
which should give you output that looks something like this:
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
6c256c50a6cf unidata/thredds-docker:latest "/entrypoint.sh catal" 6 minutes ago Up 6 minutes 0.0.0.0:8443->8443/tcp, 0.0.0.0:80->8080/tcp, 0.0.0.0:443->8443/tcp threddsdocker_thredds-quickstart_1
to obtain the ID of the running TDS container. Now you can enter the container with:
docker exec -it <ID> bash
Now use curl
inside the container to verify the TDS is running:
curl localhost:8080/thredds/catalog.html
you should get a response that looks something like:
<!DOCTYPE html PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN'
'http://www.w3.org/TR/html4/loose.dtd'>
<html>
<head>
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'><title>TdsStaticCatalog http://localhost/thredds/catalog.html</title>
<link rel='stylesheet' href='/thredds/tdsCat.css' type='text/css' >
</head>
...
</html>
At this point we are done setting up the TDS with docker. To navigate to this instance of TDS from the web, you will have to ensure your docker host (e.g., a cloud VM at Amazon or Microsoft Azure) allows Internet traffic through port 80 at whatever IP or domain name your docker host is located.
The THREDDS Data Manager or TDM is an application that works in close conjunction with the TDS and is referenced in the docker-compose.yml in this repository. The TDM Docker container is now its own repository where you can find instructions on how to run it.
In order to cite this project, please simply make use of the Unidata THREDDS Data Server DOI.