From 9515deaeabe9a01779aaef996a26fdaa0f1bd37b Mon Sep 17 00:00:00 2001 From: Bill Burke Date: Thu, 21 Apr 2016 11:15:52 -0400 Subject: [PATCH] more --- SUMMARY.adoc | 2 ++ book.json | 4 ++++ topics/clustering.adoc | 1 + topics/deployment-mode.adoc | 6 ++++++ topics/deployment-mode/standalone.adoc | 20 ++++++++++++++++++++ topics/installation/directory-structure.adoc | 3 ++- topics/installation/system-requirements.adoc | 2 +- 7 files changed, 36 insertions(+), 2 deletions(-) create mode 100755 topics/deployment-mode.adoc create mode 100755 topics/deployment-mode/standalone.adoc diff --git a/SUMMARY.adoc b/SUMMARY.adoc index 2dba1058d3..b59b1656b0 100755 --- a/SUMMARY.adoc +++ b/SUMMARY.adoc @@ -12,6 +12,8 @@ {% endif %} .. link:topics/installation/directory-structure.adoc[Distribution Directory Structure] .. link:topics/openshift.adoc[Installing on OpenShift] + . link:topics/deployment-mode.adoc[Choosing a Deployment Mode] + .. link:topics/deployment-mode/standalone.adoc[Standalone Mode] . link:topics/cache.adoc[Server Cache] . link:topics/clustering.adoc[Clustering] . link:topics/proxy.adoc[Keycloak Security Proxy] diff --git a/book.json b/book.json index 3c205f04f5..5184921b31 100755 --- a/book.json +++ b/book.json @@ -12,6 +12,10 @@ "community": true, "product": false, "images": "rhsso-images", + "appserver": { + "name": "Wildfly", + "version": "10.0.0.Final" + }, "project": { "name": "Keycloak", "version": "1.9.3.Final-SNAPSHOT" diff --git a/topics/clustering.adoc b/topics/clustering.adoc index 495b596536..c430f17040 100755 --- a/topics/clustering.adoc +++ b/topics/clustering.adoc @@ -5,6 +5,7 @@ Keycloak doesn't replicate realms and users, but instead relies on all nodes usi This can be a relational database or Mongo. To make sure your database doesn't become a single point of failure you may also want to deploy your database to a cluster. +[[_clustering_db_lock]] === DB lock Note that Keycloak supports concurrent startup by more cluster nodes at the same. diff --git a/topics/deployment-mode.adoc b/topics/deployment-mode.adoc new file mode 100755 index 0000000000..d836d70938 --- /dev/null +++ b/topics/deployment-mode.adoc @@ -0,0 +1,6 @@ +== Choosing a Deployment Mode + +Before deploying {{book.project.name}} in a production environment you need to decide which type of deployment method +you are going to use. Will you run {{book.project.name}} within a cluster? Do you want a centralized way to manage +your server configurations? This is where deciding the deployment mode comes in. This decision + effects how you configure databases, configure caching and even how you boot the server. \ No newline at end of file diff --git a/topics/deployment-mode/standalone.adoc b/topics/deployment-mode/standalone.adoc new file mode 100755 index 0000000000..391c36e24c --- /dev/null +++ b/topics/deployment-mode/standalone.adoc @@ -0,0 +1,20 @@ +=== Standalone Mode + +Standalone mode is only useful when you want to run one, and only one {{book.project.name}} server instance. Standalone +instances contain all the configuration files they need locally. What this basically means is that any configuration done +must be done on the config files contained in the installed distribution on the machine the {{book.project.name}} is going to run on +{{book.project.name}} standalone mode is available pre-configured out of the box. It turns off clustering entirely +and turns any distributed caches into local-only ones. + +==== Standalone Boot Script + +When running the server in standalone mode, there is a specific script you need to run to boot the server depending on your +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[alt="distribution"] +{% endif %} +{% if book.community %} +image:../../keycloak-images/standalone-boot-files.png[alt="distribution"] +{% endif %} diff --git a/topics/installation/directory-structure.adoc b/topics/installation/directory-structure.adoc index 8185828180..01cc684c63 100755 --- a/topics/installation/directory-structure.adoc +++ b/topics/installation/directory-structure.adoc @@ -5,7 +5,8 @@ This chapter walks you through the directory structure of the server distributio .distribution directory structure {% if book.product %} . image:../../rhsso-images/files.png[alt="distribution"] -{% else %} +{% endif %} +{% if book.community %} image:../../keycloak-images/files.png[alt="distribution"] {% endif %} diff --git a/topics/installation/system-requirements.adoc b/topics/installation/system-requirements.adoc index bc3260f08e..05242d261b 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