Skip to content

Commit 533cf9a

Browse files
committed
Sync documentation of main branch
1 parent 693f74c commit 533cf9a

9 files changed

Lines changed: 296 additions & 6 deletions

File tree

_data/versioned/main/index/quarkus.yaml

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1176,6 +1176,18 @@ types:
11761176
- devops
11771177
type: guide
11781178
url: /guides/ansible
1179+
- title: Automatic service registration with SmallRye Stork for Quarkus
1180+
filename: stork-registration.adoc
1181+
summary: "This guide explains how to enable automatic registration and deregistration of a Quarkus application using SmallRye Stork and Consul, with minimal or no configuration."
1182+
categories: cloud
1183+
topics:
1184+
- service-discovery
1185+
- consul
1186+
extensions:
1187+
- io.quarkus:quarkus-smallrye-stork
1188+
type: guide
1189+
status: preview
1190+
url: /guides/stork-registration
11791191
- title: Azure Functions
11801192
filename: azure-functions.adoc
11811193
summary: Integrate Quarkus with the Microsoft Azure functions that you have written.
@@ -3029,7 +3041,7 @@ types:
30293041
- io.quarkus:quarkus-security-webauthn
30303042
id: security-webauthn
30313043
type: guide
3032-
status: preview
3044+
status: experimental
30333045
url: /guides/security-webauthn
30343046
- title: Using Security with an LDAP Realm
30353047
filename: security-ldap.adoc

_data/versioned/main/index/relations.yaml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23092,7 +23092,15 @@
2309223092
url: /guides/stork-kubernetes
2309323093
type: guide
2309423094
matches: 3
23095+
- title: Automatic service registration with SmallRye Stork for Quarkus
23096+
url: /guides/stork-registration
23097+
type: guide
23098+
matches: 1
2309523099
sameExtensions:
23100+
- title: Automatic service registration with SmallRye Stork for Quarkus
23101+
url: /guides/stork-registration
23102+
type: guide
23103+
matches: 1
2309623104
- title: Stork Reference Guide
2309723105
url: /guides/stork-reference
2309823106
type: reference
@@ -23111,6 +23119,10 @@
2311123119
url: /guides/stork-reference
2311223120
type: reference
2311323121
matches: 3
23122+
- title: Automatic service registration with SmallRye Stork for Quarkus
23123+
url: /guides/stork-registration
23124+
type: guide
23125+
matches: 1
2311423126
- title: Deploying Quarkus applications compiled to native executables
2311523127
url: /guides/deploying-to-openshift-native-howto
2311623128
type: howto
@@ -23156,6 +23168,10 @@
2315623168
type: howto
2315723169
matches: 1
2315823170
sameExtensions:
23171+
- title: Automatic service registration with SmallRye Stork for Quarkus
23172+
url: /guides/stork-registration
23173+
type: guide
23174+
matches: 1
2315923175
- title: Deploying your gRPC Service in Kubernetes
2316023176
url: /guides/grpc-kubernetes
2316123177
type: guide
@@ -23186,11 +23202,46 @@
2318623202
url: /guides/stork-kubernetes
2318723203
type: guide
2318823204
matches: 3
23205+
- title: Automatic service registration with SmallRye Stork for Quarkus
23206+
url: /guides/stork-registration
23207+
type: guide
23208+
matches: 1
23209+
sameExtensions:
23210+
- title: Automatic service registration with SmallRye Stork for Quarkus
23211+
url: /guides/stork-registration
23212+
type: guide
23213+
matches: 1
23214+
- title: Getting Started with SmallRye Stork
23215+
url: /guides/stork
23216+
type: guide
23217+
matches: 1
23218+
- title: Using Stork with Kubernetes
23219+
url: /guides/stork-kubernetes
23220+
type: guide
23221+
matches: 1
23222+
/guides/stork-registration:
23223+
sameTopics:
23224+
- title: Getting Started with SmallRye Stork
23225+
url: /guides/stork
23226+
type: guide
23227+
matches: 1
23228+
- title: Stork Reference Guide
23229+
url: /guides/stork-reference
23230+
type: reference
23231+
matches: 1
23232+
- title: Using Stork with Kubernetes
23233+
url: /guides/stork-kubernetes
23234+
type: guide
23235+
matches: 1
2318923236
sameExtensions:
2319023237
- title: Getting Started with SmallRye Stork
2319123238
url: /guides/stork
2319223239
type: guide
2319323240
matches: 1
23241+
- title: Stork Reference Guide
23242+
url: /guides/stork-reference
23243+
type: reference
23244+
matches: 1
2319423245
- title: Using Stork with Kubernetes
2319523246
url: /guides/stork-kubernetes
2319623247
type: guide

