mirror of
https://github.com/zitadel/zitadel.git
synced 2025-05-01 13:11:07 +00:00
docs: remove beta state of postgresql (#5652)
* docs: remove beta state of postgres * docs: release cycle, support states, postgres * docs: release cycle, support states, postgres * docs: postgreSQL * Update docs/docs/concepts/architecture/software.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/support/general.md Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/support/general.md Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/self-hosting/deploy/overview.mdx Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/support/general.md Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/self-hosting/manage/database/_postgres.mdx Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/support/general.md Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/support/general.md Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/self-hosting/manage/database/_postgres.mdx Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/self-hosting/manage/production.md Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/support/general.md Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/support/general.md Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/support/general.md Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/support/general.md Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/guides/manage/cloud/support.md Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/support/general.md Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/support/general.md Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/support/general.md Co-authored-by: mffap <mpa@zitadel.com> * Update docs/docs/support/general.md Co-authored-by: mffap <mpa@zitadel.com> * fix broken link * replace generic title (search optimization) * new version of sidebars * fix broken links * add back to sidebar --------- Co-authored-by: mffap <mpa@zitadel.com>
This commit is contained in:
parent
9ae46fd4da
commit
a60c9ae4f5
@ -145,4 +145,7 @@ The storage layer of ZITADEL is responsible for multiple things. For example:
|
|||||||
- Backup and restore operation for disaster recovery purpose
|
- Backup and restore operation for disaster recovery purpose
|
||||||
|
|
||||||
ZITADEL currently supports CockroachDB as first choice of storage due to its perfect match for ZITADELs needs.
|
ZITADEL currently supports CockroachDB as first choice of storage due to its perfect match for ZITADELs needs.
|
||||||
PostgreSQL support is currently in beta.
|
Postgres is currently in [Beta](/docs/support/software-release-cycles-support#beta) and will be [Enterprise Supported](/docs/support/software-release-cycles-support#partially-supported) afterwards.
|
||||||
|
Beta state will be removed as soon as [automated tests](https://github.com/zitadel/zitadel/issues/5741) are implemented.
|
||||||
|
Make sure to read our [Production Guide](./self-hosting/manage/production#prefer-cockroachdb) before you decide to use it.
|
||||||
|
|
||||||
|
@ -9,8 +9,9 @@ Since the storage layer takes the heavy lifting of making sure that data in sync
|
|||||||
|
|
||||||
Depending on your projects needs our general recommendation is to run ZITADEL and ZITADELs storage layer across multiple availability zones in the same region or if you need higher guarantees run the storage layer across multiple regions.
|
Depending on your projects needs our general recommendation is to run ZITADEL and ZITADELs storage layer across multiple availability zones in the same region or if you need higher guarantees run the storage layer across multiple regions.
|
||||||
Consult the [CockroachDB documentation](https://www.cockroachlabs.com/docs/) for more details or use the [CockroachCloud Service](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account.html)
|
Consult the [CockroachDB documentation](https://www.cockroachlabs.com/docs/) for more details or use the [CockroachCloud Service](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account.html)
|
||||||
|
Postgres is currently in [Beta](/docs/support/software-release-cycles-support#beta) and will be [Enterprise Supported](/docs/support/software-release-cycles-support#partially-supported) afterwards.
|
||||||
> Postgres support of ZITADEL is currently in beta.
|
Beta state will be removed as soon as [automated tests](https://github.com/zitadel/zitadel/issues/5741) are implemented.
|
||||||
|
Make sure to read our [Production Guide](./self-hosting/manage/production#prefer-cockroachdb) before you decide to use it.
|
||||||
|
|
||||||
## Scalability
|
## Scalability
|
||||||
|
|
||||||
|
@ -2,6 +2,9 @@
|
|||||||
title: Support
|
title: Support
|
||||||
---
|
---
|
||||||
|
|
||||||
|
:::note
|
||||||
|
We describe our [support services](/docs/legal/support-services) and information required in more detail in our legal section. Beware that not all features may be supported by your subscription and consult the [support states](/docs/support/software-release-cycles-support#support-states).
|
||||||
|
:::
|
||||||
In the header you can find a button for the support.
|
In the header you can find a button for the support.
|
||||||
|
|
||||||
Create a new support request with the following information:
|
Create a new support request with the following information:
|
||||||
|
@ -14,7 +14,8 @@ Choose your platform and run ZITADEL with the most minimal configuration possibl
|
|||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- For test environments, ZITADEL does not need many resources, 1 CPU and 512MB memory are more than enough. (With more CPU, the password hashing might be faster)
|
- For test environments, ZITADEL does not need many resources, 1 CPU and 512MB memory are more than enough. (With more CPU, the password hashing might be faster)
|
||||||
- A cockroachDB or Postgresql (currently in beta) as only needed storage
|
- A CockroachDB or Postgresql as only needed storage. Make sure to read our [Production Guide](./self-hosting/manage/production#prefer-cockroachdb) before you decide to use Postgresql.
|
||||||
|
)
|
||||||
|
|
||||||
## Releases
|
## Releases
|
||||||
|
|
||||||
|
@ -1,10 +1,16 @@
|
|||||||
## Postgres
|
## Postgres
|
||||||
|
|
||||||
:::caution
|
:::caution
|
||||||
Postgres extension is currently in beta.
|
PostgreSQL extension is currently in [Beta](/docs/support/software-release-cycles-support#beta).
|
||||||
|
Beta state will be removed as soon as automated tests are implemented. [Github Issue](https://github.com/zitadel/zitadel/issues/5741)
|
||||||
|
:::
|
||||||
|
|
||||||
|
:::caution
|
||||||
|
Be aware that PostgreSQL is only [Enterprise Supported](/docs/support/software-release-cycles-support#partially-supported).
|
||||||
:::
|
:::
|
||||||
|
|
||||||
If you want to use a PostgreSQL database instead of CockroachDB you can [overwrite the default configuration](../configure/configure.mdx).
|
If you want to use a PostgreSQL database instead of CockroachDB you can [overwrite the default configuration](../configure/configure.mdx).
|
||||||
|
Make sure to read our [Production Guide](./self-hosting/manage/production#prefer-cockroachdb) before you decide to use it.
|
||||||
|
|
||||||
Currently versions >= 14 are supported.
|
Currently versions >= 14 are supported.
|
||||||
|
|
||||||
|
@ -71,6 +71,11 @@ as horizontal scaling is much easier than with PostgreSQL.
|
|||||||
Also, if you are concerned about multi-regional data locality,
|
Also, if you are concerned about multi-regional data locality,
|
||||||
[the way to go is with CockroachDB](https://www.cockroachlabs.com/docs/stable/multiregion-overview.html).
|
[the way to go is with CockroachDB](https://www.cockroachlabs.com/docs/stable/multiregion-overview.html).
|
||||||
|
|
||||||
|
The indexes for the database are optimized using load tests from [ZITADEL Cloud](https://zitadel.com),
|
||||||
|
which runs with CockroachDB.
|
||||||
|
If you identify problems with your Postgresql during load tests that indicate that the indexes are not optimized,
|
||||||
|
please create an issue in our [github repository](https://github.com/zitadel/zitadel).
|
||||||
|
|
||||||
### Configure ZITADEL
|
### Configure ZITADEL
|
||||||
|
|
||||||
Depending on your environment, you maybe would want to tweak some settings about how ZITADEL interacts with the database in the database section of your ZITADEL configuration. Read more about your [database configuration options](/docs/self-hosting/manage/database).
|
Depending on your environment, you maybe would want to tweak some settings about how ZITADEL interacts with the database in the database section of your ZITADEL configuration. Read more about your [database configuration options](/docs/self-hosting/manage/database).
|
||||||
|
72
docs/docs/support/software-release-cycles-support.md
Normal file
72
docs/docs/support/software-release-cycles-support.md
Normal file
@ -0,0 +1,72 @@
|
|||||||
|
---
|
||||||
|
title: Support States & Software Release Cycle
|
||||||
|
---
|
||||||
|
|
||||||
|
## Support States
|
||||||
|
|
||||||
|
It's important to note that support may differ depending on the feature, and not all features may be fully supported.
|
||||||
|
We always strive to provide the best support possible for our customers and community,
|
||||||
|
but we may not be able to provide immediate or comprehensive support for all features.
|
||||||
|
Also the support may differ depending on your contracts. Read more about it on our [Legal page](/docs/legal)
|
||||||
|
|
||||||
|
### Supported
|
||||||
|
|
||||||
|
Supported features are those that are guaranteed to work as intended and are fully tested by our team.
|
||||||
|
If you encounter any issues with a supported feature, please contact us by creating a [bug report](https://github.com/zitadel/zitadel/issues/new/choose).
|
||||||
|
We will review the issues according to our [product management process](https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md#product-management).
|
||||||
|
|
||||||
|
In case you are eligible to [support services](/docs/legal/support-services) get in touch via one of our support channels and we will provide prompt response to the issues you may experience and make our best effort to assist you to find a resolution.
|
||||||
|
|
||||||
|
:::info Security Issues
|
||||||
|
Please report any security issues immediately to the indicated address in our [security.txt](https://zitadel.com/.well-known/security.txt)
|
||||||
|
:::
|
||||||
|
|
||||||
|
### Enterprise Supported
|
||||||
|
|
||||||
|
Enterprise supported features are those where we provide support only to users eligible for enterprise [support services](/docs/legal/support-services).
|
||||||
|
These features should be functional for eligible users, but may have some limitations for a broader use.
|
||||||
|
|
||||||
|
If you encounter issues with an enterprise supported feature and you are eligible for enterprise support services, we will provide a prompt response to the issues you may experience and make our best effort to assist you to find a resolution.
|
||||||
|
|
||||||
|
**Enterprise supported features**
|
||||||
|
|
||||||
|
- Database PostgreSQL
|
||||||
|
- LDAP Identity Provider
|
||||||
|
- [Terraform Provider](https://github.com/zitadel/terraform-provider-zitadel)
|
||||||
|
|
||||||
|
### Community Supported
|
||||||
|
|
||||||
|
Community supported features are those that have been developed by our community and may not have undergone extensive testing or support from our team.
|
||||||
|
If you encounter issues with a community supported feature, we encourage you to seek help from our community or other online resources, where other users can provide assistance:
|
||||||
|
|
||||||
|
- Join our [Discord Chat](https://zitadel.com/chat)
|
||||||
|
- Search [Github Issues](https://github.com/search?q=org%3Azitadel+&type=issues) and report a new issue
|
||||||
|
- Search [Github Discussions](https://github.com/search?q=org%3Azitadel+&type=discussions) and open a new discussion as question or idea
|
||||||
|
|
||||||
|
## Software Release Cycle
|
||||||
|
|
||||||
|
It's important to note that both Alpha and Beta software can have breaking changes, meaning they are not backward-compatible with previous versions of the software.
|
||||||
|
Therefore, it's recommended to use caution when using Alpha and Beta software, and to always back up important data before installing or testing new software versions.
|
||||||
|
|
||||||
|
Only features in General Availability will be covered by support services.
|
||||||
|
|
||||||
|
We encourage our community to test Alpha and Beta software and provide feedback via our [Discord Chat](https://zitadel.com/chat).
|
||||||
|
|
||||||
|
### Alpha
|
||||||
|
|
||||||
|
The Alpha state is our initial testing phase.
|
||||||
|
It is available to everyone, but it is not yet complete and may contain bugs and incomplete features.
|
||||||
|
We recommend that users exercise caution when using Alpha software and avoid using it for critical tasks, as support is limited during this phase.
|
||||||
|
|
||||||
|
### Beta
|
||||||
|
|
||||||
|
The Beta state comes after the Alpha phase and is a more stable version of the software.
|
||||||
|
It is feature-complete, but may still contain bugs that need to be fixed before general availability.
|
||||||
|
While it is available to everyone, we recommend that users exercise caution when using Beta software and avoid using it for critical tasks.
|
||||||
|
During this phase, support is limited as we focus on testing and bug fixing.
|
||||||
|
|
||||||
|
### General Available
|
||||||
|
|
||||||
|
Generally available features are available to everyone and have the appropriate test coverage to be used for critical tasks.
|
||||||
|
The software will be backwards-compatible with previous versions, for exceptions we will publish a [technical advisory](https://zitadel.com/docs/support/technical_advisory).
|
||||||
|
Features in General Availability are not marked explicitly.
|
@ -322,6 +322,7 @@ module.exports = {
|
|||||||
label: "Support",
|
label: "Support",
|
||||||
collapsed: true,
|
collapsed: true,
|
||||||
items: [
|
items: [
|
||||||
|
"support/software-release-cycles-support",
|
||||||
"support/troubleshooting",
|
"support/troubleshooting",
|
||||||
{
|
{
|
||||||
type: 'category',
|
type: 'category',
|
||||||
@ -549,8 +550,6 @@ module.exports = {
|
|||||||
],
|
],
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
support: [
|
|
||||||
],
|
|
||||||
legal: [
|
legal: [
|
||||||
{
|
{
|
||||||
type: "category",
|
type: "category",
|
||||||
|
Loading…
x
Reference in New Issue
Block a user