Create Docker plugin procedures

1 minute readExtensibilityDeveloper productivity

Plugin procedures can be used in procedure steps, process steps, and pipeline tasks, allowing you to orchestrate third-party tools at the appropriate time in your component, application process, or pipeline.

runDockerBuild

Performs a Docker build.

Input parameters

Table 1. runDockerBuild input parameters
Parameter Description

Configuration name

Required. The previously defined configuration for the plugin.

Use sudo

Use sudo for running the Docker build.

Build path

Required. The path to the source code.

runDockerPull

Performs a Docker pull on the requested image.

Input parameters

Table 2. runDockerPull input parameters
Parameter Description

Configuration name

Required. The previously defined configuration for the plugin.

Use sudo

Use sudo for running the Docker pull.

Image name

Required. The image to pull from Docker Hub.

Image tag

The image tag.

runDockerRun

Performs a Docker run.

Input parameters

Table 3. runDockerRun input parameters
Parameter Description

Configuration name

Required. The previously defined configuration for the plugin.

Use sudo

Use sudo for running the Docker run.

Image name

Required. The image to run a container from.

Container name

Assigns a name to the container.

Detached mode (-d)

Runs the container in the background and prints the new container ID.

Entrypoint

Overwrites the default ENTRYPOINT of the image.

Container working directory

The working directory inside the container.

Publish ports

Publish a container’s port to the host using the following format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort.

Use spaces to delimit port mappings. For example, 2666:1666 8088:8080.

Publish all ports

Publish all exposed ports to the host interfaces.

Privileged

Give extended privileges to this container.

Link

Add a link to another container in the form of name:alias.

Command with args

The command to run within the container.