Skip to content

Commit 835b086

Browse files
committed
Sync documentation of main branch
1 parent 0d70169 commit 835b086

File tree

7 files changed

+76
-46
lines changed

7 files changed

+76
-46
lines changed

_generated-doc/main/infra/quarkus-maven-plugin-goals.adoc

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3837,7 +3837,7 @@ Skip the execution of this mojo
38373837

38383838
= quarkus:update
38393839

3840-
Log Quarkus-related recommended updates, such as new Quarkus platform BOM versions and Quarkus extensions versions that aren't managed by the Quarkus platform BOMs.
3840+
Suggest project updates and create a recipe with the possibility to apply it.
38413841

38423842
[.configuration-reference, cols="70,15,15"]
38433843
|===
@@ -3866,7 +3866,7 @@ a| [[quarkus-maven-plugin-goal-update-noRewrite]] noRewrite
38663866

38673867
[.description]
38683868
--
3869-
Disable the rewrite feature.
3869+
Disable the rewrite feature. Deprecated: use -Drewrite=false instead
38703870
--
38713871
|`Boolean`
38723872
|`false`
@@ -3875,7 +3875,7 @@ a| [[quarkus-maven-plugin-goal-update-perModule]] perModule
38753875

38763876
[.description]
38773877
--
3878-
Display information per project module.
3878+
Deprecated: this option was unused
38793879
--
38803880
|`boolean`
38813881
|
@@ -3901,6 +3901,15 @@ a| [[quarkus-maven-plugin-goal-update-repos]] repos
39013901
|`List` (required)
39023902
|`${project.remoteProjectRepositories}`
39033903

3904+
a| [[quarkus-maven-plugin-goal-update-rewrite]] rewrite
3905+
3906+
[.description]
3907+
--
3908+
Run the suggested update recipe for this project.
3909+
--
3910+
|`Boolean`
3911+
|
3912+
39043913
a| [[quarkus-maven-plugin-goal-update-additionalUpdateRecipes]] additionalUpdateRecipes
39053914

39063915
[.description]
@@ -3914,7 +3923,7 @@ a| [[quarkus-maven-plugin-goal-update-rewriteDryRun]] rewriteDryRun
39143923

39153924
[.description]
39163925
--
3917-
Rewrite in dry-mode.
3926+
Do a dry run the suggested update recipe for this project.
39183927
--
39193928
|`Boolean`
39203929
|`false`

_versions/main/guides/_attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
:graalvm-flavor: jdk-21
1111
:mandrel-flavor: jdk-21
1212
:surefire-version: 3.5.2
13-
:gradle-version: 8.12
13+
:gradle-version: 8.13
1414
:elasticsearch-version: 8.15.0
1515
:elasticsearch-image: docker.io/elastic/elasticsearch:8.15.0
1616
:opensearch-image: docker.io/opensearchproject/opensearch:2.16.0

_versions/main/guides/grpc-generation-reference.adoc

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -188,28 +188,34 @@ To do this, define the following properties in the `<properties>` section:
188188

189189
These properties configure the gRPC version and the `protoc` version.
190190

191-
Then, add the `os-maven-plugin` extension and the `protobuf-maven-plugin` configuration to the `build` section:
191+
Then, add the `eu.maveniverse.maven.nisse:plugin3` and the `protobuf-maven-plugin` configuration to the `build` section:
192192

