diff --git a/docs/modules/ROOT/pages/discovery-client.adoc b/docs/modules/ROOT/pages/discovery-client.adoc index 7adbc5a9..f44d74a4 100644 --- a/docs/modules/ROOT/pages/discovery-client.adoc +++ b/docs/modules/ROOT/pages/discovery-client.adoc @@ -23,7 +23,7 @@ HTTP Based `DiscoveryClient` ==== NOTE: `spring-cloud-starter-kubernetes-discoveryclient` is designed to be used with the -<>. +xref:spring-cloud-kubernetes-discoveryserver.adoc#spring-cloud-kubernetes-discoveryserver[Spring Cloud Kubernetes DiscoveryServer]. ==== Fabric8 Kubernetes Client @@ -156,7 +156,7 @@ spring: - namespace-b ``` -- we will use: xref:property-source-config.adoc#namespace-resolution[Namespace Resolution] if the above two paths are not taken. +- we will use: xref:property-source-config/namespace-resolution.adoc[Namespace Resolution] if the above two paths are not taken. In order to enable this functionality you need to add `@EnableScheduling` on a configuration class in your application. diff --git a/docs/modules/ROOT/pages/getting-started.adoc b/docs/modules/ROOT/pages/getting-started.adoc index 2fe46f46..1abaad22 100644 --- a/docs/modules/ROOT/pages/getting-started.adoc +++ b/docs/modules/ROOT/pages/getting-started.adoc @@ -50,8 +50,8 @@ resolves service names to Kubernetes Services. ---- | Load application properties from Kubernetes -<> and <>. -<> application properties when a ConfigMap or +xref:property-source-config/configmap-propertysource.adoc[ConfigMaps] and <>. +xref:property-source-config/propertysource-reload.adoc[Reload] application properties when a ConfigMap or Secret changes. | [source,xml] diff --git a/docs/modules/ROOT/pages/property-source-config/configmap-propertysource.adoc b/docs/modules/ROOT/pages/property-source-config/configmap-propertysource.adoc index 8cb7a735..791cffc0 100644 --- a/docs/modules/ROOT/pages/property-source-config/configmap-propertysource.adoc +++ b/docs/modules/ROOT/pages/property-source-config/configmap-propertysource.adoc @@ -42,7 +42,7 @@ spring: In the preceding example, if `spring.cloud.kubernetes.config.namespace` had not been set, the `ConfigMap` named `c1` would be looked up in the namespace that the application runs. -See <> to get a better understanding of how the namespace +See xref:property-source-config/namespace-resolution.adoc[Namespace resolution] to get a better understanding of how the namespace of the application is resolved. diff --git a/docs/modules/ROOT/pages/property-source-config/namespace-label-filtering.adoc b/docs/modules/ROOT/pages/property-source-config/namespace-label-filtering.adoc index aa4cae3d..6593db55 100644 --- a/docs/modules/ROOT/pages/property-source-config/namespace-label-filtering.adoc +++ b/docs/modules/ROOT/pages/property-source-config/namespace-label-filtering.adoc @@ -1,7 +1,7 @@ [[namespace-label-filtering]] = Reload namespace and label filtering -By default, a namespace chosen using the steps outlined in <> will be used to listen to changes +By default, a namespace chosen using the steps outlined in xref:property-source-config/namespace-resolution.adoc[Namespace resolution] will be used to listen to changes in configmaps and secrets. i.e.: if you do not tell reload what namespaces and configmaps/secrets to watch for, it will watch all configmaps/secrets from the namespace that will be computed using the above algorithm. diff --git a/docs/modules/ROOT/pages/property-source-config/propertysource-reload.adoc b/docs/modules/ROOT/pages/property-source-config/propertysource-reload.adoc index 8a36b081..6e4fc85a 100644 --- a/docs/modules/ROOT/pages/property-source-config/propertysource-reload.adoc +++ b/docs/modules/ROOT/pages/property-source-config/propertysource-reload.adoc @@ -2,7 +2,7 @@ = `PropertySource` Reload WARNING: This functionality has been deprecated in the 2020.0 release. Please see -the <> controller for an alternative way +the xref:spring-cloud-kubernetes-configuration-watcher.adoc#spring-cloud-kubernetes-configuration-watcher[null] controller for an alternative way to achieve the same functionality. Some applications may need to detect changes on external property sources and update their internal status to reflect the new configuration. @@ -92,7 +92,7 @@ data: Any change to the property named `bean.message` in the `ConfigMap` associated with the pod is reflected in the output. More generally speaking, changes associated to properties prefixed with the value defined by the `prefix` field of the `@ConfigurationProperties` annotation are detected and reflected in the application. -<> is explained earlier in this chapter. +xref:property-source-config/configmap-propertysource.adoc[Associating a `ConfigMap` with a pod] is explained earlier in this chapter. The reload feature supports two operating modes: diff --git a/docs/modules/ROOT/pages/property-source-config/secrets-propertysource.adoc b/docs/modules/ROOT/pages/property-source-config/secrets-propertysource.adoc index 70642fd9..3c8606da 100644 --- a/docs/modules/ROOT/pages/property-source-config/secrets-propertysource.adoc +++ b/docs/modules/ROOT/pages/property-source-config/secrets-propertysource.adoc @@ -148,13 +148,13 @@ spring: In the preceding example, if `spring.cloud.kubernetes.secrets.namespace` had not been set, the `Secret` named `s1` would be looked up in the namespace that the application runs. -See <> to get a better understanding of how the namespace +See xref:property-source-config/namespace-resolution.adoc[namespace-resolution] to get a better understanding of how the namespace of the application is resolved. -<>; if you want your application to fail to start +xref:property-source-config/configmap-propertysource.adoc#config-map-fail-fast[Similar to the `ConfigMaps`]; if you want your application to fail to start when it is unable to load `Secrets` property sources, you can set `spring.cloud.kubernetes.secrets.fail-fast=true`. -It is also possible to enable retry for `Secret` property sources <>. +It is also possible to enable retry for `Secret` property sources xref:property-source-config/configmap-propertysource.adoc#config-map-retry[like the `ConfigMaps`]. As with the `ConfigMap` property sources, first you need to set `spring.cloud.kubernetes.secrets.fail-fast=true`. Then you need to add `spring-retry` and `spring-boot-starter-aop` to your classpath. Retry behavior of the `Secret` property sources can be configured by setting the `spring.cloud.kubernetes.secrets.retry.*`