Open sourceActive

Spring Cloud Config

Spring Cloud Config Server supports Vault as a backend for securely accessing secrets.

Open source page

Field note

What it does

Spring Cloud Config Server also supports Vault as a backend. Vault is a tool for securely accessing secrets. To enable the config server to use a Vault backend, run your config server with the vault profile.

Capabilities

Available capabilities

Tags

Tags

Ways to use it

Ways to use it

sdk

java / https://docs.spring.io/spring-cloud-config/reference/client.html

sdk

Java / https://docs.spring.io/spring-cloud-config/reference/client.html

other

Not filed / Not filed

other

Not filed / https://docs.spring.io/spring-cloud-config/reference/server/environment-repository/vault-backend.html

sdk

Not filed / Not filed

sdk

Not filed / Not filed

rest

Not filed / Not filed

cli

Not filed / Not filed

other

Not filed / Not filed

sdk

java / Not filed

rest

Not filed / Not filed

rest

Not filed / Not filed

Product features

Product features

Application hierarchy sharing

Place properties under the /application hierarchy to share config with all applications.

AWS Parameter Store backend

Use AWS Parameter Store as an environment repository backend.

AWS Secrets Manager backend

Use AWS Secrets Manager as an environment repository backend, sharing config via /application/ or default profile.

Client-side support

Client-side support mapping to Spring Environment and PropertySource abstractions.

Composite environment repository

Proxy settings are per repository; configure each backend in the composite individually.

Config Server

Central place to manage external properties for applications across all environments.

CredHub Server

Share configuration by placing it in /application/ or the default profile.

Default label property

spring.cloud.config.server.aws-secretsmanager.default-label sets the default label; defaults to AWSCURRENT.

@EnableConfigServer Annotation

Embed the config server in a Spring Boot application.

Environment Repository

Serves Environment objects parametrized by application, profile, and label.

File Based Repositories

Git, SVN, and native repositories share application* resources across all client applications.

Git backend

Default EnvironmentRepository implementation using a Git repository, mapping {label} to a git label.

Git storage backend

Default server storage backend using git, supporting labelled versions of configuration environments.

Placeholders in Git URI

Git repository URLs support {application}, {profile} and {label} placeholders.

HTTP Resource-Based API

Provides an HTTP resource-based API for external configuration.

Ignore label property

spring.cloud.config.server.aws-secretsmanager.ignore-label ignores the {label} parameter and default-label.

JDBC Environment Repository

Share configurations by inserting records with 'application' in the application column.

KV Version 2 Support

Set spring.cloud.config.server.vault.kv-version=2 to account for the versioned key-value backend.

Label Locations

Appends the {label} parameter to the search path; disabled via spring.cloud.config.server.native.addLabelLocations=false.

Local Path Hardening

Symlink and TOCTOU checks for file: URIs, basedir, and working directories.

Multiple Label Error Handling

continue-on-multiple-label-failure option to try all labels before failing.

Native Profile

Config Server profile that loads config files from the local classpath or file system instead of Git.

Pattern matching and multiple repositories

Comma-separated {application}/{profile} patterns with wildcards select among multiple repositories.

Pluggable Backends

Alternative storage implementations can be added and plugged in with Spring configuration.

Proxy configuration properties

Properties host, port, nonProxyHosts, username, and password prefixed by proxy.http or proxy.https.

Search Locations

Configured via spring.cloud.config.server.native.searchLocations, supporting {application}, {profile}, and {label} placeholders.

Spring Environment integration

Client and server concepts map to Spring Environment and PropertySource abstractions.

Spring Framework Documentation

SVN Backend

SVN-based environment repository checked out to the local filesystem.

Vault Backend

EnvironmentRepository backend backed by HashiCorp Vault.

Vault Profile

Run your config server with the vault profile to enable Vault backend.

Vault Server

Share configuration with all applications by placing it in secret/application.

X-Config-Token Header

Provide authentication to let Config Server talk to Vault via the X-Config-Token header.