此版本仍在开发中,尚未被视为稳定版本。如需最新的稳定版本,请使用 Spring Cloud Vault 4.1.4spring-doc.cn

ConfigData 接口

Spring Boot 从版本 2.4 开始提供了一个 ConfigData API,该 API 允许声明配置源并将其导入为属性源。spring-doc.cn

Spring Cloud Vault 从版本 3.0 开始使用 ConfigData API 将 Vault 的秘密后端挂载为属性源。 在以前的版本中,使用了 Bootstrap 上下文。 ConfigData API 更加灵活,因为它允许指定要导入的配置系统以及导入的顺序。spring-doc.cn

您可以通过设置 configuration 属性或包含 dependency 来启用引导程序上下文。 使用 boostrap 上下文应该很少需要,因此我们建议使用 Config Data API,以便在属性源排序方面获得更大的灵活性。spring.cloud.bootstrap.enabled=trueorg.springframework.cloud:spring-cloud-starter-bootstrap

ConfigData 位置

您可以通过一个或多个从 Vault 具体化的配置来挂载 Vault 配置。 Spring Cloud Vault 支持两个配置位置:PropertySourcespring-doc.cn

使用默认位置会为所有已启用的 Secret Backends 挂载属性源。 无需进一步配置,Spring Cloud Vault 会将键值后端挂载在 。 每个激活的用户档案都会在表单后面添加另一个上下文路径 。 向 Classpath 添加更多模块,例如 ,提供额外的秘密后端配置选项,如果启用,这些选项将作为属性源挂载。/secret/${spring.application.name}/secret/$\{spring.application.name}/${profile}spring-cloud-config-databasesspring-doc.cn

如果要控制从 Vault 挂载哪些上下文路径作为,则可以使用上下文位置 () 或配置 VaultConfigurerPropertySourcevault:///my/context/pathspring-doc.cn

上下文位置是单独指定和挂载的。 Spring Cloud Vault 将每个位置挂载为唯一的。 您可以将默认位置与上下文位置(或其他配置系统)混合,以控制属性源的顺序。 如果您想禁用默认的键值路径计算并自行挂载每个键值后端,则此方法尤其有用。PropertySourcespring-doc.cn

application.yml
spring.config.import: vault://first/context/path, vault://other/path, vault://

Spring 中的属性名称必须是唯一的,以避免阴影。 如果您在不同的上下文路径中使用相同的密钥名称,并且希望将这些名称作为单个属性公开,则可以通过向位置添加查询参数来区分它们。Environmentprefixspring-doc.cn

示例 1.application.yml
spring.config.import: vault://my/path?prefix=foo., vault://my/other/path?prefix=bar.
secret: ${foo.secret}
other.secret: ${bar.secret}
前缀将按原样添加到 Vault 返回的所有属性名称中。如果您希望在前缀和键名称之间用点分隔键名称,请确保在前缀中添加一个尾部点。

有条件地启用/禁用 Vault 配置

在某些情况下,可能需要在没有 Vault 的情况下启动应用程序。您可以通过 location 字符串来表示 Vault 配置位置应该是可选的还是强制性的(默认):spring-doc.cn

如果通过 禁用了 Vault 支持,则会在应用程序启动期间跳过可选位置。spring.cloud.vault.enabled=falsespring-doc.cn

找不到的 Vault 上下文路径(HTTP 状态 404)将被跳过,无论配置位置是否标记为可选。如果由于 HTTP 状态 404 而找不到 Vault 上下文路径,则 Vault 客户端“快速失败”允许在启动时失败。

基础设施定制

Spring Cloud Vault 需要 infrastructure 类才能与 Vault 交互。当不使用 ConfigData API 时(意味着您尚未指定或上下文 Vault 路径),Spring Cloud Vault 通过 和 定义其 bean。 Spring Boot 在 Spring Context 可用之前引导应用程序。因此,注册 bean 本身,以便稍后将这些 bean 传播到应用程序上下文中。spring.config.import=vault://VaultAutoConfigurationVaultReactiveAutoConfigurationVaultConfigDataLoaderspring-doc.cn

您可以通过使用 API 注册自定义实例来自定义 Spring Cloud Vault 使用的基础架构:Bootstrapperspring-doc.cn

定制ClientHttpRequestFactory
ClientOptions options = new ClientOptions();
SslConfiguration sslConfiguration = SslConfiguration.unconfigured();
HttpClientBuilder builder = HttpComponents.getHttpClientBuilder(options, sslConfiguration);

InstanceSupplier<ClientFactoryWrapper> supplier = context ->
new ClientFactoryWrapper(new HttpComponentsClientHttpRequestFactory(builder.build()));

SpringApplication application = new SpringApplication(MyApplication.class);
application.addBootstrapRegistryInitializer(registry -> registry.register(ClientFactoryWrapper.class, supplier));
定制RestTemplateBuilder
InstanceSupplier<RestTemplateBuilder> supplier = context -> {

	return RestTemplateBuilder
			.builder()
			.requestFactory(context.get(ClientFactoryWrapper.class).getClientHttpRequestFactory())
			.defaultHeader("X-Vault-Namespace", "my-namespace");
};

SpringApplication application = new SpringApplication(MyApplication.class);
application.addBootstrapRegistryInitializer(registry -> registry.register(RestTemplateBuilder.class, supplier));

另请参阅 自定义要作为 PropertySource 公开的密钥后端和自定义钩子的来源。VaultConfigDataLoaderspring-doc.cn