From a11355f2ee30e2e5b268d8dd2f9973b346d61d96 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Sat, 20 Jun 2020 05:39:38 +0200 Subject: [PATCH] Update CHANGELOG Add migration notes --- CHANGELOG.md | 29 ++++++ docs/migration/v3-to-v4.md | 179 +++++++++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 3 files changed, 209 insertions(+) create mode 100644 docs/migration/v3-to-v4.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 765a88b6..4847dd77 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,34 @@ # Changelog +## 4.0.0 (2020/06/??) + +:warning: See **Migration notes** in the documentation for breaking changes. + +* Docs website with mkdocs (#99) +* Skip dangling images (#98) +* More explicit massage if manifest not found (#94) +* Add swarm example +* Update doc for file and Swarm providers +* Add Kubernetes provider (#25) +* Update Teams notification screenshot (#93) +* Send message as markdown for Gotify and Telegram notifiers +* Add link to respective hub (#40) +* Configuration transposed into environment variables (#82) +* Configuration file not required anymore +* `DIUN_DB` env var renamed `DIUN_DB_PATH` +* Only accept duration as timeout value (`10` becomes `10s`) +* Enhanced documentation (#83) +* Add note about test notifications (#79) +* Improve configuration validation +* Fix telegram init +* All fields in configuration are now _camelCased_ + * `notif.mail.insecure_skip_verify` > `notif.mail.insecureSkipVerify` + * `notif.rocketchat.user_id` > `notif.rocketchat.userID` + * `watch.first_check_notif` > `watch.firstCheckNotif` + * ... +* Docker API version negotiation (#29) +* Add Mattermost compatibility via Slack webhooks (#80) + ## 3.0.0 (2020/05/27) :warning: See **Migration notes** in the documentation for breaking changes. diff --git a/docs/migration/v3-to-v4.md b/docs/migration/v3-to-v4.md new file mode 100644 index 00000000..25240da4 --- /dev/null +++ b/docs/migration/v3-to-v4.md @@ -0,0 +1,179 @@ +# Diun v3 to v4 + +## Timeout value as duration + +Only accept duration as timeout value (`10` becomes `10s`) + +## Configuration transposed into environment variables + +All configuration is now transposed into environment variables. Take a look at the [documentation](../config/index.md#environment-variables) for more details. + +`DIUN_DB` env var has been renamed `DIUN_DB_PATH` to follow environment variables transposition. + +## All fields in configuration are now _camelCased_ + +In order to enable transposition into environmental variables, all fields in configuration are now _camelCased_: + +* `notif.mail.insecure_skip_verify` > `notif.mail.insecureSkipVerify` +* `notif.rocketchat.user_id` > `notif.rocketchat.userID` +* `watch.first_check_notif` > `watch.firstCheckNotif` +* ... + +??? example "v3" + ```yaml + db: + path: diun.db + + watch: + workers: 10 + schedule: "0 * * * *" + first_check_notif: false + + notif: + amqp: + host: localhost + port: 5672 + username: guest + password: guest + exchange: + queue: queue + gotify: + endpoint: http://gotify.foo.com + token: Token123456 + priority: 1 + timeout: 10 + mail: + host: localhost + port: 25 + ssl: false + insecure_skip_verify: false + username: + password: + from: + to: + rocketchat: + endpoint: http://rocket.foo.com:3000 + channel: "#general" + user_id: abcdEFGH012345678 + token: Token123456 + timeout: 10 + script: + cmd: "myprogram" + args: + - "--anarg" + - "another" + slack: + webhook_url: https://hooks.slack.com/services/ABCD12EFG/HIJK34LMN/01234567890abcdefghij + teams: + webhook_url: https://outlook.office.com/webhook/ABCD12EFG/HIJK34LMN/01234567890abcdefghij + telegram: + token: aabbccdd:11223344 + chat_ids: + - 123456789 + - 987654321 + webhook: + endpoint: http://webhook.foo.com/sd54qad89azd5a + method: GET + headers: + Content-Type: application/json + Authorization: Token123456 + timeout: 10 + + regopts: + someregistryoptions: + username: foo + password: bar + timeout: 20 + onemore: + username: foo2 + password: bar2 + insecure_tls: true + + providers: + docker: + watch_stopped: true + swarm: + watch_by_default: true + file: + directory: ./imagesdir + ``` + +??? example "v4" + ```yaml + db: + path: diun.db + + watch: + workers: 10 + schedule: "0 * * * *" + firstCheckNotif: false + + notif: + amqp: + host: localhost + port: 5672 + username: guest + password: guest + queue: queue + gotify: + endpoint: http://gotify.foo.com + token: Token123456 + priority: 1 + timeout: 10s + mail: + host: localhost + port: 25 + ssl: false + insecureSkipVerify: false + from: diun@example.com + to: webmaster@example.com + rocketchat: + endpoint: http://rocket.foo.com:3000 + channel: "#general" + userID: abcdEFGH012345678 + token: Token123456 + timeout: 10s + script: + cmd: "myprogram" + args: + - "--anarg" + - "another" + slack: + webhookURL: https://hooks.slack.com/services/ABCD12EFG/HIJK34LMN/01234567890abcdefghij + teams: + webhookURL: https://outlook.office.com/webhook/ABCD12EFG/HIJK34LMN/01234567890abcdefghij + telegram: + token: aabbccdd:11223344 + chatIDs: + - 123456789 + - 987654321 + webhook: + endpoint: http://webhook.foo.com/sd54qad89azd5a + method: GET + headers: + content-type: application/json + authorization: Token123456 + timeout: 10s + + regopts: + someregistryoptions: + username: foo + password: bar + timeout: 20s + onemore: + username: foo2 + password: bar2 + insecureTLS: true + + providers: + docker: + watchStopped: true + swarm: + watchByDefault: true + kubernetes: + namespaces: + - default + - production + file: + directory: ./imagesdir + ``` diff --git a/mkdocs.yml b/mkdocs.yml index 49518aaf..4fa142d9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -82,6 +82,7 @@ nav: - FAQ: faq.md - Changelog: changelog.md - Migration: + - Diun v3 to v4: migration/v3-to-v4.md - Diun v2 to v3: migration/v2-to-v3.md - Diun v1 to v2: migration/v1-to-v2.md - Diun v0 to v1: migration/v0-to-v1.md