193193
[source,xml]
194194
----
195195
<build>
196-
<extensions>
197-
<extension>
198-
<groupId>kr.motd.maven</groupId>
199-
<artifactId>os-maven-plugin</artifactId>
200-
<version>${os-maven-plugin-version}</version>
201-
</extension>
202-
</extensions>
203-
204196
<plugins>
197+
<plugin>
198+
<groupId>eu.maveniverse.maven.nisse</groupId>
199+
<artifactId>plugin3</artifactId>
200+
<version>0.3.4</version>
201+
<executions>
202+
<execution>
203+
<id>inject-properties</id>
204+
<goals>
205+
<goal>inject-properties</goal>
206+
</goals>
207+
<phase>validate</phase>
208+
</execution>
209+
</executions>
210+
</plugin>
205211
<plugin>
206212
<groupId>org.xolstice.maven.plugins</groupId>
207213
<artifactId>protobuf-maven-plugin</artifactId> <!--1-->
208214
<version>${protobuf-maven-plugin-version}</version>
209215
<configuration>
210-
<protocArtifact>com.google.protobuf:protoc:${protoc.version}:exe:${os.detected.classifier}</protocArtifact> <!--2-->
216+
<protocArtifact>com.google.protobuf:protoc:${protoc.version}:exe:${nisse.os.classifier}</protocArtifact> <!--2-->
211217
<pluginId>grpc-java</pluginId>
212-
<pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}</pluginArtifact>
218+
<pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${nisse.os.classifier}</pluginArtifact>
213219
<protocPlugins>
214220
<protocPlugin>
215221
<id>quarkus-grpc-protoc-plugin</id>
@@ -244,7 +250,7 @@ Then, add the `os-maven-plugin` extension and the `protobuf-maven-plugin` config
244250
----
245251

246252
<1> The `protobuf-maven-plugin` generates stub classes from your gRPC service definition (`proto` files).
247-
<2> Class generation uses the tool `protoc`, which is OS-specific. This is why we use the `os-maven-plugin` to target the executable compatible with the operating system.
253+
<2> Class generation uses the tool `protoc`, which is OS-specific. This is why we use the Nisse Maven plugin to target the executable compatible with the operating system.
248254

249255
Note: This configuration instructs the `protobuf-maven-plugin` to generate default gRPC classes and classes using Mutiny to fit with the Quarkus development experience.
250256

-84.7 KB
Loading

_versions/main/guides/jreleaser.adoc

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -107,22 +107,30 @@ shell completion scripts, man pages, license, readme, and more.
107107
== Creating the distribution
108108

109109
We can leverage the link:http://maven.apache.org/plugins/maven-assembly-plugin/[maven-assembly-plugin] to create such
110-
a distribution. We'll also make use of the link:https://github.com/trustin/os-maven-plugin[os-maven-plugin] to properly
110+
a distribution. We'll also make use of the link:https://github.com/maveniverse/nisse[Nisse Maven plugin] to properly
111111
identify the platform on which this executable can run, adding said platform to the distribution's filename.
112112

113-
First, let's add the os-maven-plugin to the `pom.xml`. This plugin works as a Maven extension and as such must be added
113+
First, let's add the Nisse Maven plugin to the `pom.xml`. This plugin works as a Maven extension and as such must be added
114114
to the `<build>` section of the file:
115115

116116
[source,xml]
117117
----
118118
<build>
119-
<extensions>
120-
<extension>
121-
<groupId>kr.motd.maven</groupId>
122-
<artifactId>os-maven-plugin</artifactId>
123-
<version>1.7.1</version>
124-
</extension>
125-
</extensions>
119+
<plugins>
120+
<plugin>
121+
<groupId>eu.maveniverse.maven.plugins</groupId>
122+
<artifactId>nisse-plugin3</artifactId>
123+
<version>0.3.4</version>
124+
<executions>
125+
<execution>
126+
<id>inject-properties</id>
127+
<goals>
128+
<goal>inject-properties</goal>
129+
</goals>
130+
<phase>validate</phase>
131+
</execution>
132+
</executions>
133+
</plugin>
126134
<!-- ... -->
127135
----
128136

@@ -139,7 +147,7 @@ their own directory to avoid cluttering the `target` directory. Thus, let's add
139147

140148
Now we configure the maven-assembly-plugin to create a Zip and a Tar file containing the executable and any supporting files
141149
it may need to perform its job. Take special note on the name of the distribution, this is where we make use of the platform
142-
properties detected by the os-maven-plugin. This plugin is configured in its own profile with the `single` goal bound to
150+
properties detected by the os-detector-maven-plugin. This plugin is configured in its own profile with the `single` goal bound to
143151
the `package` phase. It's done this way to avoid rebuilding the distribution every single time the build is invoked, as we
144152
only needed when we're ready for a release.
145153

