Skip to content

Commit dfc830d

Browse files
committed
doc changes
Signed-off-by: wind57 <[email protected]>
1 parent 87c460a commit dfc830d

File tree

4 files changed

+4
-47
lines changed

4 files changed

+4
-47
lines changed

docs/modules/ROOT/pages/property-source-config/configmap-propertysource.adoc

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -549,29 +549,6 @@ for individual ones; the latter having a higher priority.
549549
NOTE: You should check the security configuration section. To access config maps from inside a pod you need to have the correct
550550
Kubernetes service accounts, roles and role bindings.
551551

552-
Another option for using `ConfigMap` instances is to mount them into the Pod by running the Spring Cloud Kubernetes application
553-
and having Spring Cloud Kubernetes read them from the file system.
554-
555-
NOTE: This feature is deprecated and will be removed in a future release (Use `spring.config.import` instead).
556-
This behavior is controlled by the `spring.cloud.kubernetes.config.paths` property. You can use it in
557-
addition to or instead of the mechanism described earlier.
558-
`spring.cloud.kubernetes.config.paths` expects a List of full paths to each property file, because directories are not being recursively parsed. For example:
559-
560-
[source,yaml]
561-
----
562-
spring:
563-
cloud:
564-
kubernetes:
565-
config:
566-
paths:
567-
- /tmp/application.properties
568-
- /var/application.yaml
569-
----
570-
571-
NOTE: If you use `spring.cloud.kubernetes.config.paths` or `spring.cloud.kubernetes.secrets.path` the automatic reload
572-
functionality will not work. You will need to make a `POST` request to the `/actuator/refresh` endpoint or
573-
restart/redeploy the application.
574-
575552
[#config-map-fail-fast]
576553
In some cases, your application may be unable to load some of your `ConfigMaps` using the Kubernetes API.
577554
If you want your application to fail the start-up process in such cases, you can set
@@ -598,7 +575,6 @@ NOTE: Since version `5.0.0-M3`, we have introduced the possibility to read sourc
598575
| `spring.cloud.kubernetes.config.enabled` | `Boolean` | `true` | Enable ConfigMaps `PropertySource`
599576
| `spring.cloud.kubernetes.config.name` | `String` | `${spring.application.name}` | Sets the name of `ConfigMap` to look up
600577
| `spring.cloud.kubernetes.config.namespace` | `String` | Client namespace | Sets the Kubernetes namespace where to lookup
601-
| `spring.cloud.kubernetes.config.paths` | `List` | `null` | Sets the paths where `ConfigMap` instances are mounted
602578
| `spring.cloud.kubernetes.config.enableApi` | `Boolean` | `true` | Enable or disable consuming `ConfigMap` instances through APIs
603579
| `spring.cloud.kubernetes.config.fail-fast` | `Boolean` | `false` | Enable or disable failing the application start-up when an error occurred while loading a `ConfigMap`
604580
| `spring.cloud.kubernetes.config.retry.enabled` | `Boolean` | `true` | Enable or disable config retry.

docs/modules/ROOT/pages/property-source-config/secrets-propertysource.adoc

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -77,20 +77,6 @@ spec:
7777

7878
You can select the Secrets to consume in a number of ways:
7979

80-
. By listing the directories where secrets are mapped:
81-
+
82-
[source,bash]
83-
----
84-
-Dspring.cloud.kubernetes.secrets.paths=/etc/secrets/db-secret,etc/secrets/postgresql
85-
----
86-
+
87-
If you have all the secrets mapped to a common root, you can set them like:
88-
+
89-
[source,bash]
90-
----
91-
-Dspring.cloud.kubernetes.secrets.paths=/etc/secrets
92-
----
93-
9480
. By setting a named secret:
9581
+
9682
[source,bash]
@@ -165,7 +151,6 @@ This setting is supported since `3.0.6` and upwards.
165151
| `spring.cloud.kubernetes.secrets.name` | `String` | `${spring.application.name}` | Sets the name of the secret to look up
166152
| `spring.cloud.kubernetes.secrets.namespace` | `String` | Client namespace | Sets the Kubernetes namespace where to look up
167153
| `spring.cloud.kubernetes.secrets.labels` | `Map` | `null` | Sets the labels used to lookup secrets
168-
| `spring.cloud.kubernetes.secrets.paths` | `List` | `null` | Sets the paths where secrets are mounted (example 1)
169154
| `spring.cloud.kubernetes.secrets.enableApi` | `Boolean` | `false` | Enables or disables consuming secrets through APIs (examples 2 and 3)
170155
| `spring.cloud.kubernetes.secrets.fail-fast` | `Boolean` | `false` | Enable or disable failing the application start-up when an error occurred while loading a `Secret`
171156
| `spring.cloud.kubernetes.secrets.retry.enabled` | `Boolean` | `true` | Enable or disable secrets retry.
@@ -179,8 +164,6 @@ Notes:
179164

180165
* The `spring.cloud.kubernetes.secrets.labels` property behaves as defined by
181166
https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-Configuration-Binding#map-based-binding[Map-based binding].
182-
* The `spring.cloud.kubernetes.secrets.paths` property behaves as defined by
183-
https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-Configuration-Binding#collection-based-binding[Collection-based binding].
184167
* Access to secrets through the API may be restricted for security reasons. The preferred way is to mount secrets to the Pod.
185168

186169
You can find an example of an application that uses secrets (though it has not been updated to use the new `spring-cloud-kubernetes` project) at

docs/modules/ROOT/pages/spring-cloud-kubernetes-configuration-watcher.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ SPRING_CLOUD_KUBERNETES_CONFIG_INFORMER_ENABLED=TRUE
5454

5555
This will tell watcher to only monitor sources that have a label: `spring.cloud.kubernetes.config.informer.enabled=true`.
5656

57-
One more important configuration, especially for configmaps and secrets that are mounted as volumes (via `spring.cloud.kubernetes.config.paths`/`spring.cloud.kubernetes.secrets.paths` or using `spring.config.import`) is:
57+
One more important configuration, especially for configmaps and secrets that are mounted as volumes (via `spring.config.import`) is:
5858

5959
[source]
6060
----

docs/modules/ROOT/partials/_configprops.adoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,7 @@
5353
|spring.cloud.kubernetes.config.labels | |
5454
|spring.cloud.kubernetes.config.name | |
5555
|spring.cloud.kubernetes.config.namespace | |
56-
|spring.cloud.kubernetes.config.paths | |
57-
|spring.cloud.kubernetes.config.retry | |
56+
|spring.cloud.kubernetes.config.retry | |
5857
|spring.cloud.kubernetes.config.sources | |
5958
|spring.cloud.kubernetes.config.use-name-as-prefix | `+++false+++` |
6059
|spring.cloud.kubernetes.discovery.all-namespaces | `+++false+++` | if discovery is enabled for all namespaces
@@ -108,9 +107,8 @@
108107
|spring.cloud.kubernetes.secrets.labels | |
109108
|spring.cloud.kubernetes.secrets.name | |
110109
|spring.cloud.kubernetes.secrets.namespace | |
111-
|spring.cloud.kubernetes.secrets.paths | |
112-
|spring.cloud.kubernetes.secrets.retry | |
110+
|spring.cloud.kubernetes.secrets.retry | |
113111
|spring.cloud.kubernetes.secrets.sources | |
114112
|spring.cloud.kubernetes.secrets.use-name-as-prefix | `+++false+++` |
115113

116-
|===
114+
|===

0 commit comments

Comments
 (0)