Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Sep 14, 2023
1 parent 0b64915 commit f2e75d3
Show file tree
Hide file tree
Showing 26 changed files with 2,480 additions and 1,116 deletions.
42 changes: 21 additions & 21 deletions _data/versioned/main/index/quarkus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ types:
- title: Authorization of web endpoints
filename: security-authorize-web-endpoints-reference.adoc
summary: Quarkus has an integrated pluggable web security layer.
categories: "security, web"
categories: "web, security"
id: security-authorize-web-endpoints-reference
type: reference
url: /guides/security-authorize-web-endpoints-reference
Expand All @@ -18,7 +18,7 @@ types:
- title: Command Mode Applications
filename: command-mode-reference.adoc
summary: This reference guide explains how to develop command line applications with Quarkus.
categories: "command-line, core"
categories: "core, command-line"
type: reference
url: /guides/command-mode-reference
- title: Configuration Reference Guide
Expand All @@ -30,7 +30,7 @@ types:
- title: Configure data sources in Quarkus
filename: datasource.adoc
summary: Use a unified configuration model to define datasources for Java Database Connectivity (JDBC) and Reactive drivers.
categories: "data, getting-started"
categories: "getting-started, data"
id: datasources
type: reference
url: /guides/datasource
Expand Down Expand Up @@ -159,21 +159,21 @@ types:
- title: Authentication mechanisms in Quarkus
filename: security-authentication-mechanisms.adoc
summary: "The Quarkus Security framework supports multiple authentication mechanisms, which you can use to secure your applications."
categories: "security, web"
categories: "web, security"
id: security-authentication-mechanisms
type: concepts
url: /guides/security-authentication-mechanisms
- title: Basic authentication
filename: security-basic-authentication.adoc
summary: HTTP Basic authentication is one of the least resource-demanding techniques that enforce access controls to web resources.
categories: "security, web"
categories: "web, security"
id: security-basic-authentication
type: concepts
url: /guides/security-basic-authentication
- title: Configuring Well-Known OpenID Connect Providers
filename: security-openid-connect-providers.adoc
summary: This document explains how to configure well-known social OIDC and OAuth2 providers.
categories: "security, web"
categories: "web, security"
id: security-openid-connect-providers
type: concepts
url: /guides/security-openid-connect-providers
Expand All @@ -194,21 +194,21 @@ types:
- title: OpenID Connect (OIDC) Bearer token authentication
filename: security-oidc-bearer-token-authentication.adoc
summary: Secure HTTP access to Jakarta REST (formerly known as JAX-RS) endpoints in your application with Bearer token authentication by using the Quarkus OpenID Connect (OIDC) extension.
categories: "security, web"
categories: "web, security"
id: security-oidc-bearer-token-authentication
type: concepts
url: /guides/security-oidc-bearer-token-authentication
- title: OpenID Connect authorization code flow mechanism for protecting web applications
filename: security-oidc-code-flow-authentication.adoc
summary: "To protect your web applications, you can use the industry-standard OpenID Connect (OIDC) Authorization Code Flow mechanism provided by the Quarkus OIDC extension."
categories: "security, web"
categories: "web, security"
id: security-oidc-code-flow-authentication
type: concepts
url: /guides/security-oidc-code-flow-authentication
- title: Proactive authentication
filename: security-proactive-authentication.adoc
summary: Proactive authentication is enabled in Quarkus by default.
categories: "security, web"
categories: "web, security"
id: security-proactive-authentication
type: concepts
url: /guides/security-proactive-authentication
Expand Down Expand Up @@ -236,7 +236,7 @@ types:
- title: Security vulnerability detection and reporting in Quarkus
filename: security-vulnerability-detection.adoc
summary: Most of the Quarkus tags are registered in the US National Vulnerability Database (NVD) in Common Platform Enumeration (CPE) name format.
categories: "security, contributing"
categories: "contributing, security"
id: security-vulnerability-detection
type: concepts
url: /guides/security-vulnerability-detection
Expand Down Expand Up @@ -273,7 +273,7 @@ types:
- title: Building a Native Executable
filename: building-native-image.adoc
summary: Build native executables with GraalVM or Mandrel.
categories: "native, getting-started"
categories: "getting-started, native"
type: tutorial
url: /guides/building-native-image
- title: Collect metrics using Micrometer
Expand Down Expand Up @@ -312,7 +312,7 @@ types:
- title: Protect a web application by using OpenID Connect (OIDC) authorization code flow
filename: security-oidc-code-flow-authentication-tutorial.adoc
summary: "With the Quarkus OpenID Connect (OIDC) extension, you can protect application HTTP endpoints by using the OIDC Authorization Code Flow mechanism."
categories: "security, web"
categories: "web, security"
id: security-oidc-code-flow-authentication-tutorial
type: tutorial
url: /guides/security-oidc-code-flow-authentication-tutorial
Expand All @@ -325,7 +325,7 @@ types:
- title: Secure a Quarkus application with Basic authentication and Jakarta Persistence
filename: security-basic-authentication-tutorial.adoc
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).
categories: "security, getting-started"
categories: "getting-started, security"
id: security-basic-authentication-tutorial
type: tutorial
url: /guides/security-basic-authentication-tutorial
Expand All @@ -338,7 +338,7 @@ types:
- title: Your second Quarkus application
filename: getting-started-dev-services.adoc
summary: This tutorial shows you how to create an application which writes to and reads from a database.
categories: "data, getting-started, core"
categories: "getting-started, core, data"
id: getting-started-dev-services-tutorial
type: tutorial
url: /guides/getting-started-dev-services
Expand Down Expand Up @@ -394,7 +394,7 @@ types:
- title: AppCDS
filename: appcds.adoc
summary: This reference guide explains how to enable AppCDS with Quarkus.
categories: "cloud, core"
categories: "core, cloud"
type: guide
url: /guides/appcds
- title: Application Data Caching
Expand Down Expand Up @@ -583,7 +583,7 @@ types:
- title: Dev Services for Databases
filename: databases-dev-services.adoc
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."
categories: "data, tooling"
categories: "tooling, data"
type: guide
url: /guides/databases-dev-services
- title: Dev Services for Elasticsearch
Expand Down Expand Up @@ -952,14 +952,14 @@ types:
- title: Quarkus and Gradle
filename: gradle-tooling.adoc
summary: Develop and build your Quarkus application with Gradle
categories: "native, tooling"
categories: "tooling, native"
id: gradle-tooling
type: guide
url: /guides/gradle-tooling
- title: Quarkus and Maven
filename: maven-tooling.adoc
summary: Develop and build your Quarkus application with Maven
categories: "native, tooling"
categories: "tooling, native"
id: maven-tooling
type: guide
url: /guides/maven-tooling
Expand Down Expand Up @@ -1087,14 +1087,14 @@ types:
- title: Testing Your Application
filename: getting-started-testing.adoc
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
categories: "native, tooling, core"
categories: "tooling, core, native"
id: testing
type: guide
url: /guides/getting-started-testing
- title: Tips for writing native applications
filename: writing-native-applications-tips.adoc
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
categories: "writing-extensions, native, core"
categories: "core, writing-extensions, native"
type: guide
url: /guides/writing-native-applications-tips
- title: Using Apache Kafka Streams
Expand Down Expand Up @@ -1223,7 +1223,7 @@ types:
- title: Using SSL With Native Executables
filename: native-and-ssl.adoc
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."
categories: "security, native, core"
categories: "core, security, native"
type: guide
url: /guides/native-and-ssl
- title: Using Security with .properties File
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"If true, the init task will be generated. Otherwise, the init task resource generation will be skipped.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".image","additionalKeys":[],"configDoc":"The init task image to use by the init-container.","withinAMap":false,"defaultValue":"groundnuty/k8s-wait-for:no-root-v1.7","javaDocSiteLink":"","docMapKey":"image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"If true, the init task will be generated. Otherwise, the init task resource generation will be skipped.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".wait-for-image","additionalKeys":[],"configDoc":"The init task image to use by the init-container.","withinAMap":false,"defaultValue":"groundnuty/k8s-wait-for:no-root-v1.7","javaDocSiteLink":"","docMapKey":"wait-for-image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]

