Skip to content

Commit 0e976fc

Browse files
committed
Sync documentation of main branch
1 parent 6be98f1 commit 0e976fc

File tree

36 files changed

+1766
-117
lines changed

36 files changed

+1766
-117
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ types:
55
- title: Authorization of web endpoints
66
filename: security-authorize-web-endpoints-reference.adoc
77
summary: Quarkus has an integrated pluggable web security layer.
8-
categories: "security, web"
8+
categories: "web, security"
99
id: security-authorize-web-endpoints-reference
1010
type: reference
1111
url: /guides/security-authorize-web-endpoints-reference
@@ -18,7 +18,7 @@ types:
1818
- title: Command Mode Applications
1919
filename: command-mode-reference.adoc
2020
summary: This reference guide explains how to develop command line applications with Quarkus.
21-
categories: "command-line, core"
21+
categories: "core, command-line"
2222
type: reference
2323
url: /guides/command-mode-reference
2424
- title: Configuration Reference Guide
@@ -131,14 +131,14 @@ types:
131131
- title: Authentication mechanisms in Quarkus
132132
filename: security-authentication-mechanisms-concept.adoc
133133
summary: "The Quarkus Security framework supports multiple authentication mechanisms, which you can use to secure your applications."
134-
categories: "security, web"
134+
categories: "web, security"
135135
id: security-authentication-mechanisms-concept
136136
type: concepts
137137
url: /guides/security-authentication-mechanisms-concept
138138
- title: Basic authentication
139139
filename: security-basic-authentication-concept.adoc
140140
summary: HTTP Basic authentication is one of the least resource-demanding techniques that enforce access controls to web resources.
141-
categories: "security, web"
141+
categories: "web, security"
142142
id: security-basic-authentication-concept
143143
type: concepts
144144
url: /guides/security-basic-authentication-concept
@@ -152,21 +152,21 @@ types:
152152
- title: OpenID Connect (OIDC) Bearer authentication
153153
filename: security-oidc-bearer-token-authentication-concept.adoc
154154
summary: Secure HTTP access to Jakarta REST (formerly known as JAX-RS) endpoints in your application with Bearer authentication by using the Quarkus OpenID Connect (OIDC) extension.
155-
categories: "security, web"
155+
categories: "web, security"
156156
id: security-oidc-bearer-token-authentication-concept
157157
type: concepts
158158
url: /guides/security-oidc-bearer-token-authentication-concept
159159
- title: OpenID Connect authorization code flow mechanism for protecting web applications
160160
filename: security-oidc-code-flow-authentication-concept.adoc
161161
summary: "To protect your web applications, you can use the authorization code flow mechanism provided by the Quarkus OpenID Connect (OIDC) extension."
162-
categories: "security, web"
162+
categories: "web, security"
163163
id: security-oidc-code-flow-authentication-concept
164164
type: concepts
165165
url: /guides/security-oidc-code-flow-authentication-concept
166166
- title: Proactive authentication
167167
filename: security-proactive-authentication-concept.adoc
168168
summary: Proactive authentication is enabled in Quarkus by default.
169-
categories: "security, web"
169+
categories: "web, security"
170170
id: security-proactive-authentication-concept
171171
type: concepts
172172
url: /guides/security-proactive-authentication-concept
@@ -201,7 +201,7 @@ types:
201201
- title: Security vulnerability detection and reporting in Quarkus
202202
filename: security-vulnerability-detection-concept.adoc
203203
summary: Most of the Quarkus tags are registered in the US National Vulnerability Database (NVD) in Common Platform Enumeration (CPE) name format.
204-
categories: "security, contributing"
204+
categories: "contributing, security"
205205
id: security-vulnerability-detection-concept
206206
type: concepts
207207
url: /guides/security-vulnerability-detection-concept
@@ -276,7 +276,7 @@ types:
276276
- title: Protect a web application by using OpenID Connect (OIDC) authorization code flow
277277
filename: security-oidc-code-flow-authentication-tutorial.adoc
278278
summary: "With the Quarkus OpenID Connect (OIDC) extension, you can protect application HTTP endpoints by using the OIDC Authorization Code Flow mechanism."
279-
categories: "security, web"
279+
categories: "web, security"
280280
id: security-oidc-code-flow-authentication-tutorial
281281
type: tutorial
282282
url: /guides/security-oidc-code-flow-authentication-tutorial
@@ -289,7 +289,7 @@ types:
289289
- title: Secure a Quarkus application with Basic authentication and Jakarta Persistence
290290
filename: security-basic-authentication-tutorial.adoc
291291
summary: Secure your Quarkus application endpoints by combining the built-in Quarkus Basic authentication with the Jakarta Persistence identity provider to enable role-based access control (RBAC).
292-
categories: "security, getting-started"
292+
categories: "getting-started, security"
293293
id: security-basic-authentication-tutorial
294294
type: tutorial
295295
url: /guides/security-basic-authentication-tutorial
@@ -345,7 +345,7 @@ types:
345345
- title: AppCDS
346346
filename: appcds.adoc
347347
summary: This reference guide explains how to enable AppCDS with Quarkus.
348-
categories: "cloud, core"
348+
categories: "core, cloud"
349349
type: guide
350350
url: /guides/appcds
351351
- title: Application Data Caching
@@ -484,7 +484,7 @@ types:
484484
- title: Deploying on OpenShift
485485
filename: deploying-to-openshift.adoc
486486
summary: This guide covers how to deploy a native application on OpenShift.
487-
categories: "cloud, native"
487+
categories: "native, cloud"
488488
id: deploy-openshift
489489
type: guide
490490
url: /guides/deploying-to-openshift
@@ -539,7 +539,7 @@ types:
539539
- title: Dev Services for Databases
540540
filename: databases-dev-services.adoc
541541
summary: "When testing or running in dev mode Quarkus can provide you with a zero-config database out of the box, a feature we refer to as Dev Services."
542-
categories: "data, tooling"
542+
categories: "tooling, data"
543543
type: guide
544544
url: /guides/databases-dev-services
545545
- title: Dev Services for Elasticsearch
@@ -751,7 +751,7 @@ types:
751751
- title: Kubernetes extension
752752
filename: deploying-to-kubernetes.adoc
753753
summary: This guide covers how to deploy a native application on Kubernetes.
754-
categories: "cloud, native"
754+
categories: "native, cloud"
755755
id: deploy-kubernetes
756756
type: guide
757757
url: /guides/deploying-to-kubernetes
@@ -984,7 +984,7 @@ types:
984984
- title: SmallRye Fault Tolerance
985985
filename: smallrye-fault-tolerance.adoc
986986
summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
987-
categories: "observability, web"
987+
categories: "web, observability"
988988
type: guide
989989
url: /guides/smallrye-fault-tolerance
990990
- title: SmallRye GraphQL
@@ -1014,14 +1014,14 @@ types:
10141014
- title: Testing Your Application
10151015
filename: getting-started-testing.adoc
10161016
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
1017-
categories: "native, core, tooling"
1017+
categories: "core, native, tooling"
10181018
id: testing
10191019
type: guide
10201020
url: /guides/getting-started-testing
10211021
- title: Tips for writing native applications
10221022
filename: writing-native-applications-tips.adoc
10231023
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
1024-
categories: "native, core, writing-extensions"
1024+
categories: "writing-extensions, core, native"
10251025
type: guide
10261026
url: /guides/writing-native-applications-tips
10271027
- title: Update projects to the latest version of Quarkus
@@ -1157,7 +1157,7 @@ types:
11571157
- title: Using SSL With Native Executables
11581158
filename: native-and-ssl.adoc
11591159
summary: "In this guide, we will discuss how you can get your native images to support SSL, as native images don't support it out of the box."
1160-
categories: "security, native, core"
1160+
categories: "core, native, security"
11611161
type: guide
11621162
url: /guides/native-and-ssl
11631163
- title: Using Security with .properties File
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[{"configDocKey":{"type":"string","key":".type","configDoc":"Description of each type can be found link:https://github.com/microsoft/azure-maven-plugins/wiki/Authentication[here] Valid values are \n - *azure_cli* Delegates to Azure CLI for login \n - *managed_identity* Requires client to be set \n - *oauth2* Requires tenant to be set \n - *device_code* Requires tenant to be set \n - *file* Filesystem path to a property file that defines authentication. Properties supported are \n - *type* Supports same type values as well as _service_principal_ \n - *client* \n - *tenant* \n - *key* Password for _service_principal_ if using password authentication \n - *certificate* Path to PEM file if using _service_principal_ \n - *certificate-password* Password for PEM file if it is password protected and if using _service_principal_ \n - *environment* if using _service_principal_ Defaults to \"azure_cli\" for authentication","withinAMap":false,"defaultValue":"azure_cli","javaDocSiteLink":"","docMapKey":"type","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".path","configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".client","configDoc":"Client or App Id required if using _managed_identity_ type","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"client","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tenant","configDoc":"Tenant Id required if using _oauth2_ or _device_code_ type","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tenant","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[{"configDocKey":{"type":"string","key":".os","configDoc":"Valid values are linux, windows, and docker","withinAMap":false,"defaultValue":"linux","javaDocSiteLink":"","docMapKey":"os","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".java-version","configDoc":"Valid values are 8, 11, and 17","withinAMap":false,"defaultValue":"11","javaDocSiteLink":"","docMapKey":"java-version","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".image","configDoc":"URL of docker image if deploying via docker","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".registry-url","configDoc":"If using docker, url of registry","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"registry-url","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]

_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.TokenStateManager.Strategy","key":".strategy","configDoc":"Default TokenStateManager strategy.","withinAMap":false,"defaultValue":"keep-all-tokens","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":["tooltip:keep-all-tokens[Keep ID, access and refresh tokens.]","tooltip:id-token[Keep ID token only]","tooltip:id-refresh-tokens[Keep ID and refresh tokens only]"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"boolean","key":".split-tokens","configDoc":"Default TokenStateManager keeps all tokens (ID, access and refresh) returned in the authorization code grant response in a single session cookie by default. Enable this property to minimize a session cookie size","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"split-tokens","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".encryption-required","configDoc":"Requires that the tokens are encrypted before being stored in the cookies.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"encryption-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".encryption-secret","configDoc":"Secret which will be used to encrypt the tokens. This secret must be set if the token encryption is required but no client secret is set. The length of the secret which will be used to encrypt the tokens must be 32 characters long.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"encryption-secret","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
1+
[{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.TokenStateManager.Strategy","key":".strategy","configDoc":"Default TokenStateManager strategy.","withinAMap":false,"defaultValue":"keep-all-tokens","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":["tooltip:keep-all-tokens[Keep ID, access and refresh tokens.]","tooltip:id-token[Keep ID token only]","tooltip:id-refresh-tokens[Keep ID and refresh tokens only]"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"boolean","key":".split-tokens","configDoc":"Default TokenStateManager keeps all tokens (ID, access and refresh) returned in the authorization code grant response in a single session cookie by default. Enable this property to minimize a session cookie size","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"split-tokens","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".encryption-required","configDoc":"Mandates that the session cookie that stores the tokens is encrypted.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"encryption-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".encryption-secret","configDoc":"Secret which will be used to encrypt the session cookie storing the tokens when `encryption-required` property is enabled. \nIf this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` will be checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication will be checked. The secret will be auto-generated if it remains uninitialized after checking all of these properties. \nThe length of the secret which will be used to encrypt the tokens should be at least 32 characters long. Warning will be logged if the secret length is less than 16 characters.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"encryption-secret","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]

0 commit comments

Comments
 (0)