diff --git a/2.1.x/multi/multi__spring_cloud_config_server.html b/2.1.x/multi/multi__spring_cloud_config_server.html index f127be37..1b15996b 100644 --- a/2.1.x/multi/multi__spring_cloud_config_server.html +++ b/2.1.x/multi/multi__spring_cloud_config_server.html @@ -126,14 +126,14 @@ The server can be configured to clone the repositories at startup, as shown in t team-a: pattern: team-a-* cloneOnStart: true - uri: http://git/team-a/config-repo.git + uri: https://git/team-a/config-repo.git team-b: pattern: team-b-* cloneOnStart: false - uri: http://git/team-b/config-repo.git + uri: https://git/team-b/config-repo.git team-c: pattern: team-c-* - uri: http://git/team-a/config-repo.git

In the preceding example, the server clones team-a’s config-repo on startup, before it + uri: https://git/team-a/config-repo.git

In the preceding example, the server clones team-a’s config-repo on startup, before it accepts any requests. All other repositories are not cloned until configuration from the repository is requested.

[Note]Note

Setting a repository to be cloned when the Config Server starts up can help to identify a misconfigured configuration source (such as an invalid repository URI) quickly, while the Config Server is starting up. With cloneOnStart not enabled for a configuration source, the Config Server may start successfully with a misconfigured or invalid configuration source and not detect an error until an application requests configuration from that configuration source.

Authentication

To use HTTP basic authentication on the remote repository, add the username and password properties separately (not in the URL), as shown in the following example:

spring:
@@ -150,12 +150,12 @@ To avoid surprises, you should ensure that only one entry is present in the known_hosts file.
 The repository is accessed by using JGit, so any documentation you find on that should be applicable.
 HTTPS proxy settings can be set in ~/.git/config or (in the same way as for any other JVM process) with
-system properties (-Dhttps.proxyHost and -Dhttps.proxyPort).
[Tip]Tip
If you do not know where your ~/.git directory is, use git config --global to manipulate the settings (for example, git config --global http.sslVerify false).

Authentication with AWS CodeCommit

Spring Cloud Config Server also supports AWS CodeCommit authentication. +system properties (-Dhttps.proxyHost and -Dhttps.proxyPort).

[Tip]Tip

If you do not know where your ~/.git directory is, use git config --global to manipulate the settings (for example, git config --global http.sslVerify false).

Authentication with AWS CodeCommit

Spring Cloud Config Server also supports AWS CodeCommit authentication. AWS CodeCommit uses an authentication helper when using Git from the command line. This helper is not used with the JGit library, so a JGit CredentialProvider for AWS CodeCommit is created if the Git URI matches the AWS CodeCommit pattern. -AWS CodeCommit URIs follow this pattern://git-codecommit.${AWS_REGION}.amazonaws.com/${repopath}.

If you provide a username and password with an AWS CodeCommit URI, they must be the AWS accessKeyId and secretAccessKey that provide access to the repository. -If you do not specify a username and password, the accessKeyId and secretAccessKey are retrieved by using the AWS Default Credential Provider Chain.

If your Git URI matches the CodeCommit URI pattern (shown earlier), you must provide valid AWS credentials in the username and password or in one of the locations supported by the default credential provider chain. -AWS EC2 instances may use IAM Roles for EC2 Instances.

[Note]Note

The aws-java-sdk-core jar is an optional dependency. +AWS CodeCommit URIs follow this pattern://git-codecommit.${AWS_REGION}.amazonaws.com/${repopath}.

If you provide a username and password with an AWS CodeCommit URI, they must be the AWS accessKeyId and secretAccessKey that provide access to the repository. +If you do not specify a username and password, the accessKeyId and secretAccessKey are retrieved by using the AWS Default Credential Provider Chain.

If your Git URI matches the CodeCommit URI pattern (shown earlier), you must provide valid AWS credentials in the username and password or in one of the locations supported by the default credential provider chain. +AWS EC2 instances may use IAM Roles for EC2 Instances.

[Note]Note

The aws-java-sdk-core jar is an optional dependency. If the aws-java-sdk-core jar is not on your classpath, the AWS Code Commit credential provider is not created, regardless of the git server URI.

Git SSH configuration using properties

