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 |
---|---|---|---|
Docker 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 |
| No | The IP address of the Docker server. |
Docker Port |
| No | The port the Docker service is listening on. |
Docker Registry Account |
| No | The Docker Registry account to use. Required when docker login is needed to pull the image from a remote registry. The plugin input 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 |
---|---|---|---|
Docker 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 |
Docker Image Tag |
| No | The tag to use when creating the container. The plugin input |
Inputs
Input Name | Input Code | Required | Description |
---|---|---|---|
Container Name |
| No | The name of the container to be created. |
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 Note: If Example: |
Image Tag |
| No | The tag to use when creating the container. This input will take priority over the |
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 |
Docker File Arguments |
| 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 |
| No | You can pass the relative or absolute path to a local directory as the context for a build. |
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 |
| 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 |
| 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 |
| No | The ID or name of the network. This will connect the container to the given network. |
Docker Registry Account |
| 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:
Please refer to the link to set up the Docker Registry Account: Docker Registry Setup For Cloud Providers |
Additional Options |
| 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 |
---|---|---|---|
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.
- style