docker command

Manage Tethys-sponsored Docker containers. To learn more about Docker, see What is Docker?.

Important

You must have Docker installed and add your user to the docker group to use the Tethys docker command (see: Install Docker and Post-installation steps for Linux).

Additionally, this feature requires the docker-py library to be installed. Starting with Tethys 5.0 or if you are using micro-tethys-platform, you will need to install docker-py using conda as follows:

bash
# conda: conda-forge channel strongly recommended
conda install -c conda-forge docker-py
python
usage: tethys docker [-h] [-d]
                     [-c {postgis,geoserver,wps,thredds} [{postgis,geoserver,wps,thredds} ...]]
                     [-b] [-t IMAGE_TAG] [-i IMAGE_NAME]
                     {init,start,stop,status,update,remove,ip,restart}

Positional Arguments

command

Possible choices: init, start, stop, status, update, remove, ip, restart

Docker command to run.

Named Arguments

-d, --defaults

Run command without prompting without interactive input, using defaults instead.

Default: False

-c, --containers

Possible choices: postgis, geoserver, wps, thredds

Execute the command only on the given container(s).

-b, --boot2docker

Stop boot2docker on container stop. Only applicable to stop command.

Default: False

-t, --image_tag

Create the container using the provided Docker image tag. Only applicable to the init and update commands for a single container.

-i, --image_name

Create the container using the provided Docker image name. Only applicable to the init and update command for a single container.