mirrors/diun
1
0
Fork 0
mirror of https://github.com/crazy-max/diun.git synced 2025-12-26 07:13:48 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
7751146359df72414c69b02c1b10c5f8becc244c
diun/docs/config/watch.md
CrazyMax 1115234010 Add CLI to interact with Diun through gRPC (#382) 
Add simple CLI to interact with Diun through gRPC
Create image and notif proto services
Compile and validate protos through a dedicated Dockerfile and bake target
Implement proto definitions
Move server as `serve` command
New commands `image` and `notif`
Refactor command line usage doc
Better CLI error handling
Tools build constraint to manage tools deps through go modules
Add upgrade notes

Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-05-26 18:18:10 +02:00

2.3 KiB
Raw Blame History

Watch configuration

Overview

watch:
  workers: 10
  schedule: "0 */6 * * *"
  firstCheckNotif: false
  compareDigest: true
  healthchecks:
    baseURL: https://hc-ping.com/
    uuid: 5bf66975-d4c7-4bf5-bcc8-b8d8a82ea278

Configuration

workers

Maximum number of workers that will execute tasks concurrently. (default 10)

!!! example "Config file" yaml watch: workers: 10

!!! abstract "Environment variables" * DIUN_WATCH_WORKERS

schedule

CRON expression to schedule Diun.

!!! warning Remove this setting if you want to run Diun directly.

!!! example "Config file" yaml watch: schedule: "0 */6 * * *"

!!! abstract "Environment variables" * DIUN_WATCH_SCHEDULE

firstCheckNotif

Send notification at the very first analysis of an image. (default false)

!!! example "Config file" yaml watch: firstCheckNotif: false

!!! abstract "Environment variables" * DIUN_WATCH_FIRSTCHECKNOTIF

compareDigest

Compare the digest of an image with the registry before downloading the image manifest. It is strongly recommended leaving this value at true, especially with Docker Hub which imposes a rate-limit on image pull. (default true)

!!! example "Config file" yaml watch: compareDigest: true

!!! abstract "Environment variables" * DIUN_WATCH_COMPAREDIGEST

healthchecks

Healthchecks allows monitoring Diun watcher by sending start and success notification events to healthchecks.io.

!!! tip A Docker image for Healthchecks is available if you want to self-host your instance.

!!! example "Config file" yaml watch: healthchecks: baseURL: https://hc-ping.com/ uuid: 5bf66975-d4c7-4bf5-bcc8-b8d8a82ea278

!!! abstract "Environment variables" * DIUN_WATCH_HEALTHCHECKS_BASEURL * DIUN_WATCH_HEALTHCHECKS_UUID

  • baseURL: Base URL for the Healthchecks Ping API (default https://hc-ping.com/).
  • uuid: UUID of an existing healthcheck (required).