launch: Launch a docker container

Description Usage Arguments Details

Description

Launches a docker container that was created by dockertest.

Usage

1
2
3
launch(type = "test", args = NULL, interactive = TRUE, dry_run = FALSE,
  mount_volume = NULL, machine = NULL, link = NULL, name = NULL,
  filename = NULL)

Arguments

type

Type of container to run (as for link{build}. "run" and "production" (last one only for packages).

args

Additional arguments to pass through to docker. As it's not totally transparent what arguments dockertest will inject, this should really be (optionally) things like the name of the program to run within a container.

interactive

Should the container be interactive and allocate a pseudo-tty? The default is TRUE because it is possible to lock your console hard if you set this to FALSE when input is needed.

dry_run

Rather than actually run the command, return the command string suitable for running in a separate script.

mount_volume

Should a volume be mounted? This generates the appropriate absolute path name for a mapping. By default this is TRUE if the image requires it. If the image is "inplace", the the mount will map the project root to the docker working directory. If not then it will mount the 'self' directory (a clean clone) into the place where that is re-cloned into the container (therefore isolated from the machine). This behaviour may change.

machine

Name of docker machine to use

link

Vector of links (e.g. mycontainer:redis)

name

As an alternative to type, a full name can be given here, which dockertest will attempt to map onto a type.

filename

Optional filename used when name is given; only needed if dockertest.yml is hard to find.

Details

Note that this is the worst sort of function; the output totally changes depending on what mode it is in. It will either run a function or it will print what it would run so that that command can be used elsewhere.


traitecoevo/dockertest documentation built on May 31, 2019, 7:42 p.m.