You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Docker Run Action allows for the running of any image on the agent or a remote host. The action allows specification of an alternative command line to run on container if required. 

Docker Run

Name

A friendly name for this action (will be displayed in the actions workflow area).

Enabled

Determines if this action will be run within the relevant stage.

Working Directory

The directory from where the Docker command will be run. This is important for relative directories passed to the Docker Command. 

Image Name

The name, and optionally tag, of the docker image to run. This will create a new container based on the image and start the command supplied.

Container Name

Name to assign to the container. Leave this blank to automatically generate a random string name.

Specify remote Docker host

Tick to open a new Host tab to specify an alternative Docker host to the one local to the agent. 

Command

Command to run on the container. Leave blank to start with the settings configured in image.

Run in the background [--detached] 

When a container is run in the background, Continua CI does not wait for it to stop and does not receive any output from the process. Use this option when starting a container with a long running process or service.

Using

The version of Docker to use when running the Docker Run command. It is important that the agent have the correct version of Docker installed for the Docker File provided.  


Settings

Container Working Directory

Working directory inside the container [--workdir].

User

The username or id of the user to run the process within the container [--user].

Entrypoint

Overwrite the default entrypoint set by the image [–entrypoint].

Extra Command Line Arguments

Optional - Extra command line arguments to pass to Docker Build.

Container Environment Variables

Set environment variables for container [–env].


Network

Hostname

Container host or computer name [--hostname].

Ports To Expose

A list of additional ports to expose inside the container [--expose].

Ports To Publish

Publish a container's port or a range of ports to the host [--publish].

Host IP Mappings

Host IP address mappings to add to the containers host file in the format "hostname:ip_address";. [--add-host].


Host

Docker Host URL

The address of the Docker Host. This can be in the form of a URL or any IP4 Address. If a non-standard port is required simply use the <IPAddress>:<Port> specitifcation format. 

Use TLS

Tick to connect to the Docker host using TLS where the host is not verified against a CA.

Verify TLS

Available to tick only if 'Use TLS' is ticked.

Verify the certificate with a root authority where the Host is verified against its CA.

When using Verify TLS, if the Host's CA is not trusted by the agent then the connection is not established. 

CA Certificate

Path to Docker host CA certificate file.

Certificate

Path to Docker host certificate file

Docker Host Certificate Key

The Docker Host Certificate Key is the PEM format key file for the accessing the Docker Host Certificate. 


Options

Log Level

The amount of information detail to display in the build log.

Timeout (in seconds)

How long to wait for the action to finish running before timing out. Leaving this blank (or zero) will default to 86400 seconds (24 hours).

Treat failure as warning

Tick to continue build on failure marking the action with a warning status.


Environment

Multiple environment variables can be defined - one per line.

Log environment variables

If this is ticked, environment variable values are written to the build log. 

Generate system environment variables

Tick this checkbox to set up a list of new environment variables prefixed with 'ContinuaCI.' for all current system expression objects and variables.


  • No labels