_generated-doc/main/config/quarkus-all-config.adoc

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93975,6 +93975,27 @@ endif::add-copy-button-to-env-var[]
9397593975
|Map<String,String>
9397693976
|
9397793977

93978+
a| [[quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-enabled]] [.property-path]##link:#quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-enabled[`quarkus.stork."service-name".service-registrar.enabled`]##
93979+
ifdef::add-copy-button-to-config-props[]
93980+
config_property_copy_button:+++quarkus.stork."service-name".service-registrar.enabled+++[]
93981+
endif::add-copy-button-to-config-props[]
93982+
93983+
93984+
[.description]
93985+
--
93986+
Whether automatic registration and deregistration of service instances is enabled.
93987+
93988+
93989+
ifdef::add-copy-button-to-env-var[]
93990+
Environment variable: env_var_with_copy_button:+++QUARKUS_STORK__SERVICE_NAME__SERVICE_REGISTRAR_ENABLED+++[]
93991+
endif::add-copy-button-to-env-var[]
93992+
ifndef::add-copy-button-to-env-var[]
93993+
Environment variable: `+++QUARKUS_STORK__SERVICE_NAME__SERVICE_REGISTRAR_ENABLED+++`
93994+
endif::add-copy-button-to-env-var[]
93995+
--
93996+
|boolean
93997+
|`+++true+++`
93998+
9397893999
a| [[quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-type]] [.property-path]##link:#quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-type[`quarkus.stork."service-name".service-registrar.type`]##
9397994000
ifdef::add-copy-button-to-config-props[]
9398094001
config_property_copy_button:+++quarkus.stork."service-name".service-registrar.type+++[]
@@ -93994,7 +94015,7 @@ Environment variable: `+++QUARKUS_STORK__SERVICE_NAME__SERVICE_REGISTRAR_TYPE+++
9399494015
endif::add-copy-button-to-env-var[]
9399594016
--
9399694017
|string
93997-
|required icon:exclamation-circle[title=Configuration property is required]
94018+
|
9399894019

9399994020
a| [[quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-parameters]] [.property-path]##link:#quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-parameters[`quarkus.stork."service-name".service-registrar."parameters"`]##
9400094021
ifdef::add-copy-button-to-config-props[]

_generated-doc/main/config/quarkus-smallrye-stork.adoc

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,27 @@ endif::add-copy-button-to-env-var[]
9595
|Map<String,String>
9696
|
9797

98+
a| [[quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-enabled]] [.property-path]##link:#quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-enabled[`quarkus.stork."service-name".service-registrar.enabled`]##
99+
ifdef::add-copy-button-to-config-props[]
100+
config_property_copy_button:+++quarkus.stork."service-name".service-registrar.enabled+++[]
101+
endif::add-copy-button-to-config-props[]
102+
103+
104+
[.description]
105+
--
106+
Whether automatic registration and deregistration of service instances is enabled.
107+
108+
109+
ifdef::add-copy-button-to-env-var[]
110+
Environment variable: env_var_with_copy_button:+++QUARKUS_STORK__SERVICE_NAME__SERVICE_REGISTRAR_ENABLED+++[]
111+
endif::add-copy-button-to-env-var[]
112+
ifndef::add-copy-button-to-env-var[]
113+
Environment variable: `+++QUARKUS_STORK__SERVICE_NAME__SERVICE_REGISTRAR_ENABLED+++`
114+
endif::add-copy-button-to-env-var[]
115+
--
116+
|boolean
117+
|`+++true+++`
118+
98119
a| [[quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-type]] [.property-path]##link:#quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-type[`quarkus.stork."service-name".service-registrar.type`]##
99120
ifdef::add-copy-button-to-config-props[]
100121
config_property_copy_button:+++quarkus.stork."service-name".service-registrar.type+++[]
@@ -114,7 +135,7 @@ Environment variable: `+++QUARKUS_STORK__SERVICE_NAME__SERVICE_REGISTRAR_TYPE+++
114135
endif::add-copy-button-to-env-var[]
115136
--
116137
|string
117-
|required icon:exclamation-circle[title=Configuration property is required]
138+
|
118139

119140
a| [[quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-parameters]] [.property-path]##link:#quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-parameters[`quarkus.stork."service-name".service-registrar."parameters"`]##
120141
ifdef::add-copy-button-to-config-props[]

