From d27b59e6f6fa7ba9f2f074d9c4af605c9a91708c Mon Sep 17 00:00:00 2001 From: Olga Maciaszek-Sharma Date: Thu, 30 Apr 2020 15:34:15 +0200 Subject: [PATCH] Fix docs on Instance Health-Check for LoadBalancer. Fixes gh-746. --- docs/src/main/asciidoc/_configprops.adoc | 3 ++- docs/src/main/asciidoc/spring-cloud-commons.adoc | 13 ++----------- 2 files changed, 4 insertions(+), 12 deletions(-) diff --git a/docs/src/main/asciidoc/_configprops.adoc b/docs/src/main/asciidoc/_configprops.adoc index 9c3d46bb..0444200c 100644 --- a/docs/src/main/asciidoc/_configprops.adoc +++ b/docs/src/main/asciidoc/_configprops.adoc @@ -1,7 +1,7 @@ |=== |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.compatible-boot-versions | | 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. @@ -37,6 +37,7 @@ |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.refresh.never-refreshable | true | Comma separated list of class names for beans to never be refreshed or rebound. |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. diff --git a/docs/src/main/asciidoc/spring-cloud-commons.adoc b/docs/src/main/asciidoc/spring-cloud-commons.adoc index 5bc39105..2691e5fe 100644 --- a/docs/src/main/asciidoc/spring-cloud-commons.adoc +++ b/docs/src/main/asciidoc/spring-cloud-commons.adoc @@ -946,20 +946,11 @@ TIP: This mechanism is particularly helpful while using the `SimpleDiscoveryClie clients backed by an actual Service Registry, it's not necessary to use, as we already get healthy instances after querying the external ServiceDiscovery. -The `HealthCheckServiceInstanceListSupplier` uses `InstanceHealthChecker` to verify if the instances are -alive. We provide a default `PingHealthChecker` instance. It uses `WebClient` to execute -requests against the `health` endpoint of the instance. You can also provide your own implementation -of `InstanceHealthChecker` instead. - `HealthCheckServiceInstanceListSupplier` uses properties prefixed with `spring.cloud.loadbalancer.healthcheck`. You can set the `initialDelay` and `interval` -for the scheduler. - -For the `PingHealthChecker`, you can set the default path for the healthcheck URL by setting +for the scheduler. You can set the default path for the healthcheck URL by setting the value of the `spring.cloud.loadbalancer.healthcheck.path.default`. You can also set a specific value -for any given service by setting the value of the `spring.cloud.loadbalancer.healthcheck.path.[SERVICE_ID]`, -substituting the `[SERVICE_ID]` with the correct ID of your service. If the path is not set, -`/actuator/health` is used by default. +for any given service by setting the value of the `spring.cloud.loadbalancer.healthcheck.path.[SERVICE_ID]`, substituting the `[SERVICE_ID]` with the correct ID of your service. If the path is not set, `/actuator/health` is used by default. In order to use the health-check scheduler approach, you will have to instantiate a `HealthCheckServiceInstanceListSupplier` bean in a <>.