Skip to content

Commit be5aebf

Browse files
committed
Sync documentation of main branch
1 parent 6540a80 commit be5aebf

File tree

4 files changed

+52
-1
lines changed

4 files changed

+52
-1
lines changed
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"boolean","key":"quarkus.spring-cloud-config.enabled","additionalKeys":[],"configDoc":"If enabled, will try to read the configuration from a Spring Cloud Config Server","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.spring-cloud-config.fail-fast","additionalKeys":[],"configDoc":"If set to true, the application will not stand up if it cannot obtain configuration from the Config Server","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"fail-fast","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_FAIL_FAST","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.url","additionalKeys":[],"configDoc":"The Base URI where the Spring Cloud Config Server is available","withinAMap":false,"defaultValue":"http://localhost:8888","javaDocSiteLink":"","docMapKey":"url","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_URL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.label","additionalKeys":[],"configDoc":"The label to be used to pull remote configuration properties. The default is set on the Spring Cloud Config Server (generally \"master\" when the server uses a Git backend).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"label","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_LABEL","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.spring-cloud-config.connection-timeout","additionalKeys":[],"configDoc":"The amount of time to wait when initially establishing a connection before giving up and timing out.\n\nSpecify `0` to wait indefinitely.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_CONNECTION_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.spring-cloud-config.read-timeout","additionalKeys":[],"configDoc":"The amount of time to wait for a read on a socket before an exception is thrown.\n\nSpecify `0` to wait indefinitely.","withinAMap":false,"defaultValue":"60S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_READ_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.username","additionalKeys":[],"configDoc":"The username to be used if the Config Server has BASIC Auth enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.password","additionalKeys":[],"configDoc":"The password to be used if the Config Server has BASIC Auth enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_PASSWORD","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.spring-cloud-config.trust-store","additionalKeys":[],"configDoc":"TrustStore to be used containing the SSL certificate used by the Config server Can be either a classpath resource or a file system path","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.trust-store-password","additionalKeys":[],"configDoc":"Password of TrustStore to be used containing the SSL certificate used by the Config server","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.spring-cloud-config.key-store","additionalKeys":[],"configDoc":"KeyStore to be used containing the SSL certificate for authentication with the Config server Can be either a classpath resource or a file system path","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.key-store-password","additionalKeys":[],"configDoc":"Password of KeyStore to be used containing the SSL certificate for authentication with the Config server","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.key-password","additionalKeys":[],"configDoc":"Password to recover key from KeyStore for SSL client authentication with the Config server If no value is provided, the key-store-password will be used","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_KEY_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.spring-cloud-config.trust-certs","additionalKeys":[],"configDoc":"When using HTTPS and no keyStore has been specified, whether to trust all certificates","withinAMap":false,"defaultValue":"${quarkus.tls.trust-all:false}","javaDocSiteLink":"","docMapKey":"trust-certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_TRUST_CERTS","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.spring-cloud-config.headers.\"header-name\"","additionalKeys":[],"configDoc":"Custom headers to pass the Spring Cloud Config Server when performing the HTTP request","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_HEADERS__HEADER_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.profiles","additionalKeys":[],"configDoc":"The profiles to use for lookup","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"profiles","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_PROFILES","enum":false}}]
1+
[{"configDocKey":{"type":"boolean","key":"quarkus.spring-cloud-config.enabled","additionalKeys":[],"configDoc":"If enabled, will try to read the configuration from a Spring Cloud Config Server","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.spring-cloud-config.fail-fast","additionalKeys":[],"configDoc":"If set to true, the application will not stand up if it cannot obtain configuration from the Config Server","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"fail-fast","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_FAIL_FAST","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.url","additionalKeys":[],"configDoc":"The Base URI where the Spring Cloud Config Server is available","withinAMap":false,"defaultValue":"http://localhost:8888","javaDocSiteLink":"","docMapKey":"url","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_URL","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.name","additionalKeys":[],"configDoc":"Name of the application on Spring Cloud Config server. Could be a list of names to load multiple files (value separated by a comma)","withinAMap":false,"defaultValue":"${quarkus.application.name:}","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.label","additionalKeys":[],"configDoc":"The label to be used to pull remote configuration properties. The default is set on the Spring Cloud Config Server (generally \"master\" when the server uses a Git backend).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"label","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_LABEL","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.spring-cloud-config.connection-timeout","additionalKeys":[],"configDoc":"The amount of time to wait when initially establishing a connection before giving up and timing out.\n\nSpecify `0` to wait indefinitely.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_CONNECTION_TIMEOUT","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.spring-cloud-config.read-timeout","additionalKeys":[],"configDoc":"The amount of time to wait for a read on a socket before an exception is thrown.\n\nSpecify `0` to wait indefinitely.","withinAMap":false,"defaultValue":"60S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"read-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_READ_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.username","additionalKeys":[],"configDoc":"The username to be used if the Config Server has BASIC Auth enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.password","additionalKeys":[],"configDoc":"The password to be used if the Config Server has BASIC Auth enabled","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_PASSWORD","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.spring-cloud-config.trust-store","additionalKeys":[],"configDoc":"TrustStore to be used containing the SSL certificate used by the Config server Can be either a classpath resource or a file system path","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.trust-store-password","additionalKeys":[],"configDoc":"Password of TrustStore to be used containing the SSL certificate used by the Config server","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.spring-cloud-config.key-store","additionalKeys":[],"configDoc":"KeyStore to be used containing the SSL certificate for authentication with the Config server Can be either a classpath resource or a file system path","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.key-store-password","additionalKeys":[],"configDoc":"Password of KeyStore to be used containing the SSL certificate for authentication with the Config server","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE_PASSWORD","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.key-password","additionalKeys":[],"configDoc":"Password to recover key from KeyStore for SSL client authentication with the Config server If no value is provided, the key-store-password will be used","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_KEY_PASSWORD","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.spring-cloud-config.trust-certs","additionalKeys":[],"configDoc":"When using HTTPS and no keyStore has been specified, whether to trust all certificates","withinAMap":false,"defaultValue":"${quarkus.tls.trust-all:false}","javaDocSiteLink":"","docMapKey":"trust-certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_TRUST_CERTS","enum":false}},{"configDocKey":{"type":"java.lang.String","key":"quarkus.spring-cloud-config.headers.\"header-name\"","additionalKeys":[],"configDoc":"Custom headers to pass the Spring Cloud Config Server when performing the HTTP request","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html","docMapKey":"header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_HEADERS__HEADER_NAME_","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.spring-cloud-config.profiles","additionalKeys":[],"configDoc":"The profiles to use for lookup","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"profiles","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.spring-cloud-config","since":null,"environmentVariable":"QUARKUS_SPRING_CLOUD_CONFIG_PROFILES","enum":false}}]

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59179,6 +59179,23 @@ endif::add-copy-button-to-env-var[]
5917959179
|`http://localhost:8888`
5918059180

5918159181

59182+
a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-name]]`link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-name[quarkus.spring-cloud-config.name]`
59183+
59184+
59185+
[.description]
59186+
--
59187+
Name of the application on Spring Cloud Config server. Could be a list of names to load multiple files (value separated by a comma)
59188+
59189+
ifdef::add-copy-button-to-env-var[]
59190+
Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_NAME+++[]
59191+
endif::add-copy-button-to-env-var[]
59192+
ifndef::add-copy-button-to-env-var[]
59193+
Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_NAME+++`
59194+
endif::add-copy-button-to-env-var[]
59195+
--|string
59196+
|`${quarkus.application.name:}`
59197+
59198+
5918259199
a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-label]]`link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-label[quarkus.spring-cloud-config.label]`
5918359200

5918459201

0 commit comments

Comments
 (0)