Customize usage with labels
Label on container or service can override the default behavior.
You can use the LABEL instruction on the Dockerfile or add label on the run command: docker run -it -d --label dockupdater.disable=true dockupdater/dockupdater
.
See this example of stack file to add a label on a service (Docker swarm):
version: "3.6"
services:
dockupdater:
image: dockupdater/dockupdater
deploy:
labels:
dockupdater.disable: "true"
placement:
constraints:
- node.role == manager
- Disable update
- Enable update
- Latest
- Notifiers
- Recreate first
- Starts
- Stops
- Stop signal
- Template file
- Wait time
Disable update
Label: dockupdater.disable
Availability: containers
services
Example: dockupdater.disable: "true"
Disable update for the service or container.
Enable update
Label: dockupdater.enable
Availability: containers
services
Example: dockupdater.enable: "true"
When dockupdater is start with option –label, this label enable update for container or service.
Latest
Label: dockupdater.latest
Availability: containers
services
Equivalent option: --latests
Example: dockupdater.latest: "true"
With this label, the container or service will always pull the latest tag.
Notifiers
Label: dockupdater.notifiers
Availability: containers
services
Equivalent option: --notifiers
Type: List - Space separated
Example: dockupdater.notifiers: ""
This override the default notifiers. You can disable notification for a specific container or service to set the label to an empty value (like the example). See the notifications documentation.
Recreate first
Label: dockupdater.recreate_first
Availability: containers
Equivalent option: --recreate-first
Example: dockupdater.recreate_first: "true"
To minimize application down time, we could create the new container before deleting the old. See complete documentations on options docs.
Starts
Label: dockupdater.starts
Availability: containers
services
Equivalent option: --start
Example: dockupdater.starts: "weight:1,Service1 Service2 weight:999,Container1"
Override the containers/services to start after an update. Set multiple container/service name or regex pattern by separate it with a space. Can be specified with a weight. See the --start option
for more informations.
Stops
Label: dockupdater.stops
Availability: containers
services
Equivalent option: --stop
Example: dockupdater.starts: "weight:1,Container1 Service2 weight:1,Service1"
Override the containers/services to stop before an update. Set multiple container/service name or regex pattern by separate it with a space. Can be specified with a weight. See the --stop option
for more informations.
Stop signal
Label: dockupdater.stop_signal
Availability: containers
Equivalent option: --stop-signal
Example: dockupdater.stop_signal: 1
Define a stop signal to send to the container instead of SIGKILL. Can be string or int.
Template file
Label: dockupdater.template_file
Availability: containers
services
Equivalent option: --template-file
Example: dockupdater.template_file: "/template.j2"
That override for this container or service the notification message to use. See notifications docs for example.
Wait time
Label: dockupdater.wait
Availability: containers
services
Equivalent option: --wait
Example: dockupdater.wait: 60
Define a time in seconds to wait after an update before updating any others containers or services.
Next: Private Registries