From 2fba12d5c290fa9e400d608a78cbe80e5a90b97d Mon Sep 17 00:00:00 2001 From: Silvan Date: Wed, 11 Oct 2023 11:13:11 +0200 Subject: [PATCH] docs: add technical advisories for eventstore (#6702) * docs: add technical advisories for eventstore --------- Co-authored-by: Florian Forster --- docs/docs/support/advisory/a10004.md | 37 ++++++++++++++++++++++++ docs/docs/support/advisory/a10005.md | 33 +++++++++++++++++++++ docs/docs/support/technical_advisory.mdx | 32 ++++++++++++++++++++ 3 files changed, 102 insertions(+) create mode 100644 docs/docs/support/advisory/a10004.md create mode 100644 docs/docs/support/advisory/a10005.md diff --git a/docs/docs/support/advisory/a10004.md b/docs/docs/support/advisory/a10004.md new file mode 100644 index 0000000000..787c65aeba --- /dev/null +++ b/docs/docs/support/advisory/a10004.md @@ -0,0 +1,37 @@ +--- +title: Technical Advisory 10004 +--- + +## Date and Version + +Version: 2.39.0 + +Date: 2023-10-14 + +## Description + +Due to storage optimisations ZITADEL changes the behaviour of sequences. +This change improves command (create, update, delete) performance of ZITADEL. + +Sequences are no longer unique inside an instance. +From now on sequences are upcounting per aggregate id. +For example sequences of newly created users begin at 1. +Existing sequences remain untouched. + +## Statement + +This change is tracked in the following PR: [new eventstore framework](https://github.com/zitadel/zitadel/issues/5358). +As soon as the release version is published, we will include the version here. + +## Mitigation + +If you use the ListEvents API to scrape events use the creation date instead of the sequence. +If you use sequences on a list of objects it's no longer garanteed to have unique sequences across the list. +Therefore it's recommended to use the change data of the objects instead. + +## Impact + +Once this update has been released and deployed, sequences are no longer unique inside an instance. +ZITADEL will increase parallel write capabilities, because there is no global sequence to track anymore. +Editor service does not respond the different services of ZITADEL anymore, it returns zitadel. +As we are switching to resource based API's there is no need for this field anymore. diff --git a/docs/docs/support/advisory/a10005.md b/docs/docs/support/advisory/a10005.md new file mode 100644 index 0000000000..d414167c9f --- /dev/null +++ b/docs/docs/support/advisory/a10005.md @@ -0,0 +1,33 @@ +--- +title: Technical Advisory 10005 +--- + +## Date and Version + +Version: 2.39.0 + +Date: Calendar week 41/42 2023 + +## Description + +Migrating to version >= 2.39 from < 2.39 will cause down time during setup starts and the new version is started. +This is caused by storage optimisations which replace the `eventstore.events` database table with the new `eventstore.events2` table. +All existing events are migrated during the execution of the `zitadel setup` command. +New events will be inserted into the new `eventstore.events2` table. The old table `evetstore.events` is renamed to `eventstore.events_old` and will be dropped in a future release of ZITADEL. + +## Statement + +This change is tracked in the following PR: [new eventstore framework](https://github.com/zitadel/zitadel/issues/5358). +As soon as the release version is published, we will include the version here. + +## Mitigation + +If you use this table for TRIGGERS or Change data capture please check the new table definition and change your code to use `eventstore.events2`. + +## Impact + +Once the setup step renamed the table. Old versions of ZITADEL are not able to read/write events. + +:::note +If the upgrade fails make sure to rename `eventstore.events_old` to `eventstore.events`. This change enables older ZITADEL versions to work properly. +::: \ No newline at end of file diff --git a/docs/docs/support/technical_advisory.mdx b/docs/docs/support/technical_advisory.mdx index 5149d76fc0..deb87fb3ac 100644 --- a/docs/docs/support/technical_advisory.mdx +++ b/docs/docs/support/technical_advisory.mdx @@ -86,6 +86,38 @@ We understand that these advisories may include breaking changes, and we aim to 2.38.0 Calendar week 41 + + + A-10004 + + Sequence uniquenes + Breaking Behaviour Change + + Due to storage optimisations ZITADEL changes the behaviour of sequences. + This change improves command (create, update, delete) performance of ZITADEL. + Sequences are no longer unique inside an instance. + From now on sequences are upcounting per aggregate id. + For example sequences of newly created users begin at 1. + Existing sequences remain untouched. + + 2.39.0 + 2023-10-14 + + + + A-10005 + + Expected downtime during upgrade + Expected downtime during upgrade + + Migrating to versions >= 2.39 from < 2.39 will cause down time during setup starts and the new version is started. + This is caused by storage optimisations which replace the `eventstore.events` database table with the new `eventstore.events2` table. + All existing events are migrated during the execution of the `zitadel setup` command. + New events will be inserted into the new `eventstore.events2` table. The old table `evetstore.events` is renamed to `eventstore.events_old` and will be dropped in a future release of ZITADEL. + + 2.39.0 + Calendar week 41/42 2023 + ## Subscribe to our Mailing List