Skip to content

Commit 211cdad

Browse files
committed
Deploying to main from @ 6afad8e381593fc3d180c5089ded3c08c33a8c3e 🚀
1 parent 76b1ba4 commit 211cdad

File tree

55 files changed

+34
-14298
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+34
-14298
lines changed

extensions.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ <h5 class="card-title">MFA Plugin collection</h5>
402402
<div class="d-flex align-items-center">
403403
<img src="resources/images/github.png" width="16px" alt="GitHub logo"
404404
class="me-2"/>
405-
<span>177 stars</span>
405+
<span>178 stars</span>
406406
</div>
407407
</div>
408408
</div>
@@ -713,7 +713,7 @@ <h5 class="card-title">IBM Security Verify Authenticator</h5>
713713
<div class="d-flex align-items-center">
714714
<img src="resources/images/github.png" width="16px" alt="GitHub logo"
715715
class="me-2"/>
716-
<span>29 stars</span>
716+
<span>28 stars</span>
717717
</div>
718718
</div>
719719
</div>

getting-started/getting-started-docker.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h2 id="_before_you_start"><a class="anchor" href="#_before_you_start"></a>Befor
8787
<div class="sectionbody">
8888
<div class="paragraph">
8989
<p>Make sure your machine or container platform can provide sufficient memory and CPU for your desired usage of Keycloak.
90-
See <a href="https://www.keycloak.org/high-availability/concepts-memory-and-cpu-sizing">Concepts for sizing CPU and memory resources</a> for more on how to get started with production sizing.</p>
90+
See <a href="{links_high-availability_concepts-memory-and-cpu-sizing_url}">{links_high-availability_concepts-memory-and-cpu-sizing_name}</a> for more on how to get started with production sizing.</p>
9191
</div>
9292
<div class="paragraph">
9393
<p>Make sure you have Docker installed.</p>

getting-started/getting-started-kube.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h2 id="_before_you_start"><a class="anchor" href="#_before_you_start"></a>Befor
8787
<div class="sectionbody">
8888
<div class="paragraph">
8989
<p>Make sure your machine or container platform can provide sufficient memory and CPU for your desired usage of Keycloak.
90-
See <a href="https://www.keycloak.org/high-availability/concepts-memory-and-cpu-sizing">Concepts for sizing CPU and memory resources</a> for more on how to get started with production sizing.</p>
90+
See <a href="{links_high-availability_concepts-memory-and-cpu-sizing_url}">{links_high-availability_concepts-memory-and-cpu-sizing_name}</a> for more on how to get started with production sizing.</p>
9191
</div>
9292
<div class="paragraph">
9393
<p>Make sure you have Minikube installed, ideally with the Ingress addon enabled.</p>

getting-started/getting-started-openshift.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h2 id="_before_you_start"><a class="anchor" href="#_before_you_start"></a>Befor
8787
<div class="sectionbody">
8888
<div class="paragraph">
8989
<p>Make sure your machine or container platform can provide sufficient memory and CPU for your desired usage of Keycloak.
90-
See <a href="https://www.keycloak.org/high-availability/concepts-memory-and-cpu-sizing">Concepts for sizing CPU and memory resources</a> for more on how to get started with production sizing.</p>
90+
See <a href="{links_high-availability_concepts-memory-and-cpu-sizing_url}">{links_high-availability_concepts-memory-and-cpu-sizing_name}</a> for more on how to get started with production sizing.</p>
9191
</div>
9292
<div class="olist arabic">
9393
<ol class="arabic">

getting-started/getting-started-podman.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h2 id="_before_you_start"><a class="anchor" href="#_before_you_start"></a>Befor
8787
<div class="sectionbody">
8888
<div class="paragraph">
8989
<p>Make sure your machine or container platform can provide sufficient memory and CPU for your desired usage of Keycloak.
90-
See <a href="https://www.keycloak.org/high-availability/concepts-memory-and-cpu-sizing">Concepts for sizing CPU and memory resources</a> for more on how to get started with production sizing.</p>
90+
See <a href="{links_high-availability_concepts-memory-and-cpu-sizing_url}">{links_high-availability_concepts-memory-and-cpu-sizing_name}</a> for more on how to get started with production sizing.</p>
9191
</div>
9292
<div class="paragraph">
9393
<p>Make sure you have Podman installed.</p>

