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 Oct 4, 2023
1 parent 63fd379 commit 286816d
Show file tree
Hide file tree
Showing 37 changed files with 1,016 additions and 104 deletions.
46 changes: 23 additions & 23 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: "web, security"
categories: "security, web"
id: security-authorize-web-endpoints-reference
type: reference
url: /guides/security-authorize-web-endpoints-reference
Expand Down Expand Up @@ -55,7 +55,7 @@ types:
- title: Logging configuration
filename: logging.adoc
summary: "Read about the use of logging API in Quarkus, configuring logging output, and using logging adapters to unify the output from other logging APIs."
categories: "getting-started, observability, core"
categories: "observability, core, getting-started"
id: logging
type: reference
url: /guides/logging
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: "web, security"
categories: "security, web"
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: "web, security"
categories: "security, web"
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: "web, security"
categories: "security, web"
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: "web, security"
categories: "security, web"
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: "web, security"
categories: "security, web"
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: "web, security"
categories: "security, web"
id: security-proactive-authentication
type: concepts
url: /guides/security-proactive-authentication
Expand Down Expand Up @@ -265,7 +265,7 @@ types:
- title: Use virtual threads in REST applications
filename: resteasy-reactive-virtual-threads.adoc
summary: How to use virtual threads in a REST application
categories: "web, core"
categories: "core, web"
id: resteasy-reactive-virtual-threads
type: howto
url: /guides/resteasy-reactive-virtual-threads
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: "web, security"
categories: "security, web"
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: "getting-started, security"
categories: "security, getting-started"
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: Discover some of the features that make developing with Quarkus a joyful experience.
categories: "getting-started, data, core"
categories: "core, getting-started, 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 @@ -528,7 +528,7 @@ types:
- title: Deploying on OpenShift
filename: deploying-to-openshift.adoc
summary: This guide covers how to deploy a native application on OpenShift.
categories: "native, cloud"
categories: "cloud, native"
id: deploy-openshift
type: guide
url: /guides/deploying-to-openshift
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 @@ -818,7 +818,7 @@ types:
- title: Kubernetes extension
filename: deploying-to-kubernetes.adoc
summary: This guide covers how to deploy a native application on Kubernetes.
categories: "native, cloud"
categories: "cloud, native"
id: deploy-kubernetes
type: guide
url: /guides/deploying-to-kubernetes
Expand Down Expand Up @@ -957,14 +957,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 @@ -1062,7 +1062,7 @@ types:
- title: SmallRye Fault Tolerance
filename: smallrye-fault-tolerance.adoc
summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
categories: "web, observability"
categories: "observability, web"
type: guide
url: /guides/smallrye-fault-tolerance
- title: SmallRye GraphQL
Expand Down Expand Up @@ -1092,14 +1092,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, core, tooling"
categories: "core, tooling, 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 @@ -1228,7 +1228,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: "native, core, security"
categories: "security, core, native"
type: guide
url: /guides/native-and-ssl
- title: Using Security with .properties File
Expand Down Expand Up @@ -1347,7 +1347,7 @@ types:
- title: Writing JSON REST Services
filename: rest-json.adoc
summary: JSON is now the lingua franca between microservices.
categories: "web, serialization"
categories: "serialization, web"
type: guide
url: /guides/rest-json
- title: Writing REST Services with RESTEasy Reactive
Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"configDocKey":{"type":"java.lang.Boolean","key":".enabled","additionalKeys":[],"configDoc":"If Dev Services for AMQP has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For AMQP, Dev Services starts a broker unless `amqp-host` or `amqp-port` are set or if all the Reactive Messaging AMQP channel are configured with `host` or `port`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".image-name","additionalKeys":[],"configDoc":"The image to use. Note that only ActiveMQ Artemis images are supported. Specifically, the image repository must end with `artemiscloud/activemq-artemis-broker`. Check the link:https://quay.io/repository/artemiscloud/activemq-artemis-broker[activemq-artemis-broker on Quay page] to find the available versions.","withinAMap":false,"defaultValue":"quay.io/artemiscloud/activemq-artemis-broker:1.0.18","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".extra-args","additionalKeys":[],"configDoc":"The value of the `AMQ_EXTRA_ARGS` environment variable to pass to the container.","withinAMap":false,"defaultValue":"--no-autotune --mapped --no-fsync --relax-jolokia --http-host 0.0.0.0","javaDocSiteLink":"","docMapKey":"extra-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".shared","additionalKeys":[],"configDoc":"Indicates if the AMQP broker managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for AMQP starts a new container.\n\nThe discovery uses the `quarkus-dev-service-amqp` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-aqmp` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for AMQP looks for a container with the `quarkus-dev-service-amqp` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-amqp` label set to the specified value.\n\nThis property is used when you need multiple shared AMQP brokers.","withinAMap":false,"defaultValue":"amqp","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":".container-env","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-env","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
[{"configDocKey":{"type":"java.lang.Boolean","key":".enabled","additionalKeys":[],"configDoc":"If Dev Services for AMQP has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For AMQP, Dev Services starts a broker unless `amqp-host` or `amqp-port` are set or if all the Reactive Messaging AMQP channel are configured with `host` or `port`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".image-name","additionalKeys":[],"configDoc":"The image to use. Note that only ActiveMQ Artemis images are supported. Specifically, the image repository must end with `artemiscloud/activemq-artemis-broker`.\n\nCheck the link:https://quay.io/repository/artemiscloud/activemq-artemis-broker[activemq-artemis-broker on Quay page] to find the available versions.","withinAMap":false,"defaultValue":"quay.io/artemiscloud/activemq-artemis-broker:1.0.22","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".extra-args","additionalKeys":[],"configDoc":"The value of the `AMQ_EXTRA_ARGS` environment variable to pass to the container. For ActiveMQ Artemis Broker <= 1.0.21, set this property to `--no-autotune --mapped --no-fsync --relax-jolokia --http-host 0.0.0.0`","withinAMap":false,"defaultValue":"--no-autotune --mapped --no-fsync --relax-jolokia","javaDocSiteLink":"","docMapKey":"extra-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".shared","additionalKeys":[],"configDoc":"Indicates if the AMQP broker managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for AMQP starts a new container.\n\nThe discovery uses the `quarkus-dev-service-amqp` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-aqmp` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for AMQP looks for a container with the `quarkus-dev-service-amqp` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-amqp` label set to the specified value.\n\nThis property is used when you need multiple shared AMQP brokers.","withinAMap":false,"defaultValue":"amqp","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":".container-env","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-env","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Loading

0 comments on commit 286816d

Please sign in to comment.