libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

Remove the preview note from Keycloak's HA guide

Browse source 
Closes #27084

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
This commit is contained in:
Alexander Schwartz 2024-02-16 15:02:11 +01:00 committed by Alexander Schwartz
parent 89af9e3ffd
commit 25f2b52afd
19 changed files with 10 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
common/src/main/java/org/keycloak/common/Profile.java
View file

@ -104,7 +104,7 @@ public class Profile {
TRANSIENT_USERS("Transient users for brokering", Type.EXPERIMENTAL), TRANSIENT_USERS("Transient users for brokering", Type.EXPERIMENTAL),
MULTI_SITE("Multi-site support", Type.PREVIEW), MULTI_SITE("Multi-site support", Type.DISABLED_BY_DEFAULT),
CLIENT_TYPES("Client Types", Type.EXPERIMENTAL), CLIENT_TYPES("Client Types", Type.EXPERIMENTAL),

2
common/src/test/java/org/keycloak/common/ProfileTest.java
View file

@ -96,7 +96,7 @@ public class ProfileTest {
disabledFeatures.add(Profile.Feature.KERBEROS); disabledFeatures.add(Profile.Feature.KERBEROS);
} }
assertEquals(profile.getDisabledFeatures(), disabledFeatures); assertEquals(profile.getDisabledFeatures(), disabledFeatures);
assertEquals(profile.getPreviewFeatures(), Profile.Feature.ADMIN_FINE_GRAINED_AUTHZ, Profile.Feature.MULTI_SITE, Profile.Feature.RECOVERY_CODES, Profile.Feature.SCRIPTS, Profile.Feature.TOKEN_EXCHANGE, Profile.Feature.CLIENT_SECRET_ROTATION, Profile.Feature.UPDATE_EMAIL, Profile.Feature.DPOP); assertEquals(profile.getPreviewFeatures(), Profile.Feature.ADMIN_FINE_GRAINED_AUTHZ, Profile.Feature.RECOVERY_CODES, Profile.Feature.SCRIPTS, Profile.Feature.TOKEN_EXCHANGE, Profile.Feature.CLIENT_SECRET_ROTATION, Profile.Feature.UPDATE_EMAIL, Profile.Feature.DPOP);
} }
@Test @Test

4
docs/guides/high-availability/bblocks-active-passive-sync.adoc
View file

@ -3,9 +3,7 @@
<@tmpl.guide <@tmpl.guide
title="Building blocks active-passive deployments" title="Building blocks active-passive deployments"
summary="Overview of building blocks, alternatives and not considered options" summary="Overview of building blocks, alternatives and not considered options" >
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269" >
The following building blocks are needed to set up an active-passive deployment with synchronous replication. The following building blocks are needed to set up an active-passive deployment with synchronous replication.

4
docs/guides/high-availability/concepts-active-passive-sync.adoc
View file

@ -3,9 +3,7 @@
<@tmpl.guide <@tmpl.guide
title="Concepts for active-passive deployments" title="Concepts for active-passive deployments"
summary="Understanding an active-passive deployment with synchronous replication" summary="Understanding an active-passive deployment with synchronous replication" >
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269" >
This topic describes a highly available active/passive setup and the behavior to expect. It outlines the requirements of the high availability active/passive architecture and describes the benefits and tradeoffs. This topic describes a highly available active/passive setup and the behavior to expect. It outlines the requirements of the high availability active/passive architecture and describes the benefits and tradeoffs.

2
docs/guides/high-availability/concepts-database-connections.adoc
View file

@ -4,8 +4,6 @@
<@tmpl.guide <@tmpl.guide
title="Concepts for database connection pools" title="Concepts for database connection pools"
summary="Understand these concepts to avoid resource exhaustion and congestion" summary="Understand these concepts to avoid resource exhaustion and congestion"
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
tileVisible="false" > tileVisible="false" >
This section is intended when you want to understand considerations and best practices on how to configure database connection pools for {project_name}. This section is intended when you want to understand considerations and best practices on how to configure database connection pools for {project_name}.

2
docs/guides/high-availability/concepts-infinispan-cli-batch.adoc
View file

@ -4,8 +4,6 @@
<@tmpl.guide <@tmpl.guide
title="Concepts to automate {jdgserver_name} CLI commands" title="Concepts to automate {jdgserver_name} CLI commands"
summary="{jdgserver_name} CLI commands can be automated by creating a `Batch` CR instance." summary="{jdgserver_name} CLI commands can be automated by creating a `Batch` CR instance."
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
tileVisible="false" > tileVisible="false" >
include::partials/infinispan/infinispan-attributes.adoc[] include::partials/infinispan/infinispan-attributes.adoc[]

2
docs/guides/high-availability/concepts-memory-and-cpu-sizing.adoc
View file

