diff --git a/en/identity-server/7.0.0/docs/assets/img/setup/deploy/separate-databases-for-clustering.png b/en/identity-server/7.0.0/docs/assets/img/setup/deploy/separate-databases-for-clustering.png index 47b90c6d75..716f0d1f5e 100644 Binary files a/en/identity-server/7.0.0/docs/assets/img/setup/deploy/separate-databases-for-clustering.png and b/en/identity-server/7.0.0/docs/assets/img/setup/deploy/separate-databases-for-clustering.png differ diff --git a/en/identity-server/7.0.0/docs/deploy/configure/databases/carbon-database/change-datasource-consent-management.md b/en/identity-server/7.0.0/docs/deploy/configure/databases/carbon-database/change-datasource-consent-management.md index 43a1abf7cf..108bb92859 100644 --- a/en/identity-server/7.0.0/docs/deploy/configure/databases/carbon-database/change-datasource-consent-management.md +++ b/en/identity-server/7.0.0/docs/deploy/configure/databases/carbon-database/change-datasource-consent-management.md @@ -5,7 +5,7 @@ These default databases are located in the `/repository/database` direc of the pack. By default, consent management data is stored in the identity database (IDENTITY_DB) with -Identity and UMA data. However, you can separate consent specific data into a separate +Identity data. However, you can separate consent specific data into a separate datasource to any database type that is supported by WSO2 Identity Server. !!! note diff --git a/en/identity-server/7.0.0/docs/deploy/configure/databases/carbon-database/change-datasource-session.md b/en/identity-server/7.0.0/docs/deploy/configure/databases/carbon-database/change-datasource-session.md index cba0a5a34c..73921ea807 100644 --- a/en/identity-server/7.0.0/docs/deploy/configure/databases/carbon-database/change-datasource-session.md +++ b/en/identity-server/7.0.0/docs/deploy/configure/databases/carbon-database/change-datasource-session.md @@ -7,7 +7,7 @@ These default databases are located in the `/repository/database` direc of the pack. By default, session data is stored in the identity database (IDENTITY_DB) with -Identity and UMA data. However, you can separate session specific data into a separate +Identity data. However, you can separate session specific data into a separate datasource to any database type that is supported by WSO2 Identity Server. !!! note diff --git a/en/identity-server/7.0.0/docs/deploy/set-up-separate-databases-for-clustering.md b/en/identity-server/7.0.0/docs/deploy/set-up-separate-databases-for-clustering.md index 6f1ff98ac2..7cd88b9219 100644 --- a/en/identity-server/7.0.0/docs/deploy/set-up-separate-databases-for-clustering.md +++ b/en/identity-server/7.0.0/docs/deploy/set-up-separate-databases-for-clustering.md @@ -1,75 +1 @@ -# Seperate Databases for Clustering - -WSO2 Identity Server uses a database to store information such as user management details and identity data. By default, WSO2 Identity Server is shipped with an embedded H2 database that works for all types of data. - -This section guides you through the logical separation of data that you -can do when clustering WSO2 Identity Server. - -!!! warning "Embedded H2 is NOT RECOMMENDED in production" - The embedded H2 database is not recommended for enterprise testing and production environments. It has lower performance, and clustering limitations, and can cause file corruption failures. Therefore, use an industry-standard RDBMS such as Oracle, PostgreSQL, MySQL, or MS SQL instead. - - !!! tip "Before you begin" - Creating separate databases as shown below is not mandatory. Instead, you can point to all the following data sources according to the default data structure. This will not make a difference in performance. - -The following image shows the default database structure and a recommended database structure for the logical separation of data. - -![Separate-databases-for-clustering]({{base_path}}/assets/img/setup/deploy/separate-databases-for-clustering.png) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Database NameDescription
USERSTORE_DB -
  • Mainly contains users and roles of the system
    • -
  • Contains authorization manager configurations, internal permissions, and roles
    • -
  • In the default database configuration, user data and registry data are located inside SHARED_DB. -.
    • -
  • For more information, see Configure Userstores.
    • -
    IDENTITY_DB -
  • This contains identity-related data. For example, user sessions, OAuth 2.0, SAML 2.0, User Managed Access (UMA), etc.
    • -
  • In the default database configuration, all the UMA, consent, and identity data are located in the IDENTITY_DB. In a deployment, both identity and UMA can be configured in a single database while consent data is configured to a separate database `CONSENT_MGT`
    • . - -
    BPS_DB -
  • This is used to create, drop, and truncate data pertaining to the workflow feature.
    • - -
    SHARED_DB -
  • This is the shared database for config and governance registry mounts in WSO2 Identity Server's nodes. This includes data on tenants and keystores.
    • -
  • In the default database configuration, user data and registry data are located inside SHARED_DB. -During a deployment, user data can be configured to a different database, USERSTORE_DB while the registry - data remains in the SHARED_DB -.
    • - -
    CONSENT_MGT -
  • Used for data pertaining to user consents
    • -
  • In the default database configuration, UMA, consent, and identity data are located IDENTITY_DB. -In a deployment, both identity and UMA can be configured in a single database while consent data is configured to a separate database.
    • - -
    - - +{% include "../../../../includes/deploy/configure/databases/clustering.md" %} diff --git a/en/identity-server/7.1.0/docs/assets/img/setup/deploy/separate-databases-for-clustering.png b/en/identity-server/7.1.0/docs/assets/img/setup/deploy/separate-databases-for-clustering.png index 47b90c6d75..716f0d1f5e 100644 Binary files a/en/identity-server/7.1.0/docs/assets/img/setup/deploy/separate-databases-for-clustering.png and b/en/identity-server/7.1.0/docs/assets/img/setup/deploy/separate-databases-for-clustering.png differ diff --git a/en/identity-server/7.1.0/docs/deploy/configure/databases/carbon-database/change-datasource-consent-management.md b/en/identity-server/7.1.0/docs/deploy/configure/databases/carbon-database/change-datasource-consent-management.md index 43a1abf7cf..108bb92859 100644 --- a/en/identity-server/7.1.0/docs/deploy/configure/databases/carbon-database/change-datasource-consent-management.md +++ b/en/identity-server/7.1.0/docs/deploy/configure/databases/carbon-database/change-datasource-consent-management.md @@ -5,7 +5,7 @@ These default databases are located in the `/repository/database` direc of the pack. By default, consent management data is stored in the identity database (IDENTITY_DB) with -Identity and UMA data. However, you can separate consent specific data into a separate +Identity data. However, you can separate consent specific data into a separate datasource to any database type that is supported by WSO2 Identity Server. !!! note diff --git a/en/identity-server/7.1.0/docs/deploy/configure/databases/carbon-database/change-datasource-session.md b/en/identity-server/7.1.0/docs/deploy/configure/databases/carbon-database/change-datasource-session.md index cba0a5a34c..73921ea807 100644 --- a/en/identity-server/7.1.0/docs/deploy/configure/databases/carbon-database/change-datasource-session.md +++ b/en/identity-server/7.1.0/docs/deploy/configure/databases/carbon-database/change-datasource-session.md @@ -7,7 +7,7 @@ These default databases are located in the `/repository/database` direc of the pack. By default, session data is stored in the identity database (IDENTITY_DB) with -Identity and UMA data. However, you can separate session specific data into a separate +Identity data. However, you can separate session specific data into a separate datasource to any database type that is supported by WSO2 Identity Server. !!! note diff --git a/en/identity-server/7.1.0/docs/deploy/set-up-separate-databases-for-clustering.md b/en/identity-server/7.1.0/docs/deploy/set-up-separate-databases-for-clustering.md index 6f1ff98ac2..7cd88b9219 100644 --- a/en/identity-server/7.1.0/docs/deploy/set-up-separate-databases-for-clustering.md +++ b/en/identity-server/7.1.0/docs/deploy/set-up-separate-databases-for-clustering.md @@ -1,75 +1 @@ -# Seperate Databases for Clustering - -WSO2 Identity Server uses a database to store information such as user management details and identity data. By default, WSO2 Identity Server is shipped with an embedded H2 database that works for all types of data. - -This section guides you through the logical separation of data that you -can do when clustering WSO2 Identity Server. - -!!! warning "Embedded H2 is NOT RECOMMENDED in production" - The embedded H2 database is not recommended for enterprise testing and production environments. It has lower performance, and clustering limitations, and can cause file corruption failures. Therefore, use an industry-standard RDBMS such as Oracle, PostgreSQL, MySQL, or MS SQL instead. - - !!! tip "Before you begin" - Creating separate databases as shown below is not mandatory. Instead, you can point to all the following data sources according to the default data structure. This will not make a difference in performance. - -The following image shows the default database structure and a recommended database structure for the logical separation of data. - -![Separate-databases-for-clustering]({{base_path}}/assets/img/setup/deploy/separate-databases-for-clustering.png) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Database NameDescription
    USERSTORE_DB -
  • Mainly contains users and roles of the system
    • -
  • Contains authorization manager configurations, internal permissions, and roles
    • -
  • In the default database configuration, user data and registry data are located inside SHARED_DB. -.
    • -
  • For more information, see Configure Userstores.
    • -
    IDENTITY_DB -
  • This contains identity-related data. For example, user sessions, OAuth 2.0, SAML 2.0, User Managed Access (UMA), etc.
    • -
  • In the default database configuration, all the UMA, consent, and identity data are located in the IDENTITY_DB. In a deployment, both identity and UMA can be configured in a single database while consent data is configured to a separate database `CONSENT_MGT`
    • . - -
    BPS_DB -
  • This is used to create, drop, and truncate data pertaining to the workflow feature.
    • - -
    SHARED_DB -
  • This is the shared database for config and governance registry mounts in WSO2 Identity Server's nodes. This includes data on tenants and keystores.
    • -
  • In the default database configuration, user data and registry data are located inside SHARED_DB. -During a deployment, user data can be configured to a different database, USERSTORE_DB while the registry - data remains in the SHARED_DB -.
    • - -
    CONSENT_MGT -
  • Used for data pertaining to user consents
    • -
  • In the default database configuration, UMA, consent, and identity data are located IDENTITY_DB. -In a deployment, both identity and UMA can be configured in a single database while consent data is configured to a separate database.
    • - -
    - - +{% include "../../../../includes/deploy/configure/databases/clustering.md" %} diff --git a/en/identity-server/next/docs/assets/img/setup/deploy/separate-databases-for-clustering.png b/en/identity-server/next/docs/assets/img/setup/deploy/separate-databases-for-clustering.png index 47b90c6d75..716f0d1f5e 100644 Binary files a/en/identity-server/next/docs/assets/img/setup/deploy/separate-databases-for-clustering.png and b/en/identity-server/next/docs/assets/img/setup/deploy/separate-databases-for-clustering.png differ diff --git a/en/identity-server/next/docs/deploy/configure/databases/carbon-database/change-datasource-consent-management.md b/en/identity-server/next/docs/deploy/configure/databases/carbon-database/change-datasource-consent-management.md index 43a1abf7cf..108bb92859 100644 --- a/en/identity-server/next/docs/deploy/configure/databases/carbon-database/change-datasource-consent-management.md +++ b/en/identity-server/next/docs/deploy/configure/databases/carbon-database/change-datasource-consent-management.md @@ -5,7 +5,7 @@ These default databases are located in the `/repository/database` direc of the pack. By default, consent management data is stored in the identity database (IDENTITY_DB) with -Identity and UMA data. However, you can separate consent specific data into a separate +Identity data. However, you can separate consent specific data into a separate datasource to any database type that is supported by WSO2 Identity Server. !!! note diff --git a/en/identity-server/next/docs/deploy/configure/databases/carbon-database/change-datasource-session.md b/en/identity-server/next/docs/deploy/configure/databases/carbon-database/change-datasource-session.md index cba0a5a34c..73921ea807 100644 --- a/en/identity-server/next/docs/deploy/configure/databases/carbon-database/change-datasource-session.md +++ b/en/identity-server/next/docs/deploy/configure/databases/carbon-database/change-datasource-session.md @@ -7,7 +7,7 @@ These default databases are located in the `/repository/database` direc of the pack. By default, session data is stored in the identity database (IDENTITY_DB) with -Identity and UMA data. However, you can separate session specific data into a separate +Identity data. However, you can separate session specific data into a separate datasource to any database type that is supported by WSO2 Identity Server. !!! note diff --git a/en/identity-server/next/docs/deploy/set-up-separate-databases-for-clustering.md b/en/identity-server/next/docs/deploy/set-up-separate-databases-for-clustering.md index 6f1ff98ac2..7cd88b9219 100644 --- a/en/identity-server/next/docs/deploy/set-up-separate-databases-for-clustering.md +++ b/en/identity-server/next/docs/deploy/set-up-separate-databases-for-clustering.md @@ -1,75 +1 @@ -# Seperate Databases for Clustering - -WSO2 Identity Server uses a database to store information such as user management details and identity data. By default, WSO2 Identity Server is shipped with an embedded H2 database that works for all types of data. - -This section guides you through the logical separation of data that you -can do when clustering WSO2 Identity Server. - -!!! warning "Embedded H2 is NOT RECOMMENDED in production" - The embedded H2 database is not recommended for enterprise testing and production environments. It has lower performance, and clustering limitations, and can cause file corruption failures. Therefore, use an industry-standard RDBMS such as Oracle, PostgreSQL, MySQL, or MS SQL instead. - - !!! tip "Before you begin" - Creating separate databases as shown below is not mandatory. Instead, you can point to all the following data sources according to the default data structure. This will not make a difference in performance. - -The following image shows the default database structure and a recommended database structure for the logical separation of data. - -![Separate-databases-for-clustering]({{base_path}}/assets/img/setup/deploy/separate-databases-for-clustering.png) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Database NameDescription
    USERSTORE_DB -
  • Mainly contains users and roles of the system
    • -
  • Contains authorization manager configurations, internal permissions, and roles
    • -
  • In the default database configuration, user data and registry data are located inside SHARED_DB. -.
    • -
  • For more information, see Configure Userstores.
    • -
    IDENTITY_DB -
  • This contains identity-related data. For example, user sessions, OAuth 2.0, SAML 2.0, User Managed Access (UMA), etc.
    • -
  • In the default database configuration, all the UMA, consent, and identity data are located in the IDENTITY_DB. In a deployment, both identity and UMA can be configured in a single database while consent data is configured to a separate database `CONSENT_MGT`
    • . - -
    BPS_DB -
  • This is used to create, drop, and truncate data pertaining to the workflow feature.
    • - -
    SHARED_DB -
  • This is the shared database for config and governance registry mounts in WSO2 Identity Server's nodes. This includes data on tenants and keystores.
    • -
  • In the default database configuration, user data and registry data are located inside SHARED_DB. -During a deployment, user data can be configured to a different database, USERSTORE_DB while the registry - data remains in the SHARED_DB -.
    • - -
    CONSENT_MGT -
  • Used for data pertaining to user consents
    • -
  • In the default database configuration, UMA, consent, and identity data are located IDENTITY_DB. -In a deployment, both identity and UMA can be configured in a single database while consent data is configured to a separate database.
    • - -
    - - +{% include "../../../../includes/deploy/configure/databases/clustering.md" %} diff --git a/en/includes/deploy/configure/databases/clustering.md b/en/includes/deploy/configure/databases/clustering.md new file mode 100644 index 0000000000..af1e1a123e --- /dev/null +++ b/en/includes/deploy/configure/databases/clustering.md @@ -0,0 +1,38 @@ +# Separate databases for clustering + +WSO2 Identity Server uses a database to store information such as user management details and identity data. By default, WSO2 Identity Server is shipped with an embedded H2 database that works for all types of data. + +!!! warning "Embedded H2 is NOT RECOMMENDED in production" + The embedded H2 database doesn't suit enterprise testing or production. It gives lower performance, clustering limitations, and file corruption failures. Use an industry-standard RDBMS such as Oracle, PostgreSQL, MySQL, or MS SQL. + +!!! tip "Before you begin" + Creating separate databases as shown below isn't mandatory. You can point all the following data sources to the default data structure. This does not affect performance. For more information, see [Working with Databases]({{base_path}}/deploy/work-with-databases). + +The following image shows the default database structure and a recommended database structure for logical separation. + +![Separate-databases-for-clustering]({{base_path}}/assets/img/setup/deploy/separate-databases-for-clustering.png) + +**SHARED_DB** + +- Shared database for config and governance registry mounts in WSO2 Identity Server's nodes. This includes data on tenants and keystores. +- For more information, see [Change the default databases]({{base_path}}/deploy/configure/databases/carbon-database). + +**USERSTORE_DB** + +- Mainly contains users and roles of the system. +- Contains authorization manager configurations, internal permissions, and roles. +- Userstore databases separation is required when using an external userstore such as LDAP or Active Directory. +- For more information, see [Configure Userstores]({{base_path}}/guides/users/user-stores/). + +**IDENTITY_DB** + +- Contains identity-related data. For example, user sessions, OAuth 2.0, SAML 2.0, etc. + +**SESSION_DB** + +- Stores session-related data. For example, user sessions, session contexts, etc. +- Session database separation is recommended for deployments that require higher concurrency and throughput. +- For more information, see [Change the Datasource for Session Database]({{base_path}}/deploy/configure/databases/carbon-database/change-datasource-session/). + +