keycloak-scim/server_installation/topics/operating-mode/standalone-ha.adoc

48 lines
2 KiB
Text
Raw Normal View History

2016-04-30 04:39:32 +00:00
2016-04-22 20:02:59 +00:00
[[_standalone-ha-mode]]
=== Standalone Clustered Mode
2016-04-21 20:18:15 +00:00
2017-08-28 12:50:14 +00:00
Standalone clustered operation mode is for when you want to run {project_name} within a cluster. This mode
requires that you have a copy of the {project_name} distribution on each machine you want to run a server instance.
2016-04-29 16:09:09 +00:00
This mode can be very easy to deploy initially, but can become quite cumbersome. To make a configuration change
you'll have to modify each distribution on each machine. For a large cluster this can become time consuming and error prone.
2016-04-21 20:18:15 +00:00
==== Standalone Clustered Configuration
2016-04-22 20:02:59 +00:00
The distribution has a mostly pre-configured app server configuration file for running within a cluster. It has all the specific
2016-04-29 16:09:09 +00:00
infrastructure settings for networking, databases, caches, and discovery. This file resides
2016-04-22 20:02:59 +00:00
in _.../standalone/configuration/standalone-ha.xml_. There's a few things missing from this configuration.
2019-01-21 13:03:44 +00:00
You can't run {project_name} in a cluster without configuring a shared database connection. You also need to
2017-08-28 12:50:14 +00:00
deploy some type of load balancer in front of the cluster. The <<_clustering,clustering>> and
<<_database,database>> sections of this guide walk you though these things.
2016-04-21 20:18:15 +00:00
.Standalone HA Config
2017-08-28 12:50:14 +00:00
image:{project_images}/standalone-ha-config-file.png[]
2016-04-21 20:18:15 +00:00
2016-04-29 16:09:09 +00:00
WARNING: Any changes you make to this file while the server is running will not take effect and may even be overwritten
2018-01-24 14:24:49 +00:00
by the server. Instead use the command line scripting or the web console of {appserver_name}. See
2017-08-28 12:50:14 +00:00
the link:{appserver_admindoc_link}[_{appserver_admindoc_name}_] for more information.
2016-04-21 20:18:15 +00:00
2016-04-29 16:09:09 +00:00
==== Standalone Clustered Boot Script
2016-04-21 20:18:15 +00:00
2017-08-28 12:50:14 +00:00
You use the same boot scripts to start {project_name} as you do in standalone mode. The difference is that
2016-04-21 20:18:15 +00:00
you pass in an additional flag to point to the HA config file.
.Standalone Clustered Boot Scripts
2017-08-28 12:50:14 +00:00
image:{project_images}/standalone-boot-files.png[]
2016-04-21 20:18:15 +00:00
To boot the server:
.Linux/Unix
[source]
----
$ .../bin/standalone.sh --server-config=standalone-ha.xml
----
.Windows
[source]
----
> ...\bin\standalone.bat --server-config=standalone-ha.xml
----