The default implementation of EnvironmentRepository uses a Git backend, which is very convenient for managing upgrades and physical
+(These same rules apply in a standalone Spring Boot application.)
You can set spring.cloud.config.server.accept-empty to false so that Server would return a HTTP 404 status, if the application is not found.By default, this flag is set to true. +==== Git Backend
The default implementation of EnvironmentRepository uses a Git backend, which is very convenient for managing upgrades and physical
environments and for auditing changes.
To change the location of the repository, you can set the spring.cloud.config.server.git.uri configuration property in the Config Server (for example in application.yml).
If you set it with a file: prefix, it should work from a local repository so that you can get started quickly and easily without a server. However, in that case, the server operates directly on the local repository without cloning it (it does not matter if it is not bare because the Config Server never makes changes to the "remote" repository).
@@ -49,7 +50,7 @@ If the git branch or tag name contains a slash (/),
For example, if the label is foo/bar, replacing the slash would result in the following label: foo($$_$$)bar.
The inclusion of the special string ($$_$$) can also be applied to the {application} parameter.
If you use a command-line client such as curl, be careful with the brackets in the URL — you should
-escape them from the shell with single quotes ('').
Spring Cloud Config Server supports a git repository URL with placeholders for the {application} and {profile} (and {label} if you need it, but remember that the label is applied as a git label anyway).
+escape them from the shell with single quotes ('').
Spring Cloud Config Server supports a git repository URL with placeholders for the {application} and {profile} (and {label} if you need it, but remember that the label is applied as a git label anyway).
So you can support a “one repository per application” policy by using a structure similar to the following:
spring: cloud: config: @@ -62,7 +63,7 @@ organizations, as shown in the following example:config: server: git: - uri: https://github.com/{application}where
{application}is provided at request time in the following format:organization($$_$$)application.
Spring Cloud Config also includes support for more complex requirements with pattern + uri: https://github.com/{application}
where {application} is provided at request time in the following format: organization($$_$$)application.
Spring Cloud Config also includes support for more complex requirements with pattern
matching on the application and profile name.
The pattern format is a comma-separated list of {application}/{profile} names with wildcards (note that a pattern beginning with a wildcard may need to be quoted), as shown in the following example:
spring: cloud: @@ -126,7 +127,7 @@ The server can be configured to clone the repositories at startup, as shown in t uri: http://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]](images/note.png) | 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 |
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:
+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.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: cloud: config: server: @@ -140,13 +141,13 @@ To avoid surprises, you should ensure that only one entry is present in theknown_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/configor (in the same way as for any other JVM process) with -system properties (-Dhttps.proxyHostand-Dhttps.proxyPort).
Tip If you do not know where your
~/.gitdirectory is, usegit config --globalto manipulate the settings (for example,git config --global http.sslVerify false).
Spring Cloud Config Server also supports AWS CodeCommit authentication.
+system properties (-Dhttps.proxyHost and -Dhttps.proxyPort).
![[Tip]](images/tip.png) | Tip |
|---|---|
If you do not know where your |
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 |
|---|---|
The |
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.
+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.
![[Warning]](images/warning.png)