Skip to content

Document spring.cloud.consul.config.prefixes #746 #1012

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
AzazelSensei wants to merge 1 commit into from
+6 −2
Closed

Document spring.cloud.consul.config.prefixes #746 #1012

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/modules/ROOT/pages/config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,19 @@ spring:
consul:
config:
enabled: true
prefix: configuration
prefixes:
- configuration
defaultContext: apps
profileSeparator: '::'
----

A comma-separated string also works: `spring.cloud.consul.config.prefixes=configuration,shared`.

CAUTION: If you have set `spring.cloud.bootstrap.enabled=true` or `spring.config.use-legacy-processing=true`, or included `spring-cloud-starter-bootstrap`, then the above values will need to be placed in `bootstrap.yml` instead of `application.yml`.

* `enabled` setting this value to "false" disables Consul Config
* `prefix` sets the base folder for configuration values
* `prefixes` sets one or more base folders for configuration values (YAML list or comma-separated string). The default is a single folder, `config`. Automatic contexts are generated for each prefix.
* `prefix` is a deprecated alias for a single prefix. It still works and maps to a one-element `prefixes` list. An empty `prefix` (`prefix:`) keeps keys under `name` / `defaultContext` with no extra folder. An empty `prefixes` list generates no automatic contexts.
* `defaultContext` sets the folder name used by all applications
* `profileSeparator` sets the value of the separator used to separate the profile name in property sources with profiles

Expand Down