Merge pull request #4662 from Tiffany-silva/add-introduced-userstore-configs

Author: himeshsiriwardana

en/identity-server/5.10.0/docs/setup/configuring-a-jdbc-user-store.md

@@ -328,7 +328,7 @@ false: Set it to false if the user roles are changed by external means and those
     used in JDBC user store manager and if required can change default
     queries. Those are not listed under above property section but you can
     do the configuration as same as described above.
-    
+
 
 ??? note "JDBC sample property with SQL queries"
 

en/identity-server/5.10.0/docs/setup/configuring-user-stores.md

@@ -13,6 +13,25 @@ configured under these two types.
 
 ![user-store-types](../assets/img/using-wso2-identity-server/user-store-types.png) 
 
+!!! info
+
+    Starting from update level 5.10.0.320, WSO2 Identity Server ignores inaccessible user stores by default. This ensures that authentication for users in reachable user stores continues without failure, even if another user store is unreachable. To control this behavior, you can configure the following properties in the `<IS_HOME>/repository/conf/deployment.toml` file:
+
+    ```toml
+    [user_store_commons]
+    maxConnectionRetryCount=2
+    minConnectionRetryDelayInMilliSeconds=60000
+    ```
+
+    During authentication, WSO2 Identity Server will attempt to connect to the user store up to `maxConnectionRetryCount` times, with a delay of `minConnectionRetryDelayInMilliSeconds` between each attempt. If the connection is still unavailable, the user store will be skipped.
+
+    If required, you can disable this behavior. However, note that disabling it may disrupt the authentication flow when a user store is unreachable, leading to a degraded user experience. To disable this behavior, add the following configuration to the `<IS_HOME>/repository/conf/deployment.toml` file:
+
+    ```toml
+    [user_store_commons]
+    enable_circuit_breaker_for_user_stores=false
+    ```
+
 ## Primary User Store (Mandatory)
 
 This is the main user store that is shared among all the

en/identity-server/6.1.0/docs/deploy/configure-user-stores.md

@@ -12,6 +12,24 @@ configured under these two types.
 
 ![user-store-types]({{base_path}}/assets/img/deploy/user-store-types.png) 
 
+!!! info
+
+    Starting from update level 6.1.0.195, WSO2 Identity Server ignores inaccessible user stores by default. This ensures that authentication for users in reachable user stores continues without failure, even if another user store is unreachable. To control this behavior, you can configure the following properties in the `<IS_HOME>/repository/conf/deployment.toml` file:
+
+    ```toml
+    [user_store_commons]
+    maxConnectionRetryCount=2
+    minConnectionRetryDelayInMilliSeconds=60000
+    ```
+
+    During authentication, WSO2 Identity Server will attempt to connect to the user store up to `maxConnectionRetryCount` times, with a delay of `minConnectionRetryDelayInMilliSeconds` between each attempt. If the connection is still unavailable, the user store will be skipped.
+
+    If required, you can disable this behavior. However, note that disabling it may disrupt the authentication flow when a user store is unreachable, leading to a degraded user experience. To disable this behavior, add the following configuration to the `<IS_HOME>/repository/conf/deployment.toml` file:
+
+    ```toml
+    [user_store_commons]
+    enable_circuit_breaker_for_user_stores=false
+    ```
 ---
 
 ## Primary userstore (Mandatory)

en/identity-server/7.0.0/docs/guides/users/user-stores/index.md

@@ -6,13 +6,33 @@ Identity Server supports JDBC, LDAP, and Active Directory user stores with the
 capability of configuring custom user stores. There are different user store adapters called *User store managers*, which are used to connect
 with these user store types.
 
-There are two types of user stores - Primary User store (Mandatory) and
-Secondary user stores (Optional). All the supported user stores can be
-configured under these two types.
+There are two types of user stores:
+
+- Primary User store (Mandatory)
+- Secondary user stores (Optional).
+
+All the supported user stores can be configured under these two types.
 
 ![user-store-types]({{base_path}}/assets/img/guides/user-stores/user-store-types.png){: width="600" style="display: block; margin: 0;"}
 
----
+!!! info "Configure how {{product_name}} handles unreachable user stores"
+    
+    Starting from update level 7.0.0.81, {{product_name}} ignores inaccessible user stores by default. This ensures that authentication for users in reachable user stores continues without failure, even if another user store is unreachable. To control this behavior, you can configure the following properties in the `<IS_HOME>/repository/conf/deployment.toml` file:
+
+    ```toml
+    [user_store_commons]
+    maxConnectionRetryCount=2
+    minConnectionRetryDelayInMilliSeconds=60000
+    ```
+
+    During authentication, {{product_name}} will attempt to connect to the user store up to `maxConnectionRetryCount` times, with a delay of `minConnectionRetryDelayInMilliSeconds` between each attempt. If the connection is still unavailable, the user store will be skipped.
+
+    If required, you can disable this behavior. However, note that disabling it may disrupt the authentication flow when a user store is unreachable, leading to a degraded user experience. To disable this behavior, add the following configuration to the `<IS_HOME>/repository/conf/deployment.toml` file:
+
+    ```toml
+    [user_store_commons]
+    enable_circuit_breaker_for_user_stores=false
+    ```
 
 ## Primary user store (Mandatory)
 