@@ -156,7 +164,7 @@ only needed when we're ready for a release.
156164
<configuration>
157165
<attach>false</attach>
158166
<appendAssemblyId>false</appendAssemblyId>
159-
<finalName>${project.artifactId}-${project.version}-${os.detected.classifier}</finalName>
167+
<finalName>${project.artifactId}-${project.version}-${nisse.os.classifier}</finalName>
160168
<outputDirectory>${distribution.directory}</outputDirectory>
161169
<workDirectory>${project.build.directory}/assembly/work</workDirectory>
162170
<descriptors>
@@ -657,14 +665,21 @@ As a reference, these are the full contents of the `pom.xml`:
657665
</dependency>
658666
</dependencies>
659667
<build>
660-
<extensions>
661-
<extension>
662-
<groupId>kr.motd.maven</groupId>
663-
<artifactId>os-maven-plugin</artifactId>
664-
<version>1.7.1</version>
665-
</extension>
666-
</extensions>
667668
<plugins>
669+
<plugin>
670+
<groupId>eu.maveniverse.maven.nisse</groupId>
671+
<artifactId>plugin3</artifactId>
672+
<version>0.3.4</version>
673+
<executions>
674+
<execution>
675+
<id>inject-properties</id>
676+
<goals>
677+
<goal>inject-properties</goal>
678+
</goals>
679+
<phase>validate</phase>
680+
</execution>
681+
</executions>
682+
</plugin>
668683
<plugin>
669684
<groupId>${quarkus.platform.group-id}</groupId>
670685
<artifactId>quarkus-maven-plugin</artifactId>
@@ -723,7 +738,7 @@ As a reference, these are the full contents of the `pom.xml`:
723738
<configuration>
724739
<attach>false</attach>
725740
<appendAssemblyId>false</appendAssemblyId>
726-
<finalName>${project.artifactId}-${project.version}-${os.detected.classifier}</finalName>
741+
<finalName>${project.artifactId}-${project.version}-${nisse.os.classifier}</finalName>
727742
<outputDirectory>${distribution.directory}</outputDirectory>
728743
<workDirectory>${project.build.directory}/assembly/work</workDirectory>
729744
<descriptors>

_versions/main/guides/rest-client.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2130,7 +2130,7 @@ To change this behavior, set the `quarkus.rest-client.scope` property to the ful
21302130

21312131
== Further reading
21322132

2133-
* link:https://download.eclipse.org/microprofile/microprofile-rest-client-2.0/microprofile-rest-client-spec-2.0.html[MicroProfile Rest Client specification]
2133+
* link:https://download.eclipse.org/microprofile/microprofile-rest-client-4.0/microprofile-rest-client-spec-4.0.html[MicroProfile Rest Client specification]
21342134

21352135
== Configuration Reference
21362136

_versions/main/guides/security-keycloak-authorization.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ The Keycloak Authorization extension, `quarkus-keycloak-authorization`, extends
2020
It features a policy enforcer that dynamically manages access to secured resources.
2121
Access is governed by permissions defined in Keycloak, supporting flexible and dynamic Resource-Based Access Control (RBAC).
2222

23-
Use the `quarkus-keycloak-authorization` extension only if you are using Keycloak and Keycloak Authorization Services is enabled in your environment to handle authorization decisions.
23+
Use the `quarkus-keycloak-authorization` extension only if you are using Keycloak and the Keycloak Authorization Services feature is enabled in your environment to handle authorization decisions.
2424

25-
If you are not using Keycloak, or if Keycloak is configured without Keycloak Authorization Services, use the `quarkus-oidc` extension instead.
25+
If you are not using Keycloak, or if Keycloak is configured without the Keycloak Authorization Services feature, use the `quarkus-oidc` extension instead.
2626

2727
.How it works
2828

@@ -52,7 +52,7 @@ It complements explicit mechanisms such as role-based access control with dynami
5252

5353
Before using this extension, ensure the following:
5454

55-
. Keycloak Authorization Services is enabled in your Keycloak instance.
55+
. Keycloak Authorization Services feature is enabled in your Keycloak instance.
5656
. Your Quarkus application includes the `quarkus-keycloak-authorization` extension.
5757

