Docker: Update Container
Description
Docker: Update Container step is used to update one or more container.
Important:
The step is not supported for Windows containers.
Reference
Configurations
| Field names | Description |
|---|---|
| Step Name | Specify a unique step name. |
| CONNECTION tab: | Connection fields |
| Configuration Type | Select the configuration type, that is, SSH or SSL-TLS. |
| Configuration type: SSH | |
| Server Name | Specify the Server Name or IP Address of the server where the Docker daemon is running. The field data type is String. This field is mandatory. |
| Port | Specify a valid port. The field data type is String. This field is mandatory. |
| Username | Specify the valid Username to connect to server or where the Docker Daemon running. The field data type is String. This field is mandatory. |
| Accept value as variable/static | Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Password field to appear as Text box. |
| Password | Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). The Data Type is String. This field is mandatory. If checkbox above is enabled Password field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. |
| Use Key | Select if you want to use the key. Allowed values are Yes or No. |
| Private Key | Specify a valid private key path. |
| Browse | Click to extract the private key path. |
| Passphrase | Specify a valid passphrase. |
| Proxy Host | Specify the proxy host or IP address of the proxy host. |
| Proxy Username | Specify a valid proxy user name. |
| Proxy Password | Specify a valid proxy password. |
| Configuration type: SSL-TLS | |
| Docker Host URI | Select a valid Docker Host URI on which Docker Daemon is running. Note: If you set the DOCKER_HOST then no need to provide the Docker host URI. |
| CA path (.pem) | Select a valid ca.pem (Certificate authority that signed) file path. Note: If you want to secure your Docker client connections by default, you can move the files to the .docker directory in your home directory, and also set the DOCKER_TLS_VERIFY variables. |
| Cert Path (.pem) | Select valid cert.pem (Client certificate) file path. |
| Key Path (.pem) | Select valid Key.pem (Client key) file path. |
| Test Connection | Verifies if the connection is established or not. Note: Test connection verifies if the connection is established or not. Even if the SSL-TLS connection parameters are not provided, the verification of the connection is done based on the settings provided in the connection documentation. |
| INPUT tab: | Input fields |
| Container ID/Name | Select one or more Container IDs or Name of the container to update. The field data type is String. This field is mandatory. |
| Options/Flags | Provide valid options or flags to create a container. Click the following link to get the list of flags: https://docs.docker.com/engine/reference/commandline/update#options The field data type is String. This field is mandatory. |
| Variable Field Name | Provide supported ‘Options/Flags’ value. For a list of ‘Options/Flags’ see Additional notes. The field data type is String. This field is mandatory. |
| Static Field Name | Select Options/Flags value from the list provided in the dialog. The field data type is String. This field is mandatory. |
| Field Value | Provide valid field value. The field data type is String. This field is mandatory. |
| Max Wait For Response (Sec) | Specify the amount of time to wait for a response. The default value is 10 sec. |
Additional notes
List of supported options or flags.
| Name | Options |
|---|---|
| --blkio-weight | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) |
| --cpu-period | Limit CPU CFS (Completely Fair Scheduler) period |
| --cpu-quota | Limit CPU CFS (Completely Fair Scheduler) quota |
| --cpu-rt-period | Limit the CPU real-time period in microseconds |
| --cpu-rt-runtime | Limit the CPU real-time runtime in microseconds |
| --cpu-shares | CPU shares (relative weight) |
| --cpus | Number of CPUs |
| --cpuset-cpus | CPUs in which to allow execution (0-3, 0,1) |
| --cpuset-mems | MEMs in which to allow execution (0-3, 0,1) |
| --kernel-memory | Kernel memory limit |
| --memory | Memory limit |
| --memory-reservation | Memory soft limit |
| --memory-swap | Swap limit equal to memory plus swap: '-1' to enable unlimited swap |
| --pids-limit | Tune container pids limit (set -1 for unlimited) |
| --restart | Restart policy to apply when a container exits |