From fb20935491dfeb10a6eb28a9d498ec35a2f90b4b Mon Sep 17 00:00:00 2001 From: Bill Burke Date: Thu, 21 Apr 2016 16:18:15 -0400 Subject: [PATCH] more --- SUMMARY.adoc | 1 + topics/installation/system-requirements.adoc | 2 +- topics/operating-mode/standalone-ha.adoc | 52 ++++++++++++++++++++ topics/operating-mode/standalone.adoc | 16 +++--- 4 files changed, 64 insertions(+), 7 deletions(-) create mode 100755 topics/operating-mode/standalone-ha.adoc diff --git a/SUMMARY.adoc b/SUMMARY.adoc index d8f2f088a4..0cff7918d0 100755 --- a/SUMMARY.adoc +++ b/SUMMARY.adoc @@ -15,6 +15,7 @@ .. link:topics/openshift.adoc[Installing on OpenShift] . link:topics/operating-mode.adoc[Choosing an Operating Mode] .. link:topics/operating-mode/standalone.adoc[Standalone Mode] + .. link:topics/operating-mode/standalone-ha.adoc[Standalone Clustered Mode] . link:topics/cache.adoc[Server Cache] . link:topics/clustering.adoc[Clustering] . link:topics/proxy.adoc[Keycloak Security Proxy] diff --git a/topics/installation/system-requirements.adoc b/topics/installation/system-requirements.adoc index 69054b7ee3..6f741396f7 100755 --- a/topics/installation/system-requirements.adoc +++ b/topics/installation/system-requirements.adoc @@ -10,4 +10,4 @@ These are the requirements to run the {{book.project.name}} authentication serve * At least 1G of diskspace {{book.project.name}} can be clustered without multicast, but this requires a bunch of configuration changes. Please see -the <> section of this guide for more information. \ No newline at end of file +the <> section of this guide for more information. \ No newline at end of file diff --git a/topics/operating-mode/standalone-ha.adoc b/topics/operating-mode/standalone-ha.adoc new file mode 100755 index 0000000000..dad7f8e588 --- /dev/null +++ b/topics/operating-mode/standalone-ha.adoc @@ -0,0 +1,52 @@ +=== Standalone Clustered + +Standalone clustered operation mode is for when you want to run {{book.project.name}} within a cluster. This mode +requires that you have a copy of each distribution for each node you want to run in the cluster. While very easy to +deploy initially, this mode can become cumbersome if you end up having a large cluster because you will have to +modify the configuration in each node anytime you need to make a change. + +==== Standalone Clustered Configuration + +The distribution has a pre-configured app server configuration file for running within a cluster. It has all the specific +infrasture settings you need for the clustered caches and discovery that {{book.project.name}} needs. This file resides +in _.../standalone/configuration/standalone-ha.xml_ + +.Standalone HA Config +image:../../{{book.images}}/standalone-ha-config-file.png[] + +NOTE: Any changes you make to this file while the server is running will not take effect and may even be overwritten + by the server. Instead use the the command line scripting or the web console of {{book.appserver.name}}. See + the link:{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}] for more information. + +==== Standalone Boot Script + +You use the same boot scripts to start {{book.project.name}} as you do in standalone mode. The difference is that +you pass in an additional flag to point to the HA config file. + +.Standalone Clustered Boot Scripts +image:../../{{book.images}}/standalone-boot-files.png[] + +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 +---- + +==== Standalone Clustered{{book.project.name}} Configuration + +The {{book.project.name}} specific json configure file resides in the same place as in standalone mode: _.../standalone/configuration/keycloak.json_. +Like _standalone-ha.xml_ you have to modify this file in each distribution in your cluster in order for changes to take effect. + +NOTE: Any changes you make to this file while the server is running will not take effect. You'll need to reboot the + server. + + + diff --git a/topics/operating-mode/standalone.adoc b/topics/operating-mode/standalone.adoc index 89b5ac0bb8..4444bcd68f 100755 --- a/topics/operating-mode/standalone.adoc +++ b/topics/operating-mode/standalone.adoc @@ -1,3 +1,4 @@ +[[_standalone-mode]] === Standalone Mode Standalone operating mode is only useful when you want to run one, and only one {{book.project.name}} server instance. Standalone @@ -12,12 +13,7 @@ When running the server in standalone mode, there is a specific script you need operating system. These scripts live in the _bin/_ directory of the server distribution. .Standalone Boot Scripts -{% if book.product %} -image:../../rhsso-images/standalone-boot-files.png[] -{% endif %} -{% if book.community %} -image:../../keycloak-images/standalone-boot-files.png[] -{% endif %} +image:../../{{book.images}}/standalone-boot-files.png[] To boot the server: @@ -42,6 +38,11 @@ derivative of. In the standalone operation mode, this file lives in _.../standa .Standalone Config File image:../../{{book.images}}/standalone-config-file.png[] +NOTE: Any changes you make to this file while the server is running will not take effect and may even be overwritten + by the server. Instead use the the command line scripting or the web console of {{book.appserver.name}}. See + the link:{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}] for more information. + + ==== Standalone {{book.project.name}} Configuration {{book.project.name}} has a json configuration file that is specific to {{book.project.name}} this is located within @@ -51,6 +52,9 @@ only applicable to {{book.project.name}} .Standalone {{book.project.name}} Config File image:../../{{book.images}}/standalone-json-config-file.png[] +NOTE: Any changes you make to this file while the server is running will not take effect. You'll need to reboot the + server. +