Skip to content

Commit 673af40

Browse files
improved circuit brekaer config docs
1 parent bca5315 commit 673af40

File tree

7 files changed

+108
-84
lines changed

7 files changed

+108
-84
lines changed

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

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,24 @@ configured under these two types.
1414
![user-store-types](../assets/img/using-wso2-identity-server/user-store-types.png)
1515

1616
!!! info
17-
Starting from update level 5.10.0.320,inaccessible userstores are ignored by default,
18-
ensuring smooth operations in the Identity Server and is enabled by default.
19-
If it is required to disable this behavior, add the following configuration to the
20-
`<IS_HOME>/repository/conf/deployment.toml` file:
21-
```
22-
[user_store_commons]
23-
enable_circuit_breaker_for_user_stores=false
24-
```
25-
!!! info
26-
Additionally, the following properties have been introduced to support this behavior,
27-
specifying the maximum values for re-establishing the connection as a
28-
server-wide configuration:
29-
```
30-
[user_store_commons]
31-
maxConnectionRetryCount=2
32-
maxConnectionRetryDelayInMilliSeconds=12000
33-
```
17+
18+
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:
19+
20+
```toml
21+
[user_store_commons]
22+
maxConnectionRetryCount=2
23+
minConnectionRetryDelayInMilliSeconds=60000
24+
```
25+
26+
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.
27+
28+
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:
29+
30+
```toml
31+
[user_store_commons]
32+
enable_circuit_breaker_for_user_stores=false
33+
```
34+
3435
## Primary User Store (Mandatory)
3536

3637
This is the main user store that is shared among all the

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,23 @@ configured under these two types.
1313
![user-store-types]({{base_path}}/assets/img/deploy/user-store-types.png)
1414

1515
!!! info
16-
Starting from update level 6.1.0.195, inaccessible userstores are ignored by default,
17-
ensuring smooth operations in the Identity Server and is enabled by default.
18-
If it is required to disable this behavior, add the following configuration to the
19-
`<IS_HOME>/repository/conf/deployment.toml` file:
20-
```
21-
[user_store_commons]
22-
enable_circuit_breaker_for_user_stores=false
23-
```
24-
!!! info
25-
Additionally, the following properties have been introduced to support the circuit
26-
breaker, specifying the maximum connection retry count & minimum connection retry delay values
27-
for re-establishing the connection as a server-wide configuration:
28-
```
29-
[user_store_commons]
30-
maxConnectionRetryCount=2
31-
minConnectionRetryDelayInMilliSeconds=60000
32-
```
16+
17+
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:
18+
19+
```toml
20+
[user_store_commons]
21+
maxConnectionRetryCount=2
22+
minConnectionRetryDelayInMilliSeconds=60000
23+
```
24+
25+
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.
26+
27+
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:
28+
29+
```toml
30+
[user_store_commons]
31+
enable_circuit_breaker_for_user_stores=false
32+
```
3333
---
3434

3535
## Primary userstore (Mandatory)

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

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,33 @@ Identity Server supports JDBC, LDAP, and Active Directory user stores with the
66
capability of configuring custom user stores. There are different user store adapters called *User store managers*, which are used to connect
77
with these user store types.
88

9-
There are two types of user stores - Primary User store (Mandatory) and
10-
Secondary user stores (Optional). All the supported user stores can be
11-
configured under these two types.
9+
There are two types of user stores:
10+
11+
- Primary User store (Mandatory)
12+
- Secondary user stores (Optional).
13+
14+
All the supported user stores can be configured under these two types.
1215

1316
![user-store-types]({{base_path}}/assets/img/guides/user-stores/user-store-types.png){: width="600" style="display: block; margin: 0;"}
1417

15-
!!! info
16-
Starting from update level 7.0.0.81, inaccessible userstores are ignored by default,
17-
ensuring smooth operations in the Identity Server. If it is required to disable this behavior,
18-
add the following configuration to the `<IS_HOME>/repository/conf/deployment.toml` file:
19-
```
20-
[user_store_commons]
21-
enable_circuit_breaker_for_user_stores=false
22-
```
23-
!!! info
24-
Additionally, the following properties have been introduced to support this behavior,
25-
specifying the maximum connection retry count & minimum connection retry delay values
26-
for re-establishing the connection as a server-wide configuration:
27-
```
28-
[user_store_commons]
29-
maxConnectionRetryCount=2
30-
minConnectionRetryDelayInMilliSeconds=60000
31-
```
32-
---
18+
!!! info "Configure how {{product_name}} handles unreachable user stores"
19+
20+
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:
21+
22+
```toml
23+
[user_store_commons]
24+
maxConnectionRetryCount=2
25+
minConnectionRetryDelayInMilliSeconds=60000
26+
```
27+
28+
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.
29+
30+
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:
31+
32+
```toml
33+
[user_store_commons]
34+
enable_circuit_breaker_for_user_stores=false
35+
```
3336

