SpringCloud/spring-cloud-config
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add more docs for YAML and properties formats

Browse Source 
Fixes gh-348
This commit is contained in:
Dave Syer
2016-05-05 09:24:13 +01:00
parent 984cc5b885
commit 668f06196e
2 changed files with 30 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/src/main/asciidoc/quickstart.adoc
View File

@@ -39,10 +39,6 @@ Spring Boot app), "profile" is an active profile (or comma-separated
list of properties), and "label" is an optional git label (defaults to
"master".)
The YAML and properties forms are coalesced into a single
map, even if the origin of the values (reflected in the
"propertySources" of the "standard" form) has multiple sources.
Spring Cloud Config Server pulls configuration for remote clients
from a git repository (which must be provided):

30
docs/src/main/asciidoc/spring-cloud-config.adoc
View File

@@ -682,6 +682,36 @@ the decryption of outgoing properties using
about the endpoints, then it should work if you configure neither the
key nor the enabled flag.
== Serving Alternative Formats
The default JSON format from the environment endpoints is perfect for
consumption by Spring applications because it maps directly onto the
`Environment` abstraction. If you prefer you can consume the same data
as YAML or Java properties by adding a suffix to the resource path
(".yml", ".yaml" or ".properties"). This can be useful for consumption
by applications that do not care about the structure of the JSON
endpoints, or the extra metadata they provide, for example an
application that is not using Spring might benefit fro mthe simplicity
of this approach.
The YAML and properties representations have an additional flag
(provided as a boolean query parameter `resolvePlaceholders`) to
signal that placeholders in the source documents, in the standard
Spring `${...}` form, should be resolved in the output where possible
before rendering. This is a useful feature for consumers that don't
know about the Spring placeholder conventions.
NOTE: there are limitations in using the YAML or properties formats,
mainly in relation to the loss of metadata. The JSON is structured as
an ordered list of property sources, for example, with names that
correlate with the source. The YAML and properties forms are coalesced
into a single map, even if the origin of the values has multiple
sources, and the names of teh original source files are lost. The YAML
representation is not necessarily a faithful representation of the
YAML source in a backing repository either: it is constructed from a
list of flat property sources, and assumptions have to be made about
the form of the keys.
== Serving Plain Text
Instead of using the `Environment` abstraction (or one of the