Skip to content

Commit 9a63c41

Browse files
author
alfredo-toledano
committed
doc(docs.features.externalConfig): add notes
1 parent 63b0449 commit 9a63c41

File tree

1 file changed

+16
-14
lines changed
  • spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/features

1 file changed

+16
-14
lines changed

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/features/external-config.adoc

+16-14
Original file line numberDiff line numberDiff line change
@@ -530,26 +530,25 @@ WARNING: Multi-document property files cannot be loaded by using the `@PropertyS
530530
[[features.external-config.files.activation-properties]]
531531
=== Activation Properties
532532

533-
It is sometimes useful to only activate a given set of properties when certain conditions are met.
534-
For example, you might have properties that are only relevant when a specific profile is active.
535-
536-
You can conditionally activate a properties document using `spring.config.activate.*`.
537-
538-
The following activation properties are available:
533+
* activate properties -- based on -- certain conditions
534+
* use cases
535+
** properties / active | specific profile
536+
* `spring.config.activate.*`
537+
** built-in
539538

540539
.activation properties
541540
[cols="1,4"]
542541
|===
543542
| Property | Note
544543

545544
| `on-profile`
546-
| A profile expression that must match for the document to be active.
545+
| == profile expression -- to active the -- property
547546

548547
| `on-cloud-platform`
549-
| The `CloudPlatform` that must be detected for the document to be active.
548+
| == `CloudPlatform`
550549
|===
551550

552-
For example, the following specifies that the second document is only active when running on Kubernetes, and only when either the "`prod`" or "`staging`" profiles are active:
551+
* _Example:_ if running on Kubernetes & "`prod`" or "`staging`" profiles are active -> `myotherprop: "sometimes-set"`
553552

554553
[configprops%novalidate,yaml]
555554
----
@@ -569,11 +568,14 @@ myotherprop: "sometimes-set"
569568
[[features.external-config.encrypting]]
570569
== Encrypting Properties
571570

572-
Spring Boot does not provide any built-in support for encrypting property values, however, it does provide the hook points necessary to modify values contained in the Spring `Environment`.
573-
The `EnvironmentPostProcessor` interface allows you to manipulate the `Environment` before the application starts.
574-
See xref:how-to:application.adoc#howto.application.customize-the-environment-or-application-context[] for details.
575-
576-
If you need a secure way to store credentials and passwords, the https://cloud.spring.io/spring-cloud-vault/[Spring Cloud Vault] project provides support for storing externalized configuration in https://www.vaultproject.io/[HashiCorp Vault].
571+
* 👁️ NOT any built-in support -- for -- encrypting property values 👁️
572+
* hook points / -- necessary to -- modify values | Spring `Environment`
573+
** `EnvironmentPostProcessor` interface
574+
*** allows
575+
**** manipulating the `Environment` | before application starts
576+
*** check xref:how-to:application.adoc#howto.application.customize-the-environment-or-application-context[]
577+
* if you need a secure way to store credentials and passwords -> check https://cloud.spring.io/spring-cloud-vault/[Spring Cloud Vault]
578+
** store configuration | https://www.vaultproject.io/[HashiCorp Vault]
577579

578580

579581

0 commit comments

Comments
 (0)