TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-12-08 23:12:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update docusaurus, add metrics endpoint, add zero downtime update (#4376)

Browse Source 
* chore: update docusuarus to 2.1.0

* docs: metrics endpoint docs

* docs: zero downtime updates

* Update docs/docs/concepts/architecture/solution.md

Co-authored-by: mffap <mpa@zitadel.com>

* Update docs/docs/concepts/architecture/solution.md

Co-authored-by: mffap <mpa@zitadel.com>

* Update docs/docs/concepts/architecture/solution.md

Co-authored-by: mffap <mpa@zitadel.com>

* docs: add health / ready

* Update docs/docs/apis/observability/health.md

Co-authored-by: mffap <mpa@zitadel.com>

Co-authored-by: mffap <mpa@zitadel.com>
This commit is contained in:
Florian Forster
2022-09-15 16:36:02 +02:00
committed by GitHub
parent 84b20bc4e1
commit c14c66820f
6 changed files with 243 additions and 549 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/docs/concepts/architecture/solution.md
View File

@@ -57,3 +57,25 @@ CockroachDB needs to be configured with locality flags to proper distribute data
![Multi-Cluster Architecture](/img/zitadel_multicluster_architecture.png)
## Zero Downtime Updates
Since an Identity system tends to be a critical piece of infrastructure, the "in place zero downtime update" is a well needed feature.
ZITADEL is built in a way that upgrades can be executed without downtime by just updating to a more recent version.
The common update involves the following steps and do not need manual intervention of the operator:
- Keep the old version running
- Deploy the version in parallel to the old version
- The new version will start ...
- by updating databases schemas if needed
- participate in the leader election for background jobs
- As soon as the new version is ready to accept traffic it will signal this on the readiness endpoint `/debug/ready`
- At this point your network infrastructure can send traffic to the new version
Users who use [Kubernetes/Helm](../../guides/deploy/kubernetes) or serverless container services like Google Cloud Run can benefit from the fact the above process is automated.
:::info
As a good practice we recommend creating Database Backups prior to an update.
It is also recommend to read the release notes on GitHub before upgrading.
Since ZITADEL utilizes Semantic Versioning Breaking Changes of any kind will always increase the major version (e.g Version 2 would become Version 3).
:::