mirror/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2025-12-20 05:50:08 -06:00
Code Issues Packages Projects Releases Wiki Activity
29,744 Commits 20 Branches 287 Tags
2f1628d1a9944a37282d818b2df77aaed0fb2307
Commit Graph

95 Commits

Author SHA1 Message Date
Ryan Emerson
ebd4a6936a Utilise community wording in downstream high-availability guides 
Closes #4428

Signed-off-by: Ryan Emerson <remerson@ibm.com>
Signed-off-by: Alexander Schwartz <alexander.schwartz@gmx.net>
Co-authored-by: Alexander Schwartz <alexander.schwartz@gmx.net>
 2025-11-25 09:10:21 +00:00
Martin Bartoš
b807a45091 Divide logging guide to sub-guides for every log handler (#43132) 
* Divide logging guide to sub-guides for every log handler

Closes #43125

Signed-off-by: Martin Bartoš <mabartos@redhat.com>

* Ability to set level offset to guides, remove emojis

Signed-off-by: Martin Bartoš <mabartos@redhat.com>

* Add all relevant options to the logging guide

Signed-off-by: Martin Bartoš <mabartos@redhat.com>

* Update docs/guides/server/logging/file.adoc

Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
Signed-off-by: Martin Bartoš <mabartos@redhat.com>

* Update docs/guides/server/logging/syslog.adoc

Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
Signed-off-by: Martin Bartoš <mabartos@redhat.com>

* Update docs/guides/server/logging/syslog.adoc

Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
Signed-off-by: Martin Bartoš <mabartos@redhat.com>

* Update docs/guides/server/logging/syslog.adoc

Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
Signed-off-by: Martin Bartoš <mabartos@redhat.com>

* Update docs/guides/server/logging/syslog.adoc

Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
Signed-off-by: Martin Bartoš <mabartos@redhat.com>

* Update docs/guides/server/logging/console.adoc

Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
Signed-off-by: Martin Bartoš <mabartos@redhat.com>

* Update docs/guides/server/logging/console.adoc

Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
Signed-off-by: Martin Bartoš <mabartos@redhat.com>

* Improve link to other section

Signed-off-by: Martin Bartoš <mabartos@redhat.com>

---------

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
 2025-10-17 16:37:48 +02:00
Pedro Ruivo
48f1978531 Update docs to include PostgreSQL SSL certificate 
Closes #43311

Signed-off-by: Pedro Ruivo <1492066+pruivo@users.noreply.github.com>
Co-authored-by: Pedro Ruivo <1492066+pruivo@users.noreply.github.com>
 2025-10-09 15:02:53 +02:00
Alexander Schwartz
7bcf08fa31 Adding AWS reference to the documentation 
Closes #43032

Signed-off-by: Alexander Schwartz <alexander.schwartz@ibm.com>
 2025-09-29 22:28:53 +02:00
Pedro Ruivo
746a8211ff Update documentation to prefer CacheCR in multi-site 
Closes #42980

Signed-off-by: Pedro Ruivo <1492066+pruivo@users.noreply.github.com>
Signed-off-by: Alexander Schwartz <alexander.schwartz@ibm.com>
Co-authored-by: Pedro Ruivo <1492066+pruivo@users.noreply.github.com>
Co-authored-by: Alexander Schwartz <alexander.schwartz@ibm.com>
 2025-09-26 11:06:28 +00:00
Ryan Emerson
93ede306f5 Refine high-availability guide wording 
Closes #42869

Signed-off-by: Ryan Emerson <remerson@ibm.com>
Signed-off-by: Alexander Schwartz <alexander.schwartz@ibm.com>
Co-authored-by: Alexander Schwartz <alexander.schwartz@ibm.com>
 2025-09-23 10:14:49 +00:00
Pedro Ruivo
47f85631f3 Automatically create external caches for MULTI_SITE deployments 
Closes #32129

Signed-off-by: Pedro Ruivo <1492066+pruivo@users.noreply.github.com>
Co-authored-by: Pedro Ruivo <1492066+pruivo@users.noreply.github.com>
 2025-09-19 18:56:38 +02:00
Pedro Ruivo
f9ec39bc5f Update tested load numbers 
Closes #42757

Signed-off-by: Pedro Ruivo <1492066+pruivo@users.noreply.github.com>
Signed-off-by: Pedro Ruivo <pruivo@users.noreply.github.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Pedro Ruivo <1492066+pruivo@users.noreply.github.com>
Co-authored-by: Alexander Schwartz <alexander.schwartz@gmx.net>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
 2025-09-19 15:42:17 +02:00
Steven Hawkins
e9bf3bc2f8 fix: updating docs related to the number of executor threads 
closes: #39342

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
 2025-09-16 17:02:15 +02:00
Ryan Emerson
a3c95a2a34 Document tested and supported configurations for single-cluster deployments 
Closes #42304

Signed-off-by: Ryan Emerson <remerson@ibm.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
 2025-09-09 19:49:22 +00:00
Ryan Emerson
17684f8011 Remove usage of the term stretched from single-cluster HA guides 
Closes #42358

Signed-off-by: Ryan Emerson <remerson@ibm.com>
 2025-09-05 15:49:19 +02:00
Ryan Emerson
4fec0a8630 Document that single-cluster deployments expect all Keycloak instances to serve traffic 
Closes #42305

Signed-off-by: Ryan Emerson <remerson@ibm.com>
Signed-off-by: Alexander Schwartz <alexander.schwartz@gmx.net>
Co-authored-by: Alexander Schwartz <alexander.schwartz@gmx.net>
 2025-09-03 18:30:13 +02:00
Alexander Schwartz
665f4140da Adding missing docs for 26.4 release notes 
Closes #42252

Signed-off-by: Alexander Schwartz <alexander.schwartz@gmx.net>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Vinod Anandan <vinod@owasp.org>
 2025-09-02 17:47:12 -03:00
Pedro Ruivo
f4ec4cff1a Configure topology information in Infinispan 
Closes #41933

Signed-off-by: Pedro Ruivo <1492066+pruivo@users.noreply.github.com>
Co-authored-by: Pedro Ruivo <1492066+pruivo@users.noreply.github.com>
 2025-09-01 14:40:39 +02:00
Alexander Schwartz
1eba022149 Document network latency requirements for high available setups 
Closes #42186

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
 2025-08-28 23:46:20 +02:00
Ryan Emerson
481555c97e Define default topologySpreadConstraints 
Closes #41729

Signed-off-by: Ryan Emerson <remerson@ibm.com>
 2025-08-20 13:58:37 +02:00
Ryan Emerson
cd42a503d2 Update observability metrics guides to reference single and multi-cluster architectures 
Closes #41938

Signed-off-by: Ryan Emerson <remerson@ibm.com>
 2025-08-20 13:31:52 +02:00
Ryan Emerson
907ee2e4e2 High-availability guide restructuring 
* Refactor high-availability guide to include both single and multi cluster architectures

Closes #30095
Closes #41585

Signed-off-by: Ryan Emerson <remerson@ibm.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Signed-off-by: Alexander Schwartz <alexander.schwartz@gmx.net>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <alexander.schwartz@gmx.net>
 2025-08-06 18:38:37 +00:00
Alexander Schwartz
74027bfbfe Remove obsolete information from the Keycloak deployment 
Closes #40375

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
 2025-06-11 09:17:48 -03:00
Alexander Schwartz
54499d94ab Avoid automatic DB upgrades (#39275) 
Closes #39274

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
 2025-04-29 09:02:10 +02:00
Pedro Ruivo
eafe08a73a Create CacheEmbeddedConfigProvider 
Closes #38497

Signed-off-by: Pedro Ruivo <pruivo@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
 2025-04-28 13:00:53 +02:00
andymunro
75557bc312 Adjust introductory sentences 
Closes #39008

Signed-off-by: AndyMunro <amunro@redhat.com>
 2025-04-25 09:18:04 +02:00
Alexander Schwartz
73ee966feb Sorting the chapters of the HA guide 
Closes #38721

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
 2025-04-08 07:23:53 -03:00
Alexander Schwartz
822eb4471d Ensure a sufficient virtual threads pool (#37197) 
Closes #37162

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
 2025-02-10 16:28:24 +01:00
Alexander Schwartz
d73794cdc1 Update referenced OpenShift version in the High Availability and sizing guide 
Closes #36691

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
 2025-01-22 13:57:57 +01:00
Michal Hajas
3839f8e3b5 Add metric for password validations (#36049) 
Closes #36048
Signed-off-by: Michal Hajas <mhajas@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
 2025-01-07 10:05:47 +01:00
Kamesh Akella
ac494d3fab update the sizing guide based on the ARM compute nodes 
Closes #35775

Signed-off-by: Kamesh Akella <kamesh.asp@gmail.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
 2024-12-18 12:26:25 +01:00
Kamesh Akella
047b28a63e update sizing guide with user event metrics info 
Closes #35640

Signed-off-by: Kamesh Akella <kamesh.asp@gmail.com>
Signed-off-by: Kamesh Akella <kakella@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <alexander.schwartz@gmx.net>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
 2024-12-09 17:27:03 +00:00
Pedro Ruivo
30196dfe12 Update Infinispan examples in the High Availability guide 
Closes #35451

Signed-off-by: Pedro Ruivo <pruivo@redhat.com>
 2024-12-04 16:44:37 +01:00
Cornelius Roemer
29abfd3e89 Fix typos in *.md and *.adoc files using codespell interactive mode 
Closes #35256

This PR fixes a bunch of typos in docs files.

I ran codespell on `*.adoc` and `*.md` files in the repo in interactive mode
carefully checking each identified typo and proposed fix for false positives.

The most widely read file with typos identified is likely the changelog/migration guide.

Signed-off-by: Cornelius Roemer <cornelius.roemer@gmail.com>
 2024-11-25 08:21:26 +01:00
AndyMunro
77de5bcec9 Address QE comments on HA guide 
Closes #34887

Signed-off-by: AndyMunro <amunro@redhat.com>
 2024-11-13 10:00:25 +01:00
Pedro Ruivo
33cae33ae4 Remove JGroups thread pool docs from HA Guide 
Clustering is disabled with multi-site deployment and there is no
JGroups thread pool to configure.

Closes #34715

Signed-off-by: Pedro Ruivo <pruivo@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
 2024-11-07 09:00:48 +00:00
Pedro Ruivo
cf2e2b692b Update sizing guide for client credential grant 
Closes #34347

Signed-off-by: Pedro Ruivo <pruivo@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Signed-off-by: Alexander Schwartz <alexander.schwartz@gmx.net>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <alexander.schwartz@gmx.net>
 2024-10-29 13:25:42 +00:00
Kamesh Akella
1dc3b08ba8 update the sizing guide with the correct instance type 
Closes #34315

Signed-off-by: Kamesh Akella <kamesh.asp@gmail.com>
 2024-10-24 21:55:51 +02:00
Pedro Ruivo
fffa9aa72e Enable virtual threads in Infinispan and JGroups by default 
Closes #33939

Signed-off-by: Pedro Ruivo <pruivo@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
 2024-10-21 16:02:28 +00:00
Alexander Schwartz
8e4c67bd3f Document supported configurations and limitations for multi-site 
Closes #33384

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
 2024-10-02 14:57:07 +02:00
Alexander Schwartz
cb12f03003 Rework AWS Lambda doc to show it is required (#33462) 
Closes #33461
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
 2024-10-02 12:42:11 +02:00
Kamesh Akella
d07d5ebf1a Add Health Checks for Multi-Site deployment to HA Docs 
Closes #33143

Signed-off-by: Kamesh Akella <kamesh.asp@gmail.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Signed-off-by: Kamesh Akella <kakella@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
 2024-10-02 08:43:25 +00:00
Pedro Ruivo
2d6140cb34 Revisit Multi Site Guide 
Closes #32745

Signed-off-by: Pedro Ruivo <pruivo@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
 2024-09-24 12:08:15 +00:00
Michal Hajas
d85ce41377 Update STONITH lambda with the latest changes from KCB 
Closes #32803

Signed-off-by: Michal Hajas <mhajas@redhat.com>
Signed-off-by: Ryan Emerson <remerson@redhat.com>
Co-authored-by: Ryan Emerson <remerson@redhat.com>
 2024-09-11 13:48:26 +02:00
Pedro Ruivo
3a8160b71d Remove session related caches from external Infinispan in HA guide 
Closes #32131

Signed-off-by: Pedro Ruivo <pruivo@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
 2024-08-30 10:35:45 +02:00
Alexander Schwartz
8e0d50edc0 Upgrade Keycloak's sizing guide for KC26 (#32344) 
Closes #32343
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Signed-off-by: Alexander Schwartz <alexander.schwartz@gmx.net>
Co-authored-by: Kamesh Akella <kakella@redhat.com>
 2024-08-27 16:38:38 +02:00
Michal Hajas
709165a90a High availability guide updates (#32093) 
* Remove connecting Infinispan to Keycloak building block
* Rephrase two sites restriction limitation
* Update the KCB generated yaml files for HA guide
* Remove setting number of owners to 1 for session caches as it is no longer necessary
* Add multi-site feature
* Remove histrograms and slos
* Replace stonith with fencing
* Switch for DG in community and product

Closes #31029

Signed-off-by: Michal Hajas <mhajas@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
 2024-08-19 13:29:11 +02:00
Pedro Ruivo
07c92c85cb Drop AuthenticatedClientSessionStore from user sessions 
New entities for client and user sessions, more query friendly.
The client sessions are found using query instead of storing them in the
user session entity.
Remove of sessions by its field is done based on queries.

Closes #30934

Signed-off-by: Pedro Ruivo <pruivo@redhat.com>
 2024-08-12 20:35:50 +02:00
Ryan Emerson
c0a51b94ea Update HA cache configurations to latest blueprint 
Closes #31029

Signed-off-by: Ryan Emerson <remerson@redhat.com>
 2024-08-07 19:06:14 +02:00
Ryan Emerson
31d610c2fc Upgrade to Infinispan 15.0.7.Final 
Closes #31963

Signed-off-by: Ryan Emerson <remerson@redhat.com>
 2024-08-07 13:32:23 +02:00
Ryan Emerson
db14ab1365 Refactor HA guide to refer to generic multi-site deployments 
Old Active/Passive guides replaced with Active/Active architecture, but
A/P vs A/A distinction hidden from users in favour of generic multi-site
docs.

Closes #31029

Signed-off-by: Ryan Emerson <remerson@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
 2024-08-07 08:22:59 +00:00
Steven Hawkins
14a9927e29 fix: scaling and tuning getting started guide 
closes: #29388

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
Signed-off-by: Steven Hawkins <shawkins@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
 2024-07-18 13:31:37 +00:00
Pedro Ruivo
9b39498085 Add default stack in cache-ispn.xml 
A bug in Infinispan prevents the metrics to be registered if the "stack"
is not specified.
Change the default configuration shipped with Keycloak to use the UDP
stack as default.
UDP is the default in previous Keycloak versions.

Fixes #31218

Signed-off-by: Pedro Ruivo <pruivo@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
 2024-07-16 12:05:38 +02:00
Steven Hawkins
4970a9b729 fix: deprecate KEYCLOAK_ADMIN and KEYCLOAK_ADMIN_PASSWORD 
closes: #30658

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
Signed-off-by: Steven Hawkins <shawkins@redhat.com>
Co-authored-by: Jon Koops <jonkoops@gmail.com>
 2024-07-11 18:07:57 +02:00