Synchronize Sites

When to use this procedure

Use this when the state of Infinispan clusters of two sites become disconnected and the contents of the caches are out-of-sync. Perform this for example after a split-brain or when one site has been taken offline for maintenance.

At the end of the procedure, the data on the secondary site have been discarded and replaced by the data of the active site. All caches in the offline site are cleared to prevent invalid cache contents.

Procedures

Infinispan Cluster

For the context of this guide, site-a is the currently active site and site-b is an offline site that is not part of the AWS Global Accelerator EndpointGroup and is therefore not receiving user requests.

Transferring state may impact Infinispan cluster performance by increasing the response time and/or resources usage.

The first procedure is to delete the stale data from the offline site.

Login into the offline site.
Shutdown Keycloak. This will clear all Keycloak caches and prevents the Keycloak state from being out-of-sync with Infinispan.

When deploying Keycloak using the Keycloak Operator, change the number of Keycloak instances in the Keycloak Custom Resource to 0.
Connect into Infinispan Cluster using the Infinispan CLI tool:
Command:
```
kubectl -n keycloak exec -it pods/infinispan-0 -- ./bin/cli.sh --trustall --connect https://127.0.0.1:11222
```
It asks for the username and password for the Infinispan cluster. Those credentials are the one set in the Deploy Infinispan for HA with the Infinispan Operator guide in the configuring credentials section.
Output:
```
Username: developer
Password:
[infinispan-0-29897@ISPN//containers/default]>
```
The pod name depends on the cluster name defined in the Infinispan CR. The connection can be done with any pod in the Infinispan cluster.
Disable the replication from offline site to the active site by running the following command. It prevents the clear request to reach the active site and delete all the correct cached data.
Command:
```
site take-offline --all-caches --site=site-a
```
Output:
```
{
  "authenticationSessions" : "ok",
  "work" : "ok",
  "loginFailures" : "ok",
  "actionTokens" : "ok"
}
```
Check the replication status is offline.
Command:
```
site status --all-caches --site=site-a
```
Output:
```
{
  "status" : "offline"
}
```
If the status is not offline, repeat the previous step.

Make sure the replication is offline otherwise the clear data will clear both sites.
Clear all the cached data in offline site using the following commands:
Command:
```
clearcache actionTokens
clearcache authenticationSessions
clearcache loginFailures
clearcache work
```
These commands do not print any output.

Re-enable the cross-site replication from offline site to the active site.

Command:

site bring-online --all-caches --site=site-a

Output:

{
  "authenticationSessions" : "ok",
  "work" : "ok",
  "loginFailures" : "ok",
  "actionTokens" : "ok"
}

Check the replication status is online.

Command:

site status --all-caches --site=site-a

Output:

{
  "status" : "online"
}

Now we are ready to transfer the state from the active site to the offline site.

Login into your Active site
Connect into Infinispan Cluster using the Infinispan CLI tool:
Command:
```
kubectl -n keycloak exec -it pods/infinispan-0 -- ./bin/cli.sh --trustall --connect https://127.0.0.1:11222
```
It asks for the username and password for the Infinispan cluster. Those credentials are the one set in the Deploy Infinispan for HA with the Infinispan Operator guide in the configuring credentials section.
Output:
```
Username: developer
Password:
[infinispan-0-29897@ISPN//containers/default]>
```
The pod name depends on the cluster name defined in the Infinispan CR. The connection can be done with any pod in the Infinispan cluster.

Trigger the state transfer from the active site to the offline site.

Command:

site push-site-state --all-caches --site=site-b

Output:

{
  "authenticationSessions" : "ok",
  "work" : "ok",
  "loginFailures" : "ok",
  "actionTokens" : "ok"
}

Check the replication status is online for all caches.
Command:
```
site status --all-caches --site=site-b
```
Output:
```
{
  "status" : "online"
}
```

Wait for the state transfer to complete by checking the output of push-site-status command for all caches.

Command:

site push-site-status --cache=actionTokens
site push-site-status --cache=authenticationSessions
site push-site-status --cache=loginFailures
site push-site-status --cache=work

Output:

{
  "site-b" : "OK"
}
{
  "site-b" : "OK"
}
{
  "site-b" : "OK"
}
{
  "site-b" : "OK"
}

Check the table in this section for the Cross-Site Documentation for the possible status values.

If an error is reported, repeat the state transfer for that specific cache.

Command:

site push-site-state --cache=<cache-name> --site=site-b

Clear/reset the state transfer status with the following command

Command:

site clear-push-site-status --cache=actionTokens
site clear-push-site-status --cache=authenticationSessions
site clear-push-site-status --cache=loginFailures
site clear-push-site-status --cache=work

Output:

"ok"
"ok"
"ok"
"ok"

Now the state is available in the offline site, Keycloak can be started again:

Login into your secondary site.
Startup Keycloak.

When deploying Keycloak using the Keycloak Operator, change the number of Keycloak instances in the Keycloak Custom Resource to the original value.

AWS Aurora Database

No action required.

AWS Global Accelerator

Once the two sites have been synchronized, it is safe to add the previously offline site back to the Global Accelerator EndpointGroup following the steps in the Bring site online guide.

Nightly release

Synchronize Sites

When to use this procedure

Procedures

Infinispan Cluster

AWS Aurora Database

AWS Global Accelerator

Further reading