By default, the JGit library used by Spring Cloud Config Server uses SSH configuration files such as ~/.ssh/known_hosts and /etc/ssh/ssh_config when connecting to Git repositories by using an SSH URI. In cloud environments such as Cloud Foundry, the local filesystem may be ephemeral or not easily accessible. For those cases, SSH configuration can be set by using Java properties. @@ -220,15 +220,15 @@ folder content changes by an OS process) such that Spring Cloud Config Server ca repos: team-a: pattern: team-a-* - uri: http://git/team-a/config-repo.git + uri: https://git/team-a/config-repo.git force-pull: true team-b: pattern: team-b-* - uri: http://git/team-b/config-repo.git + uri: https://git/team-b/config-repo.git force-pull: true team-c: pattern: team-c-* - uri: http://git/team-a/config-repo.git

[Note]Note

The default value for force-pull property is false.

Deleting untracked branches in Git Repositories

As Spring Cloud Config Server has a clone of the remote git repository + uri: https://git/team-a/config-repo.git

[Note]Note

The default value for force-pull property is false.

Deleting untracked branches in Git Repositories

As Spring Cloud Config Server has a clone of the remote git repository after check-outing branch to local repo (e.g fetching properties by label) it will keep this branch forever or till the next server restart (which creates new local repo). So there could be a case when remote branch is deleted but local copy of it is still available for fetching. @@ -248,7 +248,7 @@ the config server will fetch updated configuration from the Git repo every time is requested.

2.1.2 Version Control Backend Filesystem Use

[Warning]Warning

With VCS-based backends (git, svn), files are checked out or cloned to the local filesystem. By default, they are put in the system temporary directory with a prefix of config-repo-. On linux, for example, it could be /tmp/config-repo-<randomid>. -Some operating systems routinely clean out temporary directories. +Some operating systems routinely clean out temporary directories. This can lead to unexpected behavior, such as missing properties. To avoid this problem, change the directory that Config Server uses by setting spring.cloud.config.server.git.basedir or spring.cloud.config.server.svn.basedir to a directory that does not reside in the system temp structure.

2.1.3 File System Backend

There is also a “native” profile in the Config Server that does not use Git but loads the config files from the local classpath or file system (any static URL you want to point to with spring.cloud.config.server.native.searchLocations). To use the native profile, launch the Config Server with spring.profiles.active=native.

[Note]Note

Remember to use the file: prefix for file resources (the default without a prefix is usually the classpath). diff --git a/2.1.x/single/spring-cloud-config.html b/2.1.x/single/spring-cloud-config.html index 6a0d976a..a0c2003e 100644 --- a/2.1.x/single/spring-cloud-config.html +++ b/2.1.x/single/spring-cloud-config.html @@ -210,14 +210,14 @@ The server can be configured to clone the repositories at startup, as shown in t team-a: pattern: team-a-* cloneOnStart: true - uri: http://git/team-a/config-repo.git + uri: https://git/team-a/config-repo.git team-b: pattern: team-b-* cloneOnStart: false - uri: http://git/team-b/config-repo.git + uri: https://git/team-b/config-repo.git team-c: pattern: team-c-* - uri: http://git/team-a/config-repo.git

In the preceding example, the server clones team-a’s config-repo on startup, before it + uri: https://git/team-a/config-repo.git

In the preceding example, the server clones team-a’s config-repo on startup, before it accepts any requests. All other repositories are not cloned until configuration from the repository is requested.

[Note]Note

Setting a repository to be cloned when the Config Server starts up can help to identify a misconfigured configuration source (such as an invalid repository URI) quickly, while the Config Server is starting up. With cloneOnStart not enabled for a configuration source, the Config Server may start successfully with a misconfigured or invalid configuration source and not detect an error until an application requests configuration from that configuration source.

Authentication

To use HTTP basic authentication on the remote repository, add the username and password properties separately (not in the URL), as shown in the following example:

spring:
@@ -234,12 +234,12 @@ To avoid surprises, you should ensure that only one entry is present in the known_hosts file.
 The repository is accessed by using JGit, so any documentation you find on that should be applicable.
 HTTPS proxy settings can be set in ~/.git/config or (in the same way as for any other JVM process) with
