|
此版本仍在开发中，尚未被视为稳定版本。如需最新的稳定版本，请使用 Spring Cloud Vault 4.1.4！ |
ConfigData 接口
Spring Boot 从版本 2.4 开始提供了一个 ConfigData API，该 API 允许声明配置源并将其导入为属性源。
Spring Cloud Vault 从版本 3.0 开始使用 ConfigData API 将 Vault 的秘密后端挂载为属性源。 在以前的版本中，使用了 Bootstrap 上下文。 ConfigData API 更加灵活，因为它允许指定要导入的配置系统以及导入的顺序。
您可以通过设置 configuration 属性来启用 bootstrap 上下文spring.cloud.bootstrap.enabled=true或通过包含依赖项org.springframework.cloud:spring-cloud-starter-bootstrap.
使用 boostrap 上下文应该很少需要，因此我们建议使用 Config Data API，以便在属性源排序方面获得更大的灵活性。 |
ConfigData 位置
您可以通过一个或多个PropertySource从 Vault 具体化。
Spring Cloud Vault 支持两个配置位置：
-
vault://（默认位置） -
vault:///<context-path>（上下文位置）
使用默认位置会为所有已启用的 Secret Backends 挂载属性源。
无需进一步配置， Spring Cloud Vault 会将键值后端挂载在/secret/${spring.application.name}.
每个已激活的用户档案都会在表单后面添加另一个上下文路径/secret/$\{spring.application.name}/${profile}.
向 Classpath 添加更多模块，例如spring-cloud-config-databases，提供其他密钥后端配置选项，如果启用，这些选项将作为属性源挂载。
如果要控制从 Vault 挂载哪些上下文路径作为PropertySource，您可以使用上下文位置 （vault:///my/context/path） 或配置VaultConfigurer.
上下文位置是单独指定和挂载的。
Spring Cloud Vault 将每个位置挂载为唯一的PropertySource.
您可以将默认位置与上下文位置（或其他配置系统）混合，以控制属性源的顺序。
如果您想禁用默认的键值路径计算并自行挂载每个键值后端，则此方法尤其有用。
spring.config.import: vault://first/context/path, vault://other/path, vault://Spring 中的属性名称Environment必须是唯一的，以避免阴影。
如果您在不同的上下文路径中使用相同的密钥名称，并且希望将它们作为单个属性公开，则可以通过在不同的上下文路径中添加prefixquery 参数设置为位置。
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 配置位置应该是可选的还是强制性的（默认）：
-
optional:vault://（默认位置） -
optional:vault:///<context-path>（上下文位置）
如果通过以下方式禁用了 Vault 支持，则在应用程序启动期间将跳过可选位置spring.cloud.vault.enabled=false.
| 找不到的 Vault 上下文路径（HTTP 状态 404）将被跳过，无论配置位置是否标记为可选。如果由于 HTTP 状态 404 而找不到 Vault 上下文路径，则 Vault 客户端“快速失败”允许在启动时失败。 |
基础设施定制
Spring Cloud Vault 需要 infrastructure 类才能与 Vault 交互。当不使用 ConfigData API 时（意味着您尚未指定spring.config.import=vault://或上下文 Vault 路径），Spring Cloud Vault 通过VaultAutoConfiguration和VaultReactiveAutoConfiguration.
Spring Boot 在 Spring Context 可用之前引导应用程序。因此VaultConfigDataLoader注册 bean 本身，以便稍后将这些 bean 传播到应用程序上下文中。
您可以通过使用Bootstrapper应用程序接口：
ClientHttpRequestFactoryClientOptions 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));RestTemplateBuilderInstanceSupplier<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 公开的 secret 后端以及VaultConfigDataLoader用于自定义钩子。