TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-01-06 13:57:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add technical advisories for eventstore (#6702)

Browse Source 
* docs: add technical advisories for eventstore

---------

Co-authored-by: Florian Forster <florian@zitadel.com>
This commit is contained in:
Silvan 2023-10-11 11:13:11 +02:00 committed by GitHub
parent 7588f8a0bb
commit 2fba12d5c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 102 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/docs/support/advisory/a10004.md Normal file
View File

@ -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.

33
docs/docs/support/advisory/a10005.md Normal file
View File

@ -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.
:::

32
docs/docs/support/technical_advisory.mdx
View File

@ -86,6 +86,38 @@ We understand that these advisories may include breaking changes, and we aim to
<td>2.38.0</td>
<td>Calendar week 41</td>
</tr>
<tr>
<td>
<a href="./advisory/a10004">A-10004</a>
</td>
<td>Sequence uniquenes</td>
<td>Breaking Behaviour Change</td>
<td>
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.
</td>
<td>2.39.0</td>
<td>2023-10-14</td>
</tr>
<tr>
<td>
<a href="./advisory/a10005">A-10005</a>
</td>
<td>Expected downtime during upgrade</td>
<td>Expected downtime during upgrade</td>
<td>
Migrating to versions &gt;= 2.39 from &lt; 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.
</td>
<td>2.39.0</td>
<td>Calendar week 41/42 2023</td>
</tr>
</table>
## Subscribe to our Mailing List