-system properties (-Dhttps.proxyHost and -Dhttps.proxyPort).
[Tip]Tip
If you do not know where your ~/.git directory is, use git config --global to manipulate the settings (for example, git config --global http.sslVerify false).

Authentication with AWS CodeCommit

Spring Cloud Config Server also supports AWS CodeCommit authentication. +system properties (-Dhttps.proxyHost and -Dhttps.proxyPort).

[Tip]Tip

If you do not know where your ~/.git directory is, use git config --global to manipulate the settings (for example, git config --global http.sslVerify false).

Authentication with AWS CodeCommit

Spring Cloud Config Server also supports AWS CodeCommit authentication. AWS CodeCommit uses an authentication helper when using Git from the command line. This helper is not used with the JGit library, so a JGit CredentialProvider for AWS CodeCommit is created if the Git URI matches the AWS CodeCommit pattern. -AWS CodeCommit URIs follow this pattern://git-codecommit.${AWS_REGION}.amazonaws.com/${repopath}.

If you provide a username and password with an AWS CodeCommit URI, they must be the AWS accessKeyId and secretAccessKey that provide access to the repository. -If you do not specify a username and password, the accessKeyId and secretAccessKey are retrieved by using the AWS Default Credential Provider Chain.

If your Git URI matches the CodeCommit URI pattern (shown earlier), you must provide valid AWS credentials in the username and password or in one of the locations supported by the default credential provider chain. -AWS EC2 instances may use IAM Roles for EC2 Instances.

[Note]Note

The aws-java-sdk-core jar is an optional dependency. +AWS CodeCommit URIs follow this pattern://git-codecommit.${AWS_REGION}.amazonaws.com/${repopath}.

If you provide a username and password with an AWS CodeCommit URI, they must be the AWS accessKeyId and secretAccessKey that provide access to the repository. +If you do not specify a username and password, the accessKeyId and secretAccessKey are retrieved by using the AWS Default Credential Provider Chain.

If your Git URI matches the CodeCommit URI pattern (shown earlier), you must provide valid AWS credentials in the username and password or in one of the locations supported by the default credential provider chain. +AWS EC2 instances may use IAM Roles for EC2 Instances.

[Note]Note

The aws-java-sdk-core jar is an optional dependency. If the aws-java-sdk-core jar is not on your classpath, the AWS Code Commit credential provider is not created, regardless of the git server URI.

Git SSH configuration using properties

By default, the JGit library used by Spring Cloud Config Server uses SSH configuration files such as ~/.ssh/known_hosts and /etc/ssh/ssh_config when connecting to Git repositories by using an SSH URI. In cloud environments such as Cloud Foundry, the local filesystem may be ephemeral or not easily accessible. For those cases, SSH configuration can be set by using Java properties. @@ -304,15 +304,15 @@ folder content changes by an OS process) such that Spring Cloud Config Server ca repos: team-a: pattern: team-a-* - uri: http://git/team-a/config-repo.git + uri: https://git/team-a/config-repo.git force-pull: true team-b: pattern: team-b-* - uri: http://git/team-b/config-repo.git + uri: https://git/team-b/config-repo.git force-pull: true team-c: pattern: team-c-* - uri: http://git/team-a/config-repo.git

[Note]Note

The default value for force-pull property is false.

Deleting untracked branches in Git Repositories

As Spring Cloud Config Server has a clone of the remote git repository + uri: https://git/team-a/config-repo.git

[Note]Note

The default value for force-pull property is false.

Deleting untracked branches in Git Repositories

As Spring Cloud Config Server has a clone of the remote git repository after check-outing branch to local repo (e.g fetching properties by label) it will keep this branch forever or till the next server restart (which creates new local repo). So there could be a case when remote branch is deleted but local copy of it is still available for fetching. @@ -332,7 +332,7 @@ the config server will fetch updated configuration from the Git repo every time is requested.

2.1.2 Version Control Backend Filesystem Use

[Warning]Warning

With VCS-based backends (git, svn), files are checked out or cloned to the local filesystem. By default, they are put in the system temporary directory with a prefix of config-repo-. On linux, for example, it could be /tmp/config-repo-<randomid>. -Some operating systems routinely clean out temporary directories. +Some operating systems routinely clean out temporary directories. This can lead to unexpected behavior, such as missing properties. To avoid this problem, change the directory that Config Server uses by setting spring.cloud.config.server.git.basedir or spring.cloud.config.server.svn.basedir to a directory that does not reside in the system temp structure.

