From 7d2b32ce4e05172af78f3ad49b534a2ce1ab4836 Mon Sep 17 00:00:00 2001 From: buildmaster Date: Wed, 18 Dec 2019 21:45:57 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- reference/html/index.html | 168 ++++++++++++++++-------- reference/html/spring-cloud-config.html | 168 ++++++++++++++++-------- 2 files changed, 220 insertions(+), 116 deletions(-) diff --git a/reference/html/index.html b/reference/html/index.html index 652a2d90..2c283244 100644 --- a/reference/html/index.html +++ b/reference/html/index.html @@ -116,6 +116,8 @@ $(addBlockSwitches);
  • Serving Alternative Formats
  • Serving Plain Text
  • @@ -2279,63 +2281,7 @@ However, instead of aggregating all matching resources, only the first one to ma

    After a resource is located, placeholders in the normal format (${…​}) are resolved by using the effective Environment for the supplied application name, profile, and label. -In this way, the resource endpoint is tightly integrated with the environment endpoints. -Consider the following example for a GIT or SVN repository:

    -
    -
    -
    -
    application.yml
    -nginx.conf
    -
    -
    -
    -

    where nginx.conf looks like this:

    -
    -
    -
    -
    server {
    -    listen              80;
    -    server_name         ${nginx.server.name};
    -}
    -
    -
    -
    -

    and application.yml like this:

    -
    -
    -
    -
    nginx:
    -  server:
    -    name: example.com
    ----
    -spring:
    -  profiles: development
    -nginx:
    -  server:
    -    name: develop.com
    -
    -
    -
    -

    The /foo/default/master/nginx.conf resource might be as follows:

    -
    -
    -
    -
    server {
    -    listen              80;
    -    server_name         example.com;
    -}
    -
    -
    -
    -

    and /foo/development/master/nginx.conf like this:

    -
    -
    -
    -
    server {
    -    listen              80;
    -    server_name         develop.com;
    -}
    -
    +In this way, the resource endpoint is tightly integrated with the environment endpoints.

    @@ -2358,11 +2304,117 @@ So, if you want a profile-specific file, /*/development/*/logback.xml
    If you do not want to supply the label and let the server use the default label, you can supply a useDefaultLabel request parameter. -So, the preceding example for the default profile could be /foo/default/nginx.conf?useDefaultLabel. +Consequently, the preceding example for the default profile could be /sample/default/nginx.conf?useDefaultLabel.
    +
    +

    At present, Spring Cloud Config can serve plaintext for git, SVN, native backends, and AWS S3. +The support for git, SVN, and native backends is identical. AWS S3 works a bit differently. +The following sections show how each one works:

    +
    + +
    +

    Git, SVN, and Native Backends

    +
    +

    Consider the following example for a GIT or SVN repository or a native backend:

    +
    +
    +
    +
    +
    +
    application.yml
    +nginx.conf
    +
    +
    +
    +
    +
    +

    The nginx.conf might resemble the following listing:

    +
    +
    +
    +
    +
    +
    server {
    +    listen              80;
    +    server_name         ${nginx.server.name};
    +}
    +
    +
    +
    +
    +
    +

    application.yml might resemble the following listing:

    +
    +
    +
    +
    +
    +
    nginx:
    +  server:
    +    name: example.com
    +---
    +spring:
    +  profiles: development
    +nginx:
    +  server:
    +    name: develop.com
    +
    +
    +
    +
    +
    +

    The /sample/default/master/nginx.conf resource might be as follows:

    +
    +
    +
    +
    +
    +
    server {
    +    listen              80;
    +    server_name         example.com;
    +}
    +
    +
    +
    +
    +
    +

    /sample/development/master/nginx.conf might be as follows:

    +
    +
    +
    +
    +
    +
    server {
    +    listen              80;
    +    server_name         develop.com;
    +}
    +
    +
    +
    +
    +
    +
    +

    AWS S3

    +
    +

    To enable serving plain text for AWS s3, the Config Server application needs to include a dependency on Spring Cloud AWS. +For details on how to set up that dependency, see the +Spring Cloud AWS Reference Guide. +Then you need to configure Spring Cloud AWS, as described in the +Spring Cloud AWS Reference Guide.

    +
    +

    Decrypting Plain Text

    diff --git a/reference/html/spring-cloud-config.html b/reference/html/spring-cloud-config.html index 652a2d90..2c283244 100644 --- a/reference/html/spring-cloud-config.html +++ b/reference/html/spring-cloud-config.html @@ -116,6 +116,8 @@ $(addBlockSwitches);
  • Serving Alternative Formats
  • Serving Plain Text
  • @@ -2279,63 +2281,7 @@ However, instead of aggregating all matching resources, only the first one to ma

    After a resource is located, placeholders in the normal format (${…​}) are resolved by using the effective Environment for the supplied application name, profile, and label. -In this way, the resource endpoint is tightly integrated with the environment endpoints. -Consider the following example for a GIT or SVN repository:

    -
    -
    -
    -
    application.yml
    -nginx.conf
    -
    -
    -
    -

    where nginx.conf looks like this:

    -
    -
    -
    -
    server {
    -    listen              80;
    -    server_name         ${nginx.server.name};
    -}
    -
    -
    -
    -

    and application.yml like this:

    -
    -
    -
    -
    nginx:
    -  server:
    -    name: example.com
    ----
    -spring:
    -  profiles: development
    -nginx:
    -  server:
    -    name: develop.com
    -
    -
    -
    -

    The /foo/default/master/nginx.conf resource might be as follows:

    -
    -
    -
    -
    server {
    -    listen              80;
    -    server_name         example.com;
    -}
    -
    -
    -
    -

    and /foo/development/master/nginx.conf like this:

    -
    -
    -
    -
    server {
    -    listen              80;
    -    server_name         develop.com;
    -}
    -
    +In this way, the resource endpoint is tightly integrated with the environment endpoints.

    @@ -2358,11 +2304,117 @@ So, if you want a profile-specific file, /*/development/*/logback.xml
    If you do not want to supply the label and let the server use the default label, you can supply a useDefaultLabel request parameter. -So, the preceding example for the default profile could be /foo/default/nginx.conf?useDefaultLabel. +Consequently, the preceding example for the default profile could be /sample/default/nginx.conf?useDefaultLabel.
    +
    +

    At present, Spring Cloud Config can serve plaintext for git, SVN, native backends, and AWS S3. +The support for git, SVN, and native backends is identical. AWS S3 works a bit differently. +The following sections show how each one works:

    +
    + +
    +

    Git, SVN, and Native Backends

    +
    +

    Consider the following example for a GIT or SVN repository or a native backend:

    +
    +
    +
    +
    +
    +
    application.yml
    +nginx.conf
    +
    +
    +
    +
    +
    +

    The nginx.conf might resemble the following listing:

    +
    +
    +
    +
    +
    +
    server {
    +    listen              80;
    +    server_name         ${nginx.server.name};
    +}
    +
    +
    +
    +
    +
    +

    application.yml might resemble the following listing:

    +
    +
    +
    +
    +
    +
    nginx:
    +  server:
    +    name: example.com
    +---
    +spring:
    +  profiles: development
    +nginx:
    +  server:
    +    name: develop.com
    +
    +
    +
    +
    +
    +

    The /sample/default/master/nginx.conf resource might be as follows:

    +
    +
    +
    +
    +
    +
    server {
    +    listen              80;
    +    server_name         example.com;
    +}
    +
    +
    +
    +
    +
    +

    /sample/development/master/nginx.conf might be as follows:

    +
    +
    +
    +
    +
    +
    server {
    +    listen              80;
    +    server_name         develop.com;
    +}
    +
    +
    +
    +
    +
    +
    +

    AWS S3

    +
    +

    To enable serving plain text for AWS s3, the Config Server application needs to include a dependency on Spring Cloud AWS. +For details on how to set up that dependency, see the +Spring Cloud AWS Reference Guide. +Then you need to configure Spring Cloud AWS, as described in the +Spring Cloud AWS Reference Guide.

    +
    +