_generated-doc/main/config/quarkus-smallrye-stork_quarkus.stork.adoc

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,27 @@ endif::add-copy-button-to-env-var[]
9595
|Map<String,String>
9696
|
9797

98+
a| [[quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-enabled]] [.property-path]##link:#quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-enabled[`quarkus.stork."service-name".service-registrar.enabled`]##
99+
ifdef::add-copy-button-to-config-props[]
100+
config_property_copy_button:+++quarkus.stork."service-name".service-registrar.enabled+++[]
101+
endif::add-copy-button-to-config-props[]
102+
103+
104+
[.description]
105+
--
106+
Whether automatic registration and deregistration of service instances is enabled.
107+
108+
109+
ifdef::add-copy-button-to-env-var[]
110+
Environment variable: env_var_with_copy_button:+++QUARKUS_STORK__SERVICE_NAME__SERVICE_REGISTRAR_ENABLED+++[]
111+
endif::add-copy-button-to-env-var[]
112+
ifndef::add-copy-button-to-env-var[]
113+
Environment variable: `+++QUARKUS_STORK__SERVICE_NAME__SERVICE_REGISTRAR_ENABLED+++`
114+
endif::add-copy-button-to-env-var[]
115+
--
116+
|boolean
117+
|`+++true+++`
118+
98119
a| [[quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-type]] [.property-path]##link:#quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-type[`quarkus.stork."service-name".service-registrar.type`]##
99120
ifdef::add-copy-button-to-config-props[]
100121
config_property_copy_button:+++quarkus.stork."service-name".service-registrar.type+++[]
@@ -114,7 +135,7 @@ Environment variable: `+++QUARKUS_STORK__SERVICE_NAME__SERVICE_REGISTRAR_TYPE+++
114135
endif::add-copy-button-to-env-var[]
115136
--
116137
|string
117-
|required icon:exclamation-circle[title=Configuration property is required]
138+
|
118139

119140
a| [[quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-parameters]] [.property-path]##link:#quarkus-smallrye-stork_quarkus-stork-service-name-service-registrar-parameters[`quarkus.stork."service-name".service-registrar."parameters"`]##
120141
ifdef::add-copy-button-to-config-props[]

_generated-doc/main/infra/quarkus-all-build-items.adoc

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9322,6 +9322,31 @@ _No Javadoc found_
93229322
_No Javadoc found_
93239323

93249324

9325+
|===
9326+
== SmallRye Stork
9327+
[.configuration-reference,cols=2*]
9328+
|===
9329+
h|Class Name
9330+
h|Attributes
9331+
9332+
9333+
9334+
9335+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/smallrye-stork/deployment/src/main/java/io/quarkus/stork/deployment/builditem/StorkInitializedBuildItem.java[`io.quarkus.stork.deployment.builditem.StorkInitializedBuildItem`, window="_blank"]
9336+
[.description]
9337+
--
9338+
Build item used as a marker to indicate that Stork initialization has been recorded.
9339+
Its presence ensures that subsequent build steps depending on an initialized Stork (e.g. service instance registration) are executed in the correct order.
9340+
-- a|None
9341+
9342+
9343+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/smallrye-stork/deployment/src/main/java/io/quarkus/stork/deployment/builditem/StorkRegistrationConfigReadyBuildItem.java[`io.quarkus.stork.deployment.builditem.StorkRegistrationConfigReadyBuildItem`, window="_blank"]
9344+
[.description]
9345+
--
9346+
Build item used as a marker to indicate that the automatic service registration configuration has been processed.
9347+
This build item is produced after checking the application dependencies and preparing the registration configuration. If no explicit configuration is found, a default minimal configuration is created.
9348+
It triggers the next build step, which initializes Stork.
9349+
-- a|None
93259350
|===
93269351
== Spring - DI
93279352
[.configuration-reference,cols=2*]

_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.4
13-
:gradle-version: 9.2.1
13+
:gradle-version: 9.3.0
1414
:db2-image: icr.io/db2_community/db2:12.1.0.0
1515
:mariadb-image: docker.io/library/mariadb:10.11
1616
:mssql-image: mcr.microsoft.com/mssql/server:2022-latest

_versions/main/guides/security-webauthn.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
66
[id="security-webauthn"]
77
= Using Security with WebAuthn
88
include::_attributes.adoc[]
9-
:extension-status: preview
9+
:extension-status: experimental
1010
:categories: security
1111
:topics: security,webauthn,authorization
1212
:extensions: io.quarkus:quarkus-security-webauthn

0 commit comments

Comments
 (0)