2.1.3 File System Backend

There is also a “native” profile in the Config Server that does not use Git but loads the config files from the local classpath or file system (any static URL you want to point to with spring.cloud.config.server.native.searchLocations). To use the native profile, launch the Config Server with spring.profiles.active=native.

[Note]Note

Remember to use the file: prefix for file resources (the default without a prefix is usually the classpath). diff --git a/2.1.x/spring-cloud-config.xml b/2.1.x/spring-cloud-config.xml index a20085d3..7b626925 100644 --- a/2.1.x/spring-cloud-config.xml +++ b/2.1.x/spring-cloud-config.xml @@ -349,14 +349,14 @@ The server can be configured to clone the repositories at startup, as shown in t team-a: pattern: team-a-* cloneOnStart: true - uri: http://git/team-a/config-repo.git + uri: https://git/team-a/config-repo.git team-b: pattern: team-b-* cloneOnStart: false - uri: http://git/team-b/config-repo.git + uri: https://git/team-b/config-repo.git team-c: pattern: team-c-* - uri: http://git/team-a/config-repo.git + uri: https://git/team-a/config-repo.git In the preceding example, the server clones team-a’s config-repo on startup, before it accepts any requests. All other repositories are not cloned until configuration from the repository is requested. @@ -390,14 +390,14 @@ system properties (-Dhttps.proxyHost and -Dhttps.pro

Authentication with AWS CodeCommit -Spring Cloud Config Server also supports AWS CodeCommit authentication. +Spring Cloud Config Server also supports AWS CodeCommit authentication. AWS CodeCommit uses an authentication helper when using Git from the command line. This helper is not used with the JGit library, so a JGit CredentialProvider for AWS CodeCommit is created if the Git URI matches the AWS CodeCommit pattern. AWS CodeCommit URIs follow this pattern://git-codecommit.${AWS_REGION}.amazonaws.com/${repopath}. -If you provide a username and password with an AWS CodeCommit URI, they must be the AWS accessKeyId and secretAccessKey that provide access to the repository. -If you do not specify a username and password, the accessKeyId and secretAccessKey are retrieved by using the AWS Default Credential Provider Chain. +If you provide a username and password with an AWS CodeCommit URI, they must be the AWS accessKeyId and secretAccessKey that provide access to the repository. +If you do not specify a username and password, the accessKeyId and secretAccessKey are retrieved by using the AWS Default Credential Provider Chain. If your Git URI matches the CodeCommit URI pattern (shown earlier), you must provide valid AWS credentials in the username and password or in one of the locations supported by the default credential provider chain. -AWS EC2 instances may use IAM Roles for EC2 Instances. +AWS EC2 instances may use IAM Roles for EC2 Instances. The aws-java-sdk-core jar is an optional dependency. If the aws-java-sdk-core jar is not on your classpath, the AWS Code Commit credential provider is not created, regardless of the git server URI. @@ -528,15 +528,15 @@ folder content changes by an OS process) such that Spring Cloud Config Server ca repos: team-a: pattern: team-a-* - uri: http://git/team-a/config-repo.git + uri: https://git/team-a/config-repo.git force-pull: true team-b: pattern: team-b-* - uri: http://git/team-b/config-repo.git + uri: https://git/team-b/config-repo.git force-pull: true team-c: pattern: team-c-* - uri: http://git/team-a/config-repo.git + uri: https://git/team-a/config-repo.git The default value for force-pull property is false. @@ -578,7 +578,7 @@ is requested. With VCS-based backends (git, svn), files are checked out or cloned to the local filesystem. By default, they are put in the system temporary directory with a prefix of config-repo-. On linux, for example, it could be /tmp/config-repo-<randomid>. -Some operating systems routinely clean out temporary directories. +Some operating systems routinely clean out temporary directories. This can lead to unexpected behavior, such as missing properties. To avoid this problem, change the directory that Config Server uses by setting spring.cloud.config.server.git.basedir or spring.cloud.config.server.svn.basedir to a directory that does not reside in the system temp structure.