Skip to content

Commit efd7882

Browse files
committed
doc
Signed-off-by: wind57 <[email protected]>
1 parent ac44f23 commit efd7882

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -588,6 +588,9 @@ NOTE: If you already have `spring-retry` and `spring-boot-starter-aspectj` on th
588588
and want to enable fail-fast, but do not want retry to be enabled; you can disable retry for `ConfigMap` `PropertySources`
589589
by setting `spring.cloud.kubernetes.config.retry.enabled=false`.
590590

591+
592+
NOTE: Since version `5.0.0-M3`, we have introduced the possibility to read sources individually. Until now, we would go to the namespace and read all the configmaps / secrets available and then filter out the ones requested. Since, `5.0.0-M3` you can specify that you want to read them individually, by setting the property: `spring.cloud.kubernetes.config.read-type=SINGLE`. The previous option to read them all in a namespace is controlled by `spring.cloud.kubernetes.config.read-type=BATCH` and it is the default option.
593+
591594
.Properties:
592595
[options="header,footer"]
593596
|===

docs/modules/ROOT/pages/spring-cloud-kubernetes-configserver.adoc

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,37 +11,39 @@ A default image is located on https://hub.docker.com/r/springcloud/spring-cloud-
1111
the code and image yourself. However, if you need to customize the config server behavior or prefer to build the image yourself you can easily build your own
1212
image from the https://github.com/spring-cloud/spring-cloud-kubernetes/tree/main/spring-cloud-kubernetes-controllers/spring-cloud-kubernetes-configserver[source code on GitHub] and use that.
1313

14-
## Configuration
14+
== Configuration
1515

16-
### Enabling The Kubernetes Environment Repository
16+
=== Enabling The Kubernetes Environment Repository
1717
To enable the Kubernetes environment repository the `kubernetes` profile must be included in the list of active profiles.
1818
You may activate other profiles as well to use other environment repository implementations.
1919

20-
### Config Map and Secret PropertySources
20+
=== Config Map and Secret PropertySources
2121
By default, only Config Map data will be fetched. To enable Secrets as well you will need to set `spring.cloud.kubernetes.secrets.enableApi=true`.
2222
You can disable the Config Map `PropertySource` by setting `spring.cloud.kubernetes.config.enableApi=false`.
2323

24-
### Fetching Config Map and Secret Data From Additional Namespaces
24+
=== Fetching Config Map and Secret Data From Additional Namespaces
2525
By default, the Kubernetes environment repository will only fetch Config Map and Secrets from the namespace in which it is deployed.
2626
If you want to include data from other namespaces you can set `spring.cloud.kubernetes.configserver.config-map-namespaces` and/or `spring.cloud.kubernetes.configserver.secrets-namespaces` to a comma separated
2727
list of namespace values.
2828

2929
NOTE: If you set `spring.cloud.kubernetes.configserver.config-map-namespaces` and/or `spring.cloud.kubernetes.configserver.secrets-namespaces`
3030
you will need to include the namespace in which the Config Server is deployed in order to continue to fetch Config Map and Secret data from that namespace.
3131

32-
### Using Advanced Features Of Spring Vault
32+
=== Using Advanced Features Of Spring Vault
3333
In order to use some of the https://docs.spring.io/spring-cloud-config/reference/server/environment-repository/vault-backend.html[more advanced Spring Vault features] of the **Spring Cloud Config Server**, https://mvnrepository.com/artifact/org.springframework.vault/spring-vault-core[`spring-vault-core`] must be on the classpath. By default, Spring Cloud Kubernetes can generate a Docker image for deploying Config Server to Kubernetes, but it does not include `spring-vault-core` in the classpath. If you need `spring-vault-core` to enable certain functionality in the Config Server you can build your own version of Docker image by enabling the `vault` Maven profile when running Maven build.
3434

3535
Example:
36-
```bash
36+
37+
[source,bash]
38+
----
3739
$ ../../mvnw clean install -Pvault
38-
```
40+
----
3941

40-
### Kubernetes Access Controls
42+
=== Kubernetes Access Controls
4143
The Kubernetes Config Server uses the Kubernetes API server to fetch Config Map and Secret data. In order for it to do that
4244
it needs ability to `get` and `list` Config Map and Secrets (depending on what you enable/disable).
4345

44-
## Deployment Yaml
46+
== Deployment Yaml
4547

4648
Below is a sample deployment, service and permissions configuration you can use to deploy a basic Config Server to Kubernetes.
4749

0 commit comments

Comments
 (0)