@ -4,8 +4,6 @@
<@tmpl.guide <@tmpl.guide
title="Concepts for sizing CPU and memory resources" title="Concepts for sizing CPU and memory resources"
summary="Understand these concepts to avoid resource exhaustion and congestion" summary="Understand these concepts to avoid resource exhaustion and congestion"
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
tileVisible="false" > tileVisible="false" >
Use this as a starting point to size a product environment. Use this as a starting point to size a product environment.

2
docs/guides/high-availability/concepts-threads.adoc
View file

@ -4,8 +4,6 @@
<@tmpl.guide <@tmpl.guide
title="Concepts for configuring thread pools" title="Concepts for configuring thread pools"
summary="Understand these concepts to avoid resource exhaustion and congestion" summary="Understand these concepts to avoid resource exhaustion and congestion"
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
tileVisible="false" > tileVisible="false" >

2
docs/guides/high-availability/connect-keycloak-to-external-infinispan.adoc
View file

@ -4,8 +4,6 @@
<@tmpl.guide <@tmpl.guide
title="Connect {project_name} with an external {jdgserver_name}" title="Connect {project_name} with an external {jdgserver_name}"
summary="Building block for an Infinispan deployment on Kubernetes" summary="Building block for an Infinispan deployment on Kubernetes"
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
tileVisible="false" > tileVisible="false" >
This topic describes advanced {jdgserver_name} configurations for {project_name} on Kubernetes. This topic describes advanced {jdgserver_name} configurations for {project_name} on Kubernetes.

2
docs/guides/high-availability/deploy-aurora-multi-az.adoc
View file

@ -4,8 +4,6 @@
<@tmpl.guide <@tmpl.guide
title="Deploy AWS Aurora in multiple availability zones" title="Deploy AWS Aurora in multiple availability zones"
summary="Building block for a database" summary="Building block for a database"
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
tileVisible="false" > tileVisible="false" >
This topic describes how to deploy an Aurora regional deployment of a PostgreSQL instance across multiple availability zones to tolerate one or more availability zone failures in a given AWS region. This topic describes how to deploy an Aurora regional deployment of a PostgreSQL instance across multiple availability zones to tolerate one or more availability zone failures in a given AWS region.

2
docs/guides/high-availability/deploy-aws-route53-loadbalancer.adoc
View file

@ -4,8 +4,6 @@
<@tmpl.guide <@tmpl.guide
title="Deploy an AWS Route 53 loadbalancer" title="Deploy an AWS Route 53 loadbalancer"
summary="Building block for a loadbalancer" summary="Building block for a loadbalancer"
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
tileVisible="false" > tileVisible="false" >
This topic describes the procedure required to configure DNS based failover for Multi-AZ {project_name} clusters using AWS Route53 for an active/passive setup. These instructions are intended for used with the setup described in the <@links.ha id="concepts-active-passive-sync"/> {section}. This topic describes the procedure required to configure DNS based failover for Multi-AZ {project_name} clusters using AWS Route53 for an active/passive setup. These instructions are intended for used with the setup described in the <@links.ha id="concepts-active-passive-sync"/> {section}.

2
docs/guides/high-availability/deploy-infinispan-kubernetes-crossdc.adoc
View file

@ -4,8 +4,6 @@
<@tmpl.guide <@tmpl.guide
title="Deploy {jdgserver_name} for HA with the {jdgserver_name} Operator" title="Deploy {jdgserver_name} for HA with the {jdgserver_name} Operator"
summary="Building block for an {jdgserver_name} deployment on Kubernetes" summary="Building block for an {jdgserver_name} deployment on Kubernetes"
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
tileVisible="false" > tileVisible="false" >
include::partials/infinispan/infinispan-attributes.adoc[] include::partials/infinispan/infinispan-attributes.adoc[]

2
docs/guides/high-availability/deploy-keycloak-kubernetes.adoc
View file

@ -4,8 +4,6 @@
<@tmpl.guide <@tmpl.guide
title="Deploy {project_name} for HA with the {project_name} Operator" title="Deploy {project_name} for HA with the {project_name} Operator"
summary="Building block for a {project_name} deployment" summary="Building block for a {project_name} deployment"
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
tileVisible="false" > tileVisible="false" >
This guide describes advanced {project_name} configurations for Kubernetes which are load tested and will recover from single Pod failures. This guide describes advanced {project_name} configurations for Kubernetes which are load tested and will recover from single Pod failures.

4
docs/guides/high-availability/introduction.adoc
View file