getting-started/getting-started-scaling-and-tuning.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -112,21 +112,21 @@ <h1>Scaling</h1>
112112
<h2 id="_vertical_scaling"><a class="anchor" href="#_vertical_scaling"></a>Vertical Scaling</h2>
113113
<div class="sectionbody">
114114
<div class="paragraph">
115-
<p>As you monitor your Keycloak workload, check to see if the CPU or memory is under or over utilized. Consult <a href="https://www.keycloak.org/high-availability/concepts-memory-and-cpu-sizing">Concepts for sizing CPU and memory resources</a> to better tune the resources available to the Java Virtual Machine (JVM).</p>
115+
<p>As you monitor your Keycloak workload, check to see if the CPU or memory is under or over utilized. Consult <a href="{links_high-availability_concepts-memory-and-cpu-sizing_url}">{links_high-availability_concepts-memory-and-cpu-sizing_name}</a> to better tune the resources available to the Java Virtual Machine (JVM).</p>
116116
</div>
117117
<div class="paragraph">
118118
<p>Before increasing the amount of memory available to the JVM, in particular when experiencing an out of memory error, it is best to determine what is contributing to the increased footprint using a heap dump. Excessive response times may also indicate the HTTP work queue is too large and tuning for load shedding would be better than simply providing more memory. See the following section.</p>
119119
</div>
120120
<div class="sect2">
121121
<h3 id="_common_tuning_options"><a class="anchor" href="#_common_tuning_options"></a>Common Tuning Options</h3>
122122
<div class="paragraph">
123-
<p>Keycloak automatically adjusts the number of used threads based upon how many cores you make available. Manually changing the thread count can improve overall throughput. For more details, see <a href="https://www.keycloak.org/high-availability/concepts-threads">Concepts for configuring thread pools</a>. However, changing the thread count must be done in conjunction with other JVM resources, such as database connections; otherwise, you may be moving a bottleneck somewhere else. For more details, see <a href="https://www.keycloak.org/high-availability/concepts-database-connections">Concepts for database connection pools</a>.</p>
123+
<p>Keycloak automatically adjusts the number of used threads based upon how many cores you make available. Manually changing the thread count can improve overall throughput. For more details, see <a href="{links_high-availability_concepts-threads_url}">{links_high-availability_concepts-threads_name}</a>. However, changing the thread count must be done in conjunction with other JVM resources, such as database connections; otherwise, you may be moving a bottleneck somewhere else. For more details, see <a href="{links_high-availability_concepts-database-connections_url}">{links_high-availability_concepts-database-connections_name}</a>.</p>
124124
</div>
125125
<div class="paragraph">
126-
<p>To limit memory utilization of queued work and to provide for load shedding, see <a href="https://www.keycloak.org/high-availability/concepts-threads#load-shedding">Concepts for configuring thread pools</a>.</p>
126+
<p>To limit memory utilization of queued work and to provide for load shedding, see <a href="{links_high-availability_concepts-threads_url}#load-shedding">{links_high-availability_concepts-threads_name}</a>.</p>
127127
</div>
128128
<div class="paragraph">
129-
<p>If you are experiencing timeouts in obtaining database connections, you should consider increasing the number of connections available. For more details, see <a href="https://www.keycloak.org/high-availability/concepts-database-connections">Concepts for database connection pools</a>.</p>
129+
<p>If you are experiencing timeouts in obtaining database connections, you should consider increasing the number of connections available. For more details, see <a href="{links_high-availability_concepts-database-connections_url}">{links_high-availability_concepts-database-connections_name}</a>.</p>
130130
</div>
131131
</div>
132132
<div class="sect2">
@@ -147,7 +147,7 @@ <h2 id="_horizontal_scaling"><a class="anchor" href="#_horizontal_scaling"></a>H
147147
<p>A single JVM has a limit on how many concurrent requests it can handle. Additional server instances can provide roughly linear scaling of throughput until associated resources, such as the database or distributed caching, limit that scaling.</p>
148148
</div>
149149
<div class="paragraph">
150-
<p>In general, consider allowing the Keycloak Operator to handle horizontal scaling concerns. When using the Operator, set the Keycloak custom resource <code>spec.instances</code> as desired to horizontally scale. For more details, see <a href="https://www.keycloak.org/high-availability/deploy-keycloak-kubernetes">Deploying Keycloak for HA with the Operator</a>.</p>
150+
<p>In general, consider allowing the Keycloak Operator to handle horizontal scaling concerns. When using the Operator, set the Keycloak custom resource <code>spec.instances</code> as desired to horizontally scale. For more details, see <a href="{links_high-availability_deploy-keycloak-kubernetes_url}">{links_high-availability_deploy-keycloak-kubernetes_name}</a>.</p>
151151
</div>
152152
<div class="paragraph">
153153
<p>If you are not using the Operator, please review the following:</p>
@@ -176,7 +176,7 @@ <h2 id="_horizontal_scaling"><a class="anchor" href="#_horizontal_scaling"></a>H
176176
</ul>
177177
</div>
178178
<div class="paragraph">
179-
<p>To avoid losing service availability when a whole site is unavailable, see the high availability guide for more information on a multi-site deployment. See <a href="https://www.keycloak.org/high-availability/introduction">Multi-site deployments</a>.</p>
179+
<p>To avoid losing service availability when a whole site is unavailable, see the high availability guide for more information on a multi-site deployment. See <a href="{links_high-availability_introduction_url}">{links_high-availability_introduction_name}</a>.</p>
180180
</div>
181181
<div class="sect2">
182182
<h3 id="_horizontal_autoscaling"><a class="anchor" href="#_horizontal_autoscaling"></a>Horizontal Autoscaling</h3>
@@ -220,7 +220,7 @@ <h3 id="_horizontal_autoscaling"><a class="anchor" href="#_horizontal_autoscalin
220220
<i class="fa icon-note" title="Note"></i>
221221
</td>
222222
<td class="content">
223-
Scaling on memory is generally not needed with persistent sessions enabled, and should not be needed at all when using remote Infinispan. If you are using persistent sessions or remote Infinispan and you experience memory issues, it is best to fully diagnose the problem and revisit the <a href="https://www.keycloak.org/high-availability/concepts-memory-and-cpu-sizing">Concepts for sizing CPU and memory resources</a> guide. Adjusting the memory request and limit is preferable to horizontal scaling.
223+
Scaling on memory is generally not needed with persistent sessions enabled, and should not be needed at all when using remote Infinispan. If you are using persistent sessions or remote Infinispan and you experience memory issues, it is best to fully diagnose the problem and revisit the <a href="{links_high-availability_concepts-memory-and-cpu-sizing_url}">{links_high-availability_concepts-memory-and-cpu-sizing_name}</a> guide. Adjusting the memory request and limit is preferable to horizontal scaling.
224224
</td>
225225
</tr>
226226
</table>

