first commit
This commit is contained in:
79
modules/20-services-apps/watchtower/README.md
Normal file
79
modules/20-services-apps/watchtower/README.md
Normal file
@@ -0,0 +1,79 @@
|
||||
# Watchtower Module
|
||||
|
||||
This module deploys a Watchtower container which automatically updates your running Docker containers when new images become available.
|
||||
|
||||
## Features
|
||||
|
||||
- Automatic updates for Docker containers
|
||||
- Configurable update schedule
|
||||
- Optional cleanup of old images
|
||||
- Notification support via shoutrrr
|
||||
- Container monitoring options
|
||||
|
||||
## Usage
|
||||
|
||||
To use this module in your root module, add the following code:
|
||||
|
||||
```hcl
|
||||
module "watchtower" {
|
||||
source = "./modules/20-services-apps/watchtower"
|
||||
|
||||
# Basic configuration
|
||||
container_name = "watchtower"
|
||||
image_tag = "latest"
|
||||
timezone = "Australia/Sydney"
|
||||
|
||||
# Update settings
|
||||
poll_interval = 86400 # Check once per day (in seconds)
|
||||
cleanup = true # Remove old images after updating
|
||||
rolling_restart = true # Update containers one by one
|
||||
|
||||
# Optional notification settings
|
||||
enable_notifications = false
|
||||
# notification_url = "discord://webhook-id/webhook-token"
|
||||
|
||||
# Additional settings as needed
|
||||
# additional_env_vars = {
|
||||
# WATCHTOWER_MONITOR_ONLY = "true"
|
||||
# }
|
||||
}
|
||||
```
|
||||
|
||||
## Required Resources
|
||||
|
||||
This module leverages the generic `docker-service` module, which handles the Docker container deployment.
|
||||
|
||||
## Input Variables
|
||||
|
||||
| Name | Description | Type | Default |
|
||||
|------|-------------|------|---------|
|
||||
| container_name | Name for the Watchtower container | string | "watchtower" |
|
||||
| image_tag | The tag for the Watchtower container image | string | "latest" |
|
||||
| restart_policy | Restart policy for the container | string | "unless-stopped" |
|
||||
| timezone | Timezone for the container | string | "Etc/UTC" |
|
||||
| cleanup | Remove old images after updating | bool | true |
|
||||
| poll_interval | Poll interval (in seconds) for checking updates | number | 86400 |
|
||||
| include_stopped | Include stopped containers when checking for updates | bool | false |
|
||||
| revive_stopped | Restart stopped containers after updating | bool | false |
|
||||
| rolling_restart | Restart containers one by one instead of all at once | bool | true |
|
||||
| notification_url | URL for sending update notifications via shoutrrr | string | "" |
|
||||
| enable_notifications | Enable shoutrrr notifications | bool | false |
|
||||
| additional_env_vars | Additional environment variables for Watchtower | map(string) | {} |
|
||||
| additional_volumes | Additional volumes to mount in the container | list(object) | [] |
|
||||
| labels | Labels to set on the container | map(string) | {} |
|
||||
| ports | Ports to expose (rarely needed for Watchtower) | list(object) | [] |
|
||||
| monitoring | Enable monitoring for the container | bool | true |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Name | Description |
|
||||
|------|-------------|
|
||||
| container_name | Name of the created Watchtower container |
|
||||
| container_id | ID of the created Watchtower container |
|
||||
| image_id | ID of the Watchtower image used |
|
||||
|
||||
## Notes
|
||||
|
||||
- Watchtower needs access to the Docker socket to monitor and update containers
|
||||
- For security-conscious environments, consider limiting which containers Watchtower can update
|
||||
- See the [Watchtower documentation](https://containrrr.dev/watchtower/) for more advanced configuration options
|
||||
58
modules/20-services-apps/watchtower/main.tf
Normal file
58
modules/20-services-apps/watchtower/main.tf
Normal file
@@ -0,0 +1,58 @@
|
||||
// Watchtower module for automatic Docker container updates
|
||||
// This module configures a Watchtower container that monitors and updates other containers
|
||||
|
||||
locals {
|
||||
container_name = var.container_name != "" ? var.container_name : "watchtower"
|
||||
image_tag = var.image_tag != "" ? var.image_tag : "latest"
|
||||
|
||||
default_env_vars = {
|
||||
TZ = var.timezone
|
||||
WATCHTOWER_CLEANUP = var.cleanup
|
||||
WATCHTOWER_POLL_INTERVAL = var.poll_interval
|
||||
WATCHTOWER_INCLUDE_STOPPED = var.include_stopped
|
||||
WATCHTOWER_REVIVE_STOPPED = var.revive_stopped
|
||||
WATCHTOWER_ROLLING_RESTART = var.rolling_restart
|
||||
WATCHTOWER_NOTIFICATION_URL = var.notification_url
|
||||
WATCHTOWER_NOTIFICATIONS = var.enable_notifications ? "shoutrrr" : ""
|
||||
}
|
||||
|
||||
// Merge default env vars with any additional ones provided
|
||||
env_vars = merge(local.default_env_vars, var.additional_env_vars)
|
||||
|
||||
// Default volumes for Docker socket access
|
||||
default_volumes = [
|
||||
{
|
||||
host_path = "/var/run/docker.sock"
|
||||
container_path = "/var/run/docker.sock"
|
||||
read_only = true
|
||||
}
|
||||
]
|
||||
|
||||
// Merge default volumes with any additional ones provided
|
||||
volumes = concat(local.default_volumes, var.additional_volumes)
|
||||
}
|
||||
|
||||
// Use the generic docker-service module to deploy Watchtower
|
||||
module "watchtower" {
|
||||
source = "../../10-services-generic/docker-service"
|
||||
|
||||
container_name = local.container_name
|
||||
image = "containrrr/watchtower"
|
||||
tag = local.image_tag
|
||||
|
||||
restart_policy = var.restart_policy
|
||||
network_mode = "bridge"
|
||||
|
||||
env_vars = local.env_vars
|
||||
volumes = local.volumes
|
||||
|
||||
labels = var.labels
|
||||
|
||||
// Watchtower doesn't typically expose ports but we'll include the option
|
||||
ports = var.ports
|
||||
|
||||
// Add monitoring label if enabled
|
||||
monitoring = var.monitoring
|
||||
|
||||
depends_on = []
|
||||
}
|
||||
14
modules/20-services-apps/watchtower/outputs.tf
Normal file
14
modules/20-services-apps/watchtower/outputs.tf
Normal file
@@ -0,0 +1,14 @@
|
||||
output "container_name" {
|
||||
description = "Name of the created Watchtower container"
|
||||
value = module.watchtower.container_name
|
||||
}
|
||||
|
||||
output "container_id" {
|
||||
description = "ID of the created Watchtower container"
|
||||
value = module.watchtower.container_id
|
||||
}
|
||||
|
||||
output "image_id" {
|
||||
description = "ID of the Watchtower image used"
|
||||
value = module.watchtower.image_id
|
||||
}
|
||||
103
modules/20-services-apps/watchtower/variables.tf
Normal file
103
modules/20-services-apps/watchtower/variables.tf
Normal file
@@ -0,0 +1,103 @@
|
||||
variable "container_name" {
|
||||
description = "Name for the Watchtower container"
|
||||
type = string
|
||||
default = "watchtower"
|
||||
}
|
||||
|
||||
variable "image_tag" {
|
||||
description = "The tag for the Watchtower container image"
|
||||
type = string
|
||||
default = "latest"
|
||||
}
|
||||
|
||||
variable "restart_policy" {
|
||||
description = "Restart policy for the container"
|
||||
type = string
|
||||
default = "unless-stopped"
|
||||
}
|
||||
|
||||
variable "timezone" {
|
||||
description = "Timezone for the container"
|
||||
type = string
|
||||
default = "Etc/UTC"
|
||||
}
|
||||
|
||||
variable "cleanup" {
|
||||
description = "Remove old images after updating"
|
||||
type = bool
|
||||
default = true
|
||||
}
|
||||
|
||||
variable "poll_interval" {
|
||||
description = "Poll interval (in seconds) for checking for updates"
|
||||
type = number
|
||||
default = 86400 // Default: check once per day
|
||||
}
|
||||
|
||||
variable "include_stopped" {
|
||||
description = "Include stopped containers when checking for updates"
|
||||
type = bool
|
||||
default = false
|
||||
}
|
||||
|
||||
variable "revive_stopped" {
|
||||
description = "Restart stopped containers after updating"
|
||||
type = bool
|
||||
default = false
|
||||
}
|
||||
|
||||
variable "rolling_restart" {
|
||||
description = "Restart containers one by one instead of all at once"
|
||||
type = bool
|
||||
default = true
|
||||
}
|
||||
|
||||
variable "notification_url" {
|
||||
description = "URL for sending update notifications via shoutrrr"
|
||||
type = string
|
||||
default = ""
|
||||
}
|
||||
|
||||
variable "enable_notifications" {
|
||||
description = "Enable shoutrrr notifications"
|
||||
type = bool
|
||||
default = false
|
||||
}
|
||||
|
||||
variable "additional_env_vars" {
|
||||
description = "Additional environment variables for Watchtower"
|
||||
type = map(string)
|
||||
default = {}
|
||||
}
|
||||
|
||||
variable "additional_volumes" {
|
||||
description = "Additional volumes to mount in the container"
|
||||
type = list(object({
|
||||
host_path = string
|
||||
container_path = string
|
||||
read_only = bool
|
||||
}))
|
||||
default = []
|
||||
}
|
||||
|
||||
variable "labels" {
|
||||
description = "Labels to set on the container"
|
||||
type = map(string)
|
||||
default = {}
|
||||
}
|
||||
|
||||
variable "ports" {
|
||||
description = "Ports to expose (Watchtower typically doesn't need ports exposed)"
|
||||
type = list(object({
|
||||
internal = number
|
||||
external = number
|
||||
protocol = string
|
||||
}))
|
||||
default = []
|
||||
}
|
||||
|
||||
variable "monitoring" {
|
||||
description = "Enable monitoring for the container"
|
||||
type = bool
|
||||
default = true
|
||||
}
|
||||
Reference in New Issue
Block a user