@ -3,9 +3,7 @@
<@tmpl.guide <@tmpl.guide
title="Multi-site deployments" title="Multi-site deployments"
summary="Connect multiple {project_name} deployments in different sites to increase the overall availability" summary="Connect multiple {project_name} deployments in different sites to increase the overall availability" >
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269" >
{project_name} supports deployments that consist of multiple {project_name} instances that connect to each other using its embedded Infinispan; load balancers can distribute the load evenly across those instances. {project_name} supports deployments that consist of multiple {project_name} instances that connect to each other using its embedded Infinispan; load balancers can distribute the load evenly across those instances.
Those setups are intended for a transparent network on a single site. Those setups are intended for a transparent network on a single site.

4
docs/guides/high-availability/operate-failover.adoc
View file

@ -3,9 +3,7 @@
<@tmpl.guide <@tmpl.guide
title="Fail over to the secondary site" title="Fail over to the secondary site"
summary="This describes the automatic and operational procedures necessary" summary="This describes the automatic and operational procedures necessary" >
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269" >
This {section} describes the steps to fail over from primary site to secondary site in a setup as outlined in <@links.ha id="concepts-active-passive-sync" /> together with the blueprints outlined in <@links.ha id="bblocks-active-passive-sync" />. This {section} describes the steps to fail over from primary site to secondary site in a setup as outlined in <@links.ha id="concepts-active-passive-sync" /> together with the blueprints outlined in <@links.ha id="bblocks-active-passive-sync" />.

4
docs/guides/high-availability/operate-network-partition-recovery.adoc
View file

@ -3,9 +3,7 @@
<@tmpl.guide <@tmpl.guide
title="Recover from an out-of-sync passive site" title="Recover from an out-of-sync passive site"
summary="This describes the automatic and operational procedures necessary" summary="This describes the automatic and operational procedures necessary" >
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269" >
This {section} describes the procedures required to synchronize the secondary site with the primary site in a setup as outlined in <@links.ha id="concepts-active-passive-sync" /> together with the blueprints outlined in <@links.ha id="bblocks-active-passive-sync" />. This {section} describes the procedures required to synchronize the secondary site with the primary site in a setup as outlined in <@links.ha id="concepts-active-passive-sync" /> together with the blueprints outlined in <@links.ha id="bblocks-active-passive-sync" />.

4
docs/guides/high-availability/operate-switch-back.adoc
View file

@ -3,9 +3,7 @@
<@tmpl.guide <@tmpl.guide
title="Switch back to the primary site" title="Switch back to the primary site"
summary="This describes the operational procedures necessary" summary="This describes the operational procedures necessary" >
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269" >
These procedures switch back to the primary site back after a failover or switchover to the secondary site. These procedures switch back to the primary site back after a failover or switchover to the secondary site.
In a setup as outlined in <@links.ha id="concepts-active-passive-sync" /> together with the blueprints outlined in <@links.ha id="bblocks-active-passive-sync" />. In a setup as outlined in <@links.ha id="concepts-active-passive-sync" /> together with the blueprints outlined in <@links.ha id="bblocks-active-passive-sync" />.

4
docs/guides/high-availability/operate-switch-over.adoc
View file

@ -3,9 +3,7 @@
<@tmpl.guide <@tmpl.guide
title="Switch over to the secondary site" title="Switch over to the secondary site"
summary="This topic describes the operational procedures necessary" summary="This topic describes the operational procedures necessary" >
preview="true"
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269" >
This procedure switches from the primary site to the secondary site when using a setup as outlined in <@links.ha id="concepts-active-passive-sync" /> together with the blueprints outlined in <@links.ha id="bblocks-active-passive-sync" />. This procedure switches from the primary site to the secondary site when using a setup as outlined in <@links.ha id="concepts-active-passive-sync" /> together with the blueprints outlined in <@links.ha id="bblocks-active-passive-sync" />.

2
quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/FeaturesDistTest.java vendored
View file

@ -26,7 +26,7 @@ import static org.keycloak.quarkus.runtime.cli.command.AbstractStartCommand.OPTI
@TestMethodOrder(MethodOrderer.OrderAnnotation.class) @TestMethodOrder(MethodOrderer.OrderAnnotation.class)
public class FeaturesDistTest { public class FeaturesDistTest {
private static final String PREVIEW_FEATURES_EXPECTED_LOG = "Preview features enabled: admin-fine-grained-authz:v1, client-secret-rotation:v1, dpop:v1, multi-site:v1, recovery-codes:v1, scripts:v1, token-exchange:v1, update-email:v1"; private static final String PREVIEW_FEATURES_EXPECTED_LOG = "Preview features enabled: admin-fine-grained-authz:v1, client-secret-rotation:v1, dpop:v1, recovery-codes:v1, scripts:v1, token-exchange:v1, update-email:v1";
@Test @Test
public void testEnableOnBuild(KeycloakDistribution dist) { public void testEnableOnBuild(KeycloakDistribution dist) {