dockerCreateContainer

This operation creates a Docker container. It can expose ports and attach volumes. This operation uses Docker CLI, it requires the docker executable to be on the path of the docker endpoint.

Target Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

Docker Unix Socket

FDDKR_UNIX_SOCKET

No

The socket the Docker daemon listens on. Required if Docker Server and Docker Port are not set. Default value is [/var/run/docker.sock]

Docker Server Address

FDDKR_DOCKER_SERVER

No

The IP address of the Docker server.

Docker Port

FDDKR_DOCKER_PORT

No

The port the Docker service is listening on.

Docker Registry Account

FDDKR_REGISTRY_ACCOUNT_CODE

No

The Docker Registry account to use. Required when docker login is needed to pull the image from a remote registry. The plugin input FDDKR_INP_REGISTRY_ACCOUNT_CODE takes precedence over this property.

Please refer to the link to set up the Docker Registry Account: Docker Registry Setup For Cloud Providers

Project Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

Docker Image Name

FDDKR_IMAGE_NAME

No

The name of the docker image, including the repository if desired. i.e. foo/bar or bar. The Docker image use when creating the container. The plugin input FDDKR_INP_IMAGE_NAME takes precedence over this property.

Docker Image Tag

FDDKR_IMAGE_TAG

No

The tag to use when creating the container. The plugin input FDDKR_INP_IMAGE_TAG takes precedence over this property.

Inputs

Input Name

Input Code

Required

Description

Input Name

Input Code

Required

Description

Container Name

FDDKR_INP_CONTAINER_NAME

No

The name of the container to be created.

Image Name

FDDKR_INP_IMAGE_NAME

No

The name of the docker image, including the repository if desired. i.e. foo/bar or bar. The Docker image use when creating the container. This input will take priority over the FDDKR_IMAGE_NAME project property.

Note: If FDDKR_IMAGE_NAME or FDDKR_INP_IMAGE_NAME is specified with preceding “/”, then the registry address from FDDKR_REGISTRY_ACCOUNT_CODE or FDDKR_INP_REGISTRY_ACCOUNT_CODE will get auto prepended to form the full image name.

Example: FDDKR_INP_IMAGE_NAME=/nginximage and registry address corresponding to the FDDKR_REGISTRY_ACCOUNT_CODE is 898334.dkr.ecr.us-east-1.amazonaws.com, then plugin will consider the image name as 898334.dkr.ecr.us-east-1.amazonaws.com/nginximage.

Image Tag

FDDKR_INP_IMAGE_TAG

No

The tag to use when creating the container. This input will take priority over the FDDKR_IMAGE_TAG project property.

Docker File

FDDKR_INP_DOCKER_FILE

No

The path to a Docker file to use in creation of a container. The relative or absolute path or name of docker file to build, defaults to 'Dockerfile'. Relative path will be with respect to source folders or temp directory.

This Input will be ignore if FDDKR_INP_IMAGE_NAME or FDDKR_IMAGE_NAME is provided to create the container.

Docker File Arguments

FDDKR_INP_DOCKER_FILE_ARGS

No

The docker file arguments to use. These are the ARG instructions in the docker file.  KeyValue pairs should be separated by "|" and the key and value should be separated by ",".  Example: key1,value|key2,value|key3,value

Escape commas in values with backslashes. \,

Build Context

FDDKR_INP_BUILD_CONTEXT

No

You can pass the relative or absolute path to a local directory as the context for a build.

Exposed Ports

FDDKR_INP_EXPOSED_PORTS

No

A comma separated list of ports to expose on the container and host. (e.g. 8080:28080,22:20022,[HostPort]:[ContainerPort]) . For example, if your container exposes an application on port 8080 and you want to access it externally from port 9000 you would put 9000:8080

Volumes

FDDKR_INP_VOLUMES

No

A comma separated list of volumes to attach. Note: This will append the given Volume to the list of VOLUME mentioned in the docker file.

Container Entrypoint Commands

FDDKR_INP_CONTAINER_COMMANDS

No

Csv list of entrypoint commands to pass to the container. Note: This will Overwrite the ENTRYPOINT mentioned in the docker file.

Network ID Or Name

FDDKR_INP_NETWORK_ID

No

The ID or name of the network. This will connect the container to the given network.

Docker Registry Account

FDDKR_INP_REGISTRY_ACCOUNT_CODE

No

The Docker Registry account to use. Required when docker login is needed to pull the image from a remote registry. There are a couple different spots to specify this for convenience.

In order of precedence:

  • This plugin input

  • Target Property

Please refer to the link to set up the Docker Registry Account: Docker Registry Setup For Cloud Providers

Additional Options

FDDKR_INP_ADDITIONAL_PARAMS

No

Add any additional Options not listed above, which will be added to the run command. (e.g. --cidfile /test/file.cid -d -e MYVAR1)

Outputs

Output Name

Output Code

Required

Description

Output Name

Output Code

Required

Description

Container ID

FDDKR_OUT_CONTAINER_ID

No

The ID of the created container.

Artifacts

This operation does not produce or consume artifacts.

Endpoint Selection

This operation will select all available endpoints associated to the target.

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

The following macros are not currently supported in the footer:
  • style