From eeccf1e2fe82fb7e17c003f3267cba2a458a0bce Mon Sep 17 00:00:00 2001 From: Ryan Baxter Date: Tue, 17 Sep 2019 16:08:17 -0400 Subject: [PATCH] Adding auto generated configuration properties documentation. Fixes #600 --- docs/pom.xml | 19 +++++++++ docs/src/main/asciidoc/_attributes.adoc | 16 ++++++++ docs/src/main/asciidoc/_configprops.adoc | 39 +++++++++++++++++++ docs/src/main/asciidoc/appendix.adoc | 14 +++++++ .../main/asciidoc/spring-cloud-commons.adoc | 13 +++---- 5 files changed, 94 insertions(+), 7 deletions(-) create mode 100644 docs/src/main/asciidoc/_attributes.adoc create mode 100644 docs/src/main/asciidoc/_configprops.adoc create mode 100644 docs/src/main/asciidoc/appendix.adoc diff --git a/docs/pom.xml b/docs/pom.xml index 9261af4f..46b9acaf 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -17,7 +17,18 @@ spring-cloud-commons ${basedir}/.. 1.2.x,1.3.x,2.0.x,2.1.x + spring.cloud.* + + + ${project.groupId} + spring-cloud-starter + + + ${project.groupId} + spring-cloud-starter-loadbalancer + + @@ -34,6 +45,14 @@ docs + + pl.project13.maven + git-commit-id-plugin + + + org.codehaus.mojo + exec-maven-plugin + org.apache.maven.plugins maven-dependency-plugin diff --git a/docs/src/main/asciidoc/_attributes.adoc b/docs/src/main/asciidoc/_attributes.adoc new file mode 100644 index 00000000..a65926b4 --- /dev/null +++ b/docs/src/main/asciidoc/_attributes.adoc @@ -0,0 +1,16 @@ +:doctype: book +:idprefix: +:idseparator: - +:toc: left +:toclevels: 4 +:tabsize: 4 +:numbered: +:sectanchors: +:sectnums: +:icons: font +:hide-uri-scheme: +:docinfo: shared,private + +:sc-ext: java +:project-full-name: Spring Cloud Commons +:all: {asterisk}{asterisk} \ No newline at end of file diff --git a/docs/src/main/asciidoc/_configprops.adoc b/docs/src/main/asciidoc/_configprops.adoc new file mode 100644 index 00000000..f120c9eb --- /dev/null +++ b/docs/src/main/asciidoc/_configprops.adoc @@ -0,0 +1,39 @@ +|=== +|Name | Default | Description + +|spring.cloud.compatibility-verifier.compatible-boot-versions | 2.1.x | Default accepted versions for the Spring Boot dependency. You can set {@code x} for the patch version if you don't want to specify a concrete value. Example: {@code 3.4.x} +|spring.cloud.compatibility-verifier.enabled | false | Enables creation of Spring Cloud compatibility verification. +|spring.cloud.config.allow-override | true | Flag to indicate that {@link #isOverrideSystemProperties() systemPropertiesOverride} can be used. Set to false to prevent users from changing the default accidentally. Default true. +|spring.cloud.config.override-none | false | Flag to indicate that when {@link #setAllowOverride(boolean) allowOverride} is true, external properties should take lowest priority and should not override any existing property sources (including local config files). Default false. +|spring.cloud.config.override-system-properties | true | Flag to indicate that the external properties should override system properties. Default true. +|spring.cloud.discovery.client.composite-indicator.enabled | true | Enables discovery client composite health indicator. +|spring.cloud.discovery.client.health-indicator.enabled | true | +|spring.cloud.discovery.client.health-indicator.include-description | false | +|spring.cloud.discovery.client.simple.instances | | +|spring.cloud.discovery.client.simple.local.instance-id | | The unique identifier or name for the service instance. +|spring.cloud.discovery.client.simple.local.metadata | | Metadata for the service instance. Can be used by discovery clients to modify their behaviour per instance, e.g. when load balancing. +|spring.cloud.discovery.client.simple.local.service-id | | The identifier or name for the service. Multiple instances might share the same service ID. +|spring.cloud.discovery.client.simple.local.uri | | The URI of the service instance. Will be parsed to extract the scheme, host, and port. +|spring.cloud.discovery.client.simple.order | | +|spring.cloud.discovery.enabled | true | Enables discovery client health indicators. +|spring.cloud.features.enabled | true | Enables the features endpoint. +|spring.cloud.httpclientfactories.apache.enabled | true | Enables creation of Apache Http Client factory beans. +|spring.cloud.httpclientfactories.ok.enabled | true | Enables creation of OK Http Client factory beans. +|spring.cloud.hypermedia.refresh.fixed-delay | 5000 | +|spring.cloud.hypermedia.refresh.initial-delay | 10000 | +|spring.cloud.inetutils.default-hostname | localhost | The default hostname. Used in case of errors. +|spring.cloud.inetutils.default-ip-address | 127.0.0.1 | The default IP address. Used in case of errors. +|spring.cloud.inetutils.ignored-interfaces | | List of Java regular expressions for network interfaces that will be ignored. +|spring.cloud.inetutils.preferred-networks | | List of Java regular expressions for network addresses that will be preferred. +|spring.cloud.inetutils.timeout-seconds | 1 | Timeout, in seconds, for calculating hostname. +|spring.cloud.inetutils.use-only-site-local-interfaces | false | Whether to use only interfaces with site local addresses. See {@link InetAddress#isSiteLocalAddress()} for more details. +|spring.cloud.loadbalancer.retry.enabled | true | +|spring.cloud.loadbalancer.ribbon.enabled | true | Causes `RibbonLoadBalancerClient` to be used by default. +|spring.cloud.refresh.enabled | true | Enables autoconfiguration for the refresh scope and associated features. +|spring.cloud.refresh.extra-refreshable | true | Additional class names for beans to post process into refresh scope. +|spring.cloud.service-registry.auto-registration.enabled | true | Whether service auto-registration is enabled. Defaults to true. +|spring.cloud.service-registry.auto-registration.fail-fast | false | Whether startup fails if there is no AutoServiceRegistration. Defaults to false. +|spring.cloud.service-registry.auto-registration.register-management | true | Whether to register the management as a service. Defaults to true. +|spring.cloud.util.enabled | true | Enables creation of Spring Cloud utility beans. + +|=== diff --git a/docs/src/main/asciidoc/appendix.adoc b/docs/src/main/asciidoc/appendix.adoc new file mode 100644 index 00000000..2c18b865 --- /dev/null +++ b/docs/src/main/asciidoc/appendix.adoc @@ -0,0 +1,14 @@ +:numbered!: +[appendix] +[[common-application-properties]] +== Common application properties + +include::_attributes.adoc[] + +Various properties can be specified inside your `application.properties` file, inside your `application.yml` file, or as command line switches. +This appendix provides a list of common {project-full-name} properties and references to the underlying classes that consume them. + +NOTE: Property contributions can come from additional jar files on your classpath, so you should not consider this an exhaustive list. +Also, you can define your own properties. + +include::_configprops.adoc[] \ No newline at end of file diff --git a/docs/src/main/asciidoc/spring-cloud-commons.adoc b/docs/src/main/asciidoc/spring-cloud-commons.adoc index 96ba462c..90b4b2d1 100644 --- a/docs/src/main/asciidoc/spring-cloud-commons.adoc +++ b/docs/src/main/asciidoc/spring-cloud-commons.adoc @@ -1,10 +1,5 @@ = Cloud Native Applications -:githubroot: https://github.com/spring-cloud -:github: {githubroot}/spring-cloud-commons -:githubmaster: {github}/tree/master -:docslink: {githubmaster}/docs/src/main/asciidoc -:toc: -:nofooter: +include::_attributes.adoc[] include::intro.adoc[] @@ -777,4 +772,8 @@ of compatible Spring Boot versions. == Spring Cloud Circuit Breaker -include::spring-cloud-circuitbreaker.adoc[] \ No newline at end of file +include::spring-cloud-circuitbreaker.adoc[] + +== Configuration Properties + +To see the list of all Sleuth related configuration properties please check link:appendix.html[the Appendix page]. \ No newline at end of file