Large diffs are not rendered by default.

Large diffs are not rendered by default.

80 changes: 74 additions & 6 deletions _generated-doc/main/config/quarkus-all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28143,6 +28143,40 @@ endif::add-copy-button-to-env-var[]
|`5005`


a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.kubernetes.init-task-defaults.enabled]]`link:#quarkus-kubernetes_quarkus.kubernetes.init-task-defaults.enabled[quarkus.kubernetes.init-task-defaults.enabled]`


[.description]
--
If true, the init task will be generated. Otherwise, the init task resource generation will be skipped.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_ENABLED+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_ENABLED+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`true`


a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.kubernetes.init-task-defaults.wait-for-image]]`link:#quarkus-kubernetes_quarkus.kubernetes.init-task-defaults.wait-for-image[quarkus.kubernetes.init-task-defaults.wait-for-image]`


[.description]
--
The init task image to use by the init-container.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_WAIT_FOR_IMAGE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_WAIT_FOR_IMAGE+++`
endif::add-copy-button-to-env-var[]
--|string
|`groundnuty/k8s-wait-for:no-root-v1.7`


a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.kubernetes.idempotent]]`link:#quarkus-kubernetes_quarkus.kubernetes.idempotent[quarkus.kubernetes.idempotent]`


Expand Down Expand Up @@ -31573,18 +31607,18 @@ endif::add-copy-button-to-env-var[]
|`true`


