Skip to content

Commit d72b94a

Browse files
authored
Merge pull request #51032 from wjglerum/cleanup-keycloak-docs
Cleanup versions in the Keycloak documentation
2 parents 7b569c6 + 1d89b60 commit d72b94a

File tree

8 files changed

+8
-22
lines changed

8 files changed

+8
-22
lines changed

docs/src/main/asciidoc/_attributes.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
:logstash-image: ${logstash.image}
2020
:kibana-image: ${kibana.image}
2121
:keycloak-docker-image: ${keycloak.docker.image}
22-
:keycloak-server-version: ${keycloak.server.version}
2322
:jandex-version: ${jandex.version}
2423
:jandex-gradle-plugin-version: ${jandex-gradle-plugin.version}
2524
:kotlin-version: ${kotlin.version}

docs/src/main/asciidoc/security-keycloak-authorization.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -316,11 +316,10 @@ docker run --name keycloak \
316316
-e KC_BOOTSTRAP_ADMIN_PASSWORD=admin \
317317
-p 8543:8443 \
318318
-v "$(pwd)"/config/keycloak-keystore.jks:/etc/keycloak-keystore.jks \
319-
quay.io/keycloak/keycloak:{keycloak.version} \ <1>
320-
start --hostname-strict=false --https-key-store-file=/etc/keycloak-keystore.jks <2>
319+
{keycloak-docker-image} \
320+
start --hostname-strict=false --https-key-store-file=/etc/keycloak-keystore.jks <1>
321321
----
322-
<1> For `keycloak.version`, ensure the version is `{keycloak-server-version}` or later.
323-
<2> For Keycloak keystore, use the `keycloak-keystore.jks` file located at https://github.com/quarkusio/quarkus-quickstarts/blob/main/security-keycloak-authorization-quickstart/config/keycloak-keystore.jks[quarkus-quickstarts/security-keycloak-authorization-quickstart/config].
322+
<1> For Keycloak keystore, use the `keycloak-keystore.jks` file located at https://github.com/quarkusio/quarkus-quickstarts/blob/main/security-keycloak-authorization-quickstart/config/keycloak-keystore.jks[quarkus-quickstarts/security-keycloak-authorization-quickstart/config].
324323

325324
.Accessing the Keycloak server
326325

docs/src/main/asciidoc/security-oidc-bearer-token-authentication-tutorial.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -214,10 +214,9 @@ For more information, see the <<bearer-token-tutorial-keycloak-dev-mode>> sectio
214214
====
215215
[source,bash,subs=attributes+]
216216
----
217-
docker run --name keycloak -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin -p 8180:8080 quay.io/keycloak/keycloak:{keycloak.version} start-dev
217+
docker run --name keycloak -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin -p 8180:8080 {keycloak-docker-image} start-dev
218218
----
219219
====
220-
* Where the `keycloak.version` is set to version `{keycloak-server-version}` or later.
221220
. You can access your Keycloak server at http://localhost:8180[localhost:8180].
222221
. To access the Keycloak Administration console, log in as the `admin` user by using the following login credentials:
223222

docs/src/main/asciidoc/security-oidc-code-flow-authentication-tutorial.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -198,11 +198,9 @@ To start a Keycloak server, use Docker and run the following command:
198198

199199
[source,bash,subs=attributes+]
200200
----
201-
docker run --name keycloak -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin -p 8180:8080 quay.io/keycloak/keycloak:{keycloak.version} start-dev
201+
docker run --name keycloak -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin -p 8180:8080 {keycloak-docker-image} start-dev
202202
----
203203

204-
where `keycloak.version` is set to `{keycloak-server-version}` or later.
205-
206204
You can access your Keycloak Server at http://localhost:8180[localhost:8180].
207205

208206
To access the Keycloak Administration Console, log in as the `admin` user.

docs/src/main/asciidoc/security-openid-connect-client.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -502,11 +502,9 @@ To start a Keycloak Server, you can use Docker and just run the following comman
502502

503503
[source,bash,subs=attributes+]
504504
----
505-
docker run --name keycloak -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin -p 8180:8080 quay.io/keycloak/keycloak:{keycloak.version} start-dev
505+
docker run --name keycloak -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin -p 8180:8080 {keycloak-docker-image} start-dev
506506
----
507507

508-
Set `{keycloak.version}` to `{keycloak-server-version}` or later.
509-
510508
You can access your Keycloak Server at http://localhost:8180[localhost:8180].
511509

512510
Log in as the `admin` user to access the Keycloak Administration Console.

docs/src/main/asciidoc/security-openid-connect-dev-services.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ For more information, see xref:security-oidc-bearer-token-authentication.adoc#be
247247
[[keycloak-initialization]]
248248
=== Keycloak initialization
249249

250-
The `quay.io/keycloak/keycloak:{keycloak-server-version}` image which contains a Keycloak distribution powered by Quarkus is used to start a container by default.
250+
The `{keycloak-docker-image}` image which contains a Keycloak distribution powered by Quarkus is used to start a container by default.
251251
`quarkus.keycloak.devservices.image-name` can be used to change the Keycloak image name.
252252
For example, set it to `quay.io/keycloak/keycloak:19.0.3-legacy` to use a Keycloak distribution powered by WildFly.
253253
Be aware that a Quarkus-based Keycloak distribution is only available starting from Keycloak `20.0.0`.

docs/src/main/asciidoc/security-openid-connect-multitenancy.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -343,11 +343,9 @@ To start a Keycloak server, you can use Docker and run the following command:
343343

344344
[source,bash,subs=attributes+]
345345
----
346-
docker run --name keycloak -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin -p 8180:8080 quay.io/keycloak/keycloak:{keycloak.version} start-dev
346+
docker run --name keycloak -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin -p 8180:8080 {keycloak-docker-image} start-dev
347347
----
348348

349-
where `keycloak.version` is set to `{keycloak-server-version}` or higher.
350-
351349
Access your Keycloak server at http://localhost:8180[localhost:8180].
352350

353351
Log in as the `admin` user to access the Keycloak administration console.

integration-tests/smallrye-graphql-client-keycloak/src/test/java/io/quarkus/it/smallrye/graphql/keycloak/KeycloakRealmResourceManager.java

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
import org.keycloak.representations.idm.RolesRepresentation;
1616
import org.keycloak.representations.idm.UserRepresentation;
1717
import org.keycloak.util.JsonSerialization;
18-
import org.testcontainers.containers.GenericContainer;
1918

2019
import io.quarkus.test.common.QuarkusTestResourceLifecycleManager;
2120
import io.restassured.RestAssured;
@@ -24,11 +23,7 @@
2423
public class KeycloakRealmResourceManager implements QuarkusTestResourceLifecycleManager {
2524

2625
private static final String KEYCLOAK_SERVER_URL = System.getProperty("keycloak.url", "http://localhost:8180");
27-
//private static String KEYCLOAK_SERVER_URL;
2826
private static final String KEYCLOAK_REALM = "quarkus";
29-
//private static final String KEYCLOAK_IMAGE = "quay.io/keycloak/keycloak:22.0.5";
30-
31-
private GenericContainer<?> keycloak;
3227

3328
@Override
3429
public Map<String, String> start() {

0 commit comments

Comments
 (0)