en/identity-server/7.1.0/docs/guides/users/user-stores/index.md

@@ -6,13 +6,33 @@ Identity Server supports JDBC, LDAP, and Active Directory user stores with the
 capability of configuring custom user stores. There are different user store adapters called *User store managers*, which are used to connect
 with these user store types.
 
-There are two types of user stores - Primary User store (Mandatory) and
-Secondary user stores (Optional). All the supported user stores can be
-configured under these two types.
+There are two types of user stores:
+
+- Primary User store (Mandatory)
+- Secondary user stores (Optional).
+
+All the supported user stores can be configured under these two types.
 
 ![user-store-types]({{base_path}}/assets/img/guides/user-stores/user-store-types.png){: width="600" style="display: block; margin: 0;"}
 
----
+!!! info "Configure how {{product_name}} handles unreachable user stores"
+    
+    By default, {{product_name}} ignores inaccessible user stores during authentication. This ensures that authentication for users in reachable user stores continues without failure, even if another user store is unreachable. To control this behavior, you can configure the following properties in the `<IS_HOME>/repository/conf/deployment.toml` file:
+
+    ```toml
+    [user_store_commons]
+    maxConnectionRetryCount=2
+    minConnectionRetryDelayInMilliSeconds=60000
+    ```
+
+    During authentication, {{product_name}} will attempt to connect to the user store up to `maxConnectionRetryCount` times, with a delay of `minConnectionRetryDelayInMilliSeconds` between each attempt. If the connection is still unavailable, the user store will be skipped.
+
+    If required, you can disable this behavior. However, note that disabling it may disrupt the authentication flow when a user store is unreachable, leading to a degraded user experience. To disable this behavior, add the following configuration to the `<IS_HOME>/repository/conf/deployment.toml` file:
+
+    ```toml
+    [user_store_commons]
+    enable_circuit_breaker_for_user_stores=false
+    ```
 
 ## Primary user store (Mandatory)
 

en/identity-server/next/docs/guides/users/user-stores/configure-secondary-user-stores.md

@@ -135,7 +135,3 @@ If you prefer to configure the user store manually, follow the steps given below
         environment, it will not sync between all the nodes by default, so
         you need to copy manually to other nodes. This applies to deletion as well. So you can use sync mechanisms like Rsync or
         choose to first fully test it in a single node and apply it to other nodes while setting up the cluster.  
-    
-
-      
-      

en/identity-server/next/docs/guides/users/user-stores/index.md

@@ -6,13 +6,33 @@ Identity Server supports JDBC, LDAP, and Active Directory user stores with the
 capability of configuring custom user stores. There are different user store adapters called *User store managers*, which are used to connect
 with these user store types.
 
-There are two types of user stores - Primary User store (Mandatory) and
-Secondary user stores (Optional). All the supported user stores can be
-configured under these two types.
+There are two types of user stores:
+
+- Primary User store (Mandatory)
+- Secondary user stores (Optional).
+
+All the supported user stores can be configured under these two types.
 
 ![user-store-types]({{base_path}}/assets/img/guides/user-stores/user-store-types.png){: width="600" style="display: block; margin: 0;"}
 
----
+!!! info "Configure how {{product_name}} handles unreachable user stores"
+    
+    By default, {{product_name}} ignores inaccessible user stores during authentication. This ensures that authentication for users in reachable user stores continues without failure, even if another user store is unreachable. To control this behavior, you can configure the following properties in the `<IS_HOME>/repository/conf/deployment.toml` file:
+
+    ```toml
+    [user_store_commons]
+    maxConnectionRetryCount=2
+    minConnectionRetryDelayInMilliSeconds=60000
+    ```
+
+    During authentication, {{product_name}} will attempt to connect to the user store up to `maxConnectionRetryCount` times, with a delay of `minConnectionRetryDelayInMilliSeconds` between each attempt. If the connection is still unavailable, the user store will be skipped.
+
+    If required, you can disable this behavior. However, note that disabling it may disrupt the authentication flow when a user store is unreachable, leading to a degraded user experience. To disable this behavior, add the following configuration to the `<IS_HOME>/repository/conf/deployment.toml` file:
+
+    ```toml
+    [user_store_commons]
+    enable_circuit_breaker_for_user_stores=false
+    ```
 
 ## Primary user store (Mandatory)
 

en/includes/guides/users/migrate-users/index.md

@@ -8,4 +8,4 @@ Organization owners sometimes require to migrate users from an existing Identity
 - Move or separate identity data due to geopolitical, data protection, compliance, and regulatory requirements.
 - Improve identity management by providing increased security, scalability, and reduced maintenance costs.
 
-{{product_name}} provides convenience means to migrate users from an external IdP. Learn how to [migrate user accounts]({{base_path}}/guides/users/migrate-users/migrate-users/) and [migrate user passwords]({{base_path}}/guides/users/migrate-users/migrate-passwords/).
+{{product_name}} provides convenient means to migrate users from an external IdP. Learn how to [migrate user accounts]({{base_path}}/guides/users/migrate-users/migrate-users/) and [migrate user passwords]({{base_path}}/guides/users/migrate-users/migrate-passwords/).