- THREDDS Docker
A containerized THREDDS Data Server built on top a security hardened Tomcat container maintained by Unidata.
unidata/thredds-docker:latestunidata/thredds-docker:5.3unidata/thredds-docker:5.2unidata/thredds-docker:5.1unidata/thredds-docker:5.0unidata/thredds-docker:4.6.17unidata/thredds-docker:4.6.16.1unidata/thredds-docker:4.6.15unidata/thredds-docker:4.6.14unidata/thredds-docker:4.6.13unidata/thredds-docker:4.6.12unidata/thredds-docker:4.6.11unidata/thredds-docker:4.6.10unidata/thredds-docker:4.6.8unidata/thredds-docker:4.6.6
docker run -d -p 80:8080 unidata/thredds-dockerTo run the THREDDS Docker container, beyond a basic Docker setup, we recommend installing docker-compose. docker-compose serves two purposes:
-
Reduce headaches involving unwieldy
dockercommand lines where you are runningdockerwith multiple volume mountings and port forwards. In situations like these,dockercommands become difficult to issue and read. Instead, the lengthydockercommand is captured in adocker-compose.ymlthat 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-dockerThere 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-productionConfiguration 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-productionThe output of such command should be something like:
Creating thredds
To stop this container:
docker-compose stop thredds-productionTo clean the slate and remove the container (not the image, the container):
docker-compose rm -f thredds-productionTHREDDS container is based off of the canonical Tomcat container (tomcat:jre8) with some additional security hardening measures. Tomcat configuration 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) inside the container. 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/threddsIf 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/directory2threddsConfig.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.
tdm- used by the THREDDS Data Manager for connecting to THREDDSadmin- can be used by everything else (has full privileges)
See the parent Tomcat container for information about creating passwords for these users.
TDS Remote Management is enabled for the admin user by default, and can be accessed via http(s)://<your server>/thredds/admin/debug.
To enable to ncSOS, change
<NCSOS>
<allow>false</allow>
</NCSOS>to true in threddsConfig.xml.
Upgrading to a newer version of the container is easy. Simply stop the container via docker or docker-compose, followed by
docker pull unidata/thredds-docker:<version>and restart the container.
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.ymland 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 pswhich 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> bashNow use curl inside the container to verify the TDS is running:
curl localhost:8080/thredds/catalog.htmlyou 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 the 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 in 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: <10.5065/D6N014KG> https://doi.org/10.5065/D6N014KG
If you have a question or would like support for this THREDDS Docker container, consider submitting a GitHub issue. Alternatively, you may wish to start a discussion on the THREDDS Community mailing list: thredds@unidata.ucar.edu.
For general TDS questions, please see the THREDDS support page.