getting-started/getting-started-zip.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h2 id="_before_you_start"><a class="anchor" href="#_before_you_start"></a>Befor
8787
<div class="sectionbody">
8888
<div class="paragraph">
8989
<p>Make sure your machine or container platform can provide sufficient memory and CPU for your desired usage of Keycloak.
90-
See <a href="https://www.keycloak.org/high-availability/concepts-memory-and-cpu-sizing">Concepts for sizing CPU and memory resources</a> for more on how to get started with production sizing.</p>
90+
See <a href="{links_high-availability_concepts-memory-and-cpu-sizing_url}">{links_high-availability_concepts-memory-and-cpu-sizing_name}</a> for more on how to get started with production sizing.</p>
9191
</div>
9292
<div class="paragraph">
9393
<p>Make sure you have <a href="https://openjdk.java.net/">OpenJDK 21</a> installed.</p>

guides.html

Lines changed: 0 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,6 @@
8282
<li>
8383
<a class="nav-link" href="#securing-apps">Securing applications</a>
8484
</li>
85-
<li>
86-
<a class="nav-link" href="#high-availability">High availability</a>
87-
</li>
8885
<li>
8986
<a class="nav-link" href="#migration">Migration</a>
9087
</li>
@@ -1059,114 +1056,6 @@ <h5 class="card-title">
10591056
</div>
10601057
</div>
10611058
</div>
1062-
<div class="row guide-category mb-4" id="high-availability">
1063-
<h2>High availability</h2>
1064-
<div class="col-sm-4">
1065-
<div class="card shadow-sm mb-4">
1066-
<div class="card-body">
1067-
<h5 class="card-title">
1068-
Multi-site deployments
1069-
1070-
1071-
</h5>
1072-
<span class="card-text">Connect multiple Keycloak deployments in different sites to increase the overall availability.</span>
1073-
<div>
1074-
</div>
1075-
<a href="https://www.keycloak.org/high-availability/introduction" class="stretched-link link-dark"></a>
1076-
</div>
1077-
</div>
1078-
</div>
1079-
<div class="col-sm-4">
1080-
<div class="card shadow-sm mb-4">
1081-
<div class="card-body">
1082-
<h5 class="card-title">
1083-
Concepts for multi-site deployments
1084-
1085-
1086-
</h5>
1087-
<span class="card-text">Understand multi-site deployment with synchronous replication.</span>
1088-
<div>
1089-
</div>
1090-
<a href="https://www.keycloak.org/high-availability/concepts-multi-site" class="stretched-link link-dark"></a>
1091-
</div>
1092-
</div>
1093-
</div>
1094-
<div class="col-sm-4">
1095-
<div class="card shadow-sm mb-4">
1096-
<div class="card-body">
1097-
<h5 class="card-title">
1098-
Building blocks multi-site deployments
1099-
1100-
1101-
</h5>
1102-
<span class="card-text">Learn about building blocks and suggested setups for multi-site deployments.</span>
1103-
<div>
1104-
</div>
1105-
<a href="https://www.keycloak.org/high-availability/bblocks-multi-site" class="stretched-link link-dark"></a>
1106-
</div>
1107-
</div>
1108-
</div>
1109-
<div class="col-sm-4">
1110-
<div class="card shadow-sm mb-4">
1111-
<div class="card-body">
1112-
<h5 class="card-title">
1113-
Taking a site offline
1114-
1115-
1116-
</h5>
1117-
<span class="card-text">Take a site offline so that it no longer processes client requests.</span>
1118-
<div>
1119-
</div>
1120-
<a href="https://www.keycloak.org/high-availability/operate-site-offline" class="stretched-link link-dark"></a>
1121-
</div>
1122-
</div>
1123-
</div>
1124-
<div class="col-sm-4">
1125-
<div class="card shadow-sm mb-4">
1126-
<div class="card-body">
1127-
<h5 class="card-title">
1128-
Bringing a site online
1129-
1130-
1131-
</h5>
1132-
<span class="card-text">Bring a site online so that it can process client requests.</span>
1133-
<div>
1134-
</div>
1135-
<a href="https://www.keycloak.org/high-availability/operate-site-online" class="stretched-link link-dark"></a>
1136-
</div>
1137-
</div>
1138-
</div>
1139-
<div class="col-sm-4">
1140-
<div class="card shadow-sm mb-4">
1141-
<div class="card-body">
1142-
<h5 class="card-title">
1143-
Synchronizing sites
1144-
1145-
1146-
</h5>
1147-
<span class="card-text">Synchronize an offline site with an online site.</span>
1148-
<div>
1149-
</div>
1150-
<a href="https://www.keycloak.org/high-availability/operate-synchronize" class="stretched-link link-dark"></a>
1151-
</div>
1152-
</div>
1153-
</div>
1154-
<div class="col-sm-4">
1155-
<div class="card shadow-sm mb-4">
1156-
<div class="card-body">
1157-
<h5 class="card-title">
1158-
Health checks for multi-site deployments
1159-
1160-
1161-
</h5>
1162-
<span class="card-text">Validate the health of a multi-site deployment.</span>
1163-
<div>
1164-
</div>
1165-
<a href="https://www.keycloak.org/high-availability/health-checks-multi-site" class="stretched-link link-dark"></a>
1166-
</div>
1167-
</div>
1168-
</div>
1169-
</div>
11701059
<div class="row guide-category mb-4" id="migration">
11711060
<h2>Migration</h2>
11721061
<div class="col-sm-4">

0 commit comments

Comments
 (0)