3437
## Primary user store (Mandatory)
3538

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

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,33 @@ Identity Server supports JDBC, LDAP, and Active Directory user stores with the
66
capability of configuring custom user stores. There are different user store adapters called *User store managers*, which are used to connect
77
with these user store types.
88

9-
There are two types of user stores - Primary User store (Mandatory) and
10-
Secondary user stores (Optional). All the supported user stores can be
11-
configured under these two types.
9+
There are two types of user stores:
10+
11+
- Primary User store (Mandatory)
12+
- Secondary user stores (Optional).
13+
14+
All the supported user stores can be configured under these two types.
1215

1316
![user-store-types]({{base_path}}/assets/img/guides/user-stores/user-store-types.png){: width="600" style="display: block; margin: 0;"}
1417

15-
---
18+
!!! info "Configure how {{product_name}} handles unreachable user stores"
19+
20+
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:
21+
22+
```toml
23+
[user_store_commons]
24+
maxConnectionRetryCount=2
25+
minConnectionRetryDelayInMilliSeconds=60000
26+
```
27+
28+
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.
29+
30+
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:
31+
32+
```toml
33+
[user_store_commons]
34+
enable_circuit_breaker_for_user_stores=false
35+
```
1636

1737
## Primary user store (Mandatory)
1838

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,3 @@ If you prefer to configure the user store manually, follow the steps given below
135135
environment, it will not sync between all the nodes by default, so
136136
you need to copy manually to other nodes. This applies to deletion as well. So you can use sync mechanisms like Rsync or
137137
choose to first fully test it in a single node and apply it to other nodes while setting up the cluster.
138-
139-
140-
141-

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

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,33 @@ Identity Server supports JDBC, LDAP, and Active Directory user stores with the
66
capability of configuring custom user stores. There are different user store adapters called *User store managers*, which are used to connect
77
with these user store types.
88

9-
There are two types of user stores - Primary User store (Mandatory) and
10-
Secondary user stores (Optional). All the supported user stores can be
11-
configured under these two types.
9+
There are two types of user stores:
10+
11+
- Primary User store (Mandatory)
12+
- Secondary user stores (Optional).
13+
14+
All the supported user stores can be configured under these two types.
1215

1316
![user-store-types]({{base_path}}/assets/img/guides/user-stores/user-store-types.png){: width="600" style="display: block; margin: 0;"}
1417

15-
!!! info
16-
Inaccessible userstores are ignored by default during the authentication flow. If it is required to disable this behavior,
17-
add the following configuration to the `<IS_HOME>/repository/conf/deployment.toml` file:
18-
```
19-
[user_store_commons]
20-
enable_circuit_breaker_for_user_stores=false
21-
```
22-
!!! info
23-
Additionally, the following properties are introduced to support this behaviour,
24-
specifying the maximum connection retry count & minimum connection retry delay values
25-
for re-establishing the connection as a server-wide configuration:
26-
```
27-
[user_store_commons]
28-
maxConnectionRetryCount=2
29-
minConnectionRetryDelayInMilliSeconds=60000
30-
```
31-
---
18+
!!! info "Configure how {{product_name}} handles unreachable user stores"
19+
20+
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:
21+
22+
```toml
23+
[user_store_commons]
24+
maxConnectionRetryCount=2
25+
minConnectionRetryDelayInMilliSeconds=60000
26+
```
27+
28+
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.
29+
30+
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:
31+
32+
```toml
33+
[user_store_commons]
34+
enable_circuit_breaker_for_user_stores=false
35+
```
3236

3337
## Primary user store (Mandatory)
3438

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ Organization owners sometimes require to migrate users from an existing Identity
88
- Move or separate identity data due to geopolitical, data protection, compliance, and regulatory requirements.
99
- Improve identity management by providing increased security, scalability, and reduced maintenance costs.
1010

11-
{{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/).
11+
{{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/).

0 commit comments

Comments
 (0)