a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.kubernetes.init-tasks.-init-tasks-.image]]`link:#quarkus-kubernetes_quarkus.kubernetes.init-tasks.-init-tasks-.image[quarkus.kubernetes.init-tasks."init-tasks".image]`
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.kubernetes.init-tasks.-init-tasks-.wait-for-image]]`link:#quarkus-kubernetes_quarkus.kubernetes.init-tasks.-init-tasks-.wait-for-image[quarkus.kubernetes.init-tasks."init-tasks".wait-for-image]`


[.description]
--
The init task image to use by the init-container.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__IMAGE+++[]
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__WAIT_FOR_IMAGE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__IMAGE+++`
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__WAIT_FOR_IMAGE+++`
endif::add-copy-button-to-env-var[]
--|string
|`groundnuty/k8s-wait-for:no-root-v1.7`
Expand Down Expand Up @@ -33816,6 +33850,40 @@ endif::add-copy-button-to-env-var[]
|`create-or-update`


a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.openshift.init-task-defaults.enabled]]`link:#quarkus-kubernetes_quarkus.openshift.init-task-defaults.enabled[quarkus.openshift.init-task-defaults.enabled]`


[.description]
--
If true, the init task will be generated. Otherwise, the init task resource generation will be skipped.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_ENABLED+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_ENABLED+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`true`


a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.openshift.init-task-defaults.wait-for-image]]`link:#quarkus-kubernetes_quarkus.openshift.init-task-defaults.wait-for-image[quarkus.openshift.init-task-defaults.wait-for-image]`


[.description]
--
The init task image to use by the init-container.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_IMAGE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_IMAGE+++`
endif::add-copy-button-to-env-var[]
--|string
|`groundnuty/k8s-wait-for:no-root-v1.7`


a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.openshift.idempotent]]`link:#quarkus-kubernetes_quarkus.openshift.idempotent[quarkus.openshift.idempotent]`


Expand Down Expand Up @@ -37144,18 +37212,18 @@ endif::add-copy-button-to-env-var[]
|`true`


a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.openshift.init-tasks.-init-tasks-.image]]`link:#quarkus-kubernetes_quarkus.openshift.init-tasks.-init-tasks-.image[quarkus.openshift.init-tasks."init-tasks".image]`
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.openshift.init-tasks.-init-tasks-.wait-for-image]]`link:#quarkus-kubernetes_quarkus.openshift.init-tasks.-init-tasks-.wait-for-image[quarkus.openshift.init-tasks."init-tasks".wait-for-image]`


[.description]
--
The init task image to use by the init-container.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__IMAGE+++[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_IMAGE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__IMAGE+++`
Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_IMAGE+++`
endif::add-copy-button-to-env-var[]
--|string
|`groundnuty/k8s-wait-for:no-root-v1.7`
Expand Down
Loading

0 comments on commit f2e75d3

Please sign in to comment.