5858
For detailed steps, see the xref:security-oidc-bearer-token-authentication.adoc[OIDC Bearer Token Authentication] guide.
@@ -319,7 +319,6 @@ docker run --name keycloak \
319319
quay.io/keycloak/keycloak:{keycloak.version} \ <1>
320320
start --hostname-strict=false --https-key-store-file=/etc/keycloak-keystore.jks <2>
321321
----
322-
323322
<1> For `keycloak.version`, ensure the version is `26.0.7` or later.
324323
<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].
325324

@@ -335,7 +334,8 @@ docker run --name keycloak \
335334
To create a new realm, import the link:{quickstarts-tree-url}/security-keycloak-authorization-quickstart/config/quarkus-realm.json[realm configuration file].
336335
For detailed steps on creating realms, refer to the Keycloak documentation: https://www.keycloak.org/docs/latest/server_admin/index.html#_create-realm[Create a new realm].
337336

338-
After importing the realm, you can review the resource permissions:
337+
After importing the realm, go to Clients, choose the `backend-service` client, and select the Authorization and Resources tab for this client.
338+
You can now review the resource permissions:
339339

340340
image::keycloak-authorization-permissions.png[alt=Keycloak Authorization Permissions,role="center"]
341341

@@ -432,7 +432,7 @@ After a while, run the native binary:
432432

433433
[source,bash]
434434
----
435-
./target/security-keycloak-authorization-quickstart-runner
435+
./target/security-keycloak-authorization-quickstart-1.0.0-SNAPSHOT-runner
436436
----
437437

438438
[[testing]]
@@ -661,7 +661,7 @@ public class ProtectedResource {
661661
<1> The `/standard-way` sub-path requires both the resource permission and the `read` scope, based on the configuration set in the `application.properties` file.
662662
<2> The `/programmatic-way` sub-path checks only for the `Scope Permission Resource` permission by default. However, you can enforce additional constraints, such as scope requirements, by using `SecurityIdentity#checkPermission`.
663663
<3> The `@PermissionsAllowed` annotation at `/annotation-way` restricts access to requests that have the `Scope Permission Resource` permission along with the `read` scope.
664-
For more information, see the section xref:security-authorize-web-endpoints-reference.adoc#standard-security-annotations[Authorization using annotations] of the Security Authorization guide.
664+
For more information, see the section xref:security-authorize-web-endpoints-reference.adoc#standard-security-annotations[Authorization using annotations] of the Authorization of web endpoints guide.
665665

666666
== Multi-tenancy
667667

@@ -735,7 +735,7 @@ public class CustomTenantPolicyConfigResolver implements TenantPolicyConfigResol
735735
private final KeycloakPolicyEnforcerTenantConfig newTenantConfig;
736736
737737
public CustomTenantPolicyConfigResolver(KeycloakPolicyEnforcerConfig enforcerConfig) {
738-
this.enhancedTenantConfig = KeycloakPolicyEnforcerTenantConfig.builder(config) <1>
738+
this.enhancedTenantConfig = KeycloakPolicyEnforcerTenantConfig.builder(enforcerConfig.defaultTenant()) <1>
739739
.paths("/enhanced-config")
740740
.permissionName("Permission Name")
741741
.get("read-scope")
@@ -750,7 +750,7 @@ public class CustomTenantPolicyConfigResolver implements TenantPolicyConfigResol
750750
public Uni<KeycloakPolicyEnforcerTenantConfig> resolve(RoutingContext routingContext, OidcTenantConfig tenantConfig,
751751
OidcRequestContext<KeycloakPolicyEnforcerTenantConfig> requestContext) {
752752
String path = routingContext.normalizedPath();
753-
String tenantId = tenantConfig.tenantId.orElse(null);
753+
String tenantId = tenantConfig.tenantId().orElse(null);
754754
if ("enhanced-config-tenant".equals(tenantId) && path.equals("/enhanced-config")) {
755755
return Uni.createFrom().item(enhancedTenantConfig);
756756
} else if ("new-config-tenant".equals(tenantId) && path.equals("/new-config")) {

0 commit comments

Comments
 (0)