|
这个版本仍在开发中,目前尚未被认为是稳定的。要使用最新稳定版本,请使用 Spring Cloud Vault 5.0.1! |
常用应用程序属性
可以在您的application.properties文件、application.yml文件或作为命令行开关中指定各种属性。
本附录提供一组常见的Spring Cloud Vault属性,并引用到消耗它们的底层类。
| 属性贡献可能来自类路径(classpath)中的额外 JAR 文件,因此你不应将此视为详尽无遗的列表。 此外,你也可以定义自己的属性。 |
| 姓名 | 默认 | 描述 |
|---|---|---|
spring.cloud.vault.app-id.app-id-path |
|
应用ID认证后端的映射路径。 |
spring.cloud.vault.app-id.network-interface |
"MAC_ADDRESS" 用户ID机制的网络接口提示。 |
|
spring.cloud.vault.app-id.user-id |
|
用户ID机制。可以是"MAC_ADDRESS"、"IP_ADDRESS"、一个字符串或一个类名。 |
spring.cloud.vault.app-role.app-role-path |
|
应用角色认证后端的路径。 |
spring.cloud.vault.app-role.role |
角色名称(可选),用于拉取模式。 |
|
spring.cloud.vault.app-role.role-id |
角色ID。 |
|
spring.cloud.vault.app-role.secret-id |
秘密ID |
|
spring.cloud.vault.application-name |
|
应用程序名称用于AppId认证。 |
spring.cloud.vault.authentication |
|
|
spring.cloud.vault.aws-ec2.aws-ec2-path |
|
AWS-EC2 认证后端的映射路径。 |
spring.cloud.vault.aws-ec2.identity-document |
|
AWS-EC2 PKCS7 证书文档的URL。 |
spring.cloud.vault.aws-ec2.nonce |
用于AWS-EC2认证的随机数。空随机数将默认生成随机数。 |
|
spring.cloud.vault.aws-ec2.role |
角色名称,可选。 |
|
spring.cloud.vault.aws-iam.aws-path |
|
AWS 认证后端的映射路径。 |
spring.cloud.vault.aws-iam.endpoint-uri |
STS server URI。@since 2.2 |
|
spring.cloud.vault.aws-iam.region |
区域名称,可选。若未设置,将根据AWS默认值推断。@since 4.0.1 |
|
spring.cloud.vault.aws-iam.role |
角色名称,可选。若未设置,默认为友好的IAM名称。 |
|
spring.cloud.vault.aws-iam.server-name |
用于在登录请求的头中设置{@code X-Vault-AWS-IAM-Server-ID}头的服务器名称。 |
|
spring.cloud.vault.aws.access-key-property |
|
目标属性用于获取访问密钥。 |
spring.cloud.vault.aws.backend |
|
aws 后端路径。 |
spring.cloud.vault.aws.credential-type |
|
aws 凭证类型 |
spring.cloud.vault.aws.enabled |
|
启用 aws 后端使用。 |
spring.cloud.vault.aws.role |
凭证的名称。 |
|
spring.cloud.vault.aws.role-arn |
角色arn用于assumed_role,在我们与vault角色关联有多个角色时。@since 3.0.2 |
|
spring.cloud.vault.aws.secret-key-property |
|
目标属性用于获取的密钥。 |
spring.cloud.vault.aws.session-token-key-property |
|
目标属性用于获取的密钥。 |
spring.cloud.vault.aws.ttl |
|
STS Tokens的 TTL。默认值为 vault Role 中的 Max,且受限于 AWS 支持的最大值作为 STS 的最大值。@since 3.0.2 |
spring.cloud.vault.azure-msi.azure-path |
|
Azure MSI 认证后端的映射路径。 |
spring.cloud.vault.azure-msi.identity-token-service |
身份Tokens服务URI。 @since 3.0 |
|
spring.cloud.vault.azure-msi.metadata-service |
实例元数据服务URI. @since 3.0 |
|
spring.cloud.vault.azure-msi.role |
角色名称。 |
|
spring.cloud.vault.cassandra.backend |
|
Cassandra 后端路径。 |
spring.cloud.vault.cassandra.enabled |
|
启用 Cassandra 后端使用。 |
spring.cloud.vault.cassandra.password-property |
|
目标属性为获取到的密码。 |
spring.cloud.vault.cassandra.role |
凭证的名称。 |
|
spring.cloud.vault.cassandra.static-role |
|
启用静态角色使用。@since 2.2 |
spring.cloud.vault.cassandra.username-property |
|
目标属性为获取到的用户名。 |
spring.cloud.vault.config.lifecycle.enabled |
|
启用生命周期管理。 |
spring.cloud.vault.config.lifecycle.expiry-threshold |
到期阈值。{@link Lease} 在到期前给定 {@link Duration} 之前刷新。@since 2.2 |
|
spring.cloud.vault.config.lifecycle.lease-endpoints |
设置{@link LeaseEndpoints}以将续订/撤销调用委托给。{@link LeaseEndpoints}封装了影响续订/撤销端点位置的Vault版本差异。可以是{@link LeaseEndpoints#SysLeases}用于Vault 0.8及以上版本,或 {@link LeaseEndpoints#Legacy}用于旧版本(默认)。@since 2.2 |
|
spring.cloud.vault.config.lifecycle.lease-strategy |
设置 {@link LeaseStrategy} 用于 {@link org.springframework.vault.core.lease.SecretLeaseContainer#setLeaseStrategy(LeaseStrategy)},在续期出错时保留或丢弃tokens。@since 4.1 |
|
spring.cloud.vault.config.lifecycle.min-renewal |
在续签租赁前至少需要的时期。 @since 2.2 |
|
spring.cloud.vault.config.order |
|
用于设置 {@link org.springframework.core.env.PropertySource} 的优先级。这在使用 Vault 作为其他属性源的重写时很有用。@see org.springframework.core.PriorityOrdered |
spring.cloud.vault.connection-timeout |
|
连接超时。 |
spring.cloud.vault.consul.backend |
|
Consul 后端路径。 |
spring.cloud.vault.consul.enabled |
|
启用 consul 后端使用。 |
spring.cloud.vault.consul.role |
凭证的名称。 |
|
spring.cloud.vault.consul.token-property |
|
目标属性为获取到的Tokens。 |
spring.cloud.vault.couchbase.backend |
|
Couchbase 后端路径。 |
spring.cloud.vault.couchbase.enabled |
|
启用 couchbase 后端使用。 |
spring.cloud.vault.couchbase.password-property |
|
目标属性为获取到的密码。 |
spring.cloud.vault.couchbase.role |
凭证的名称。 |
|
spring.cloud.vault.couchbase.static-role |
|
启用静态角色使用。 |
spring.cloud.vault.couchbase.username-property |
|
目标属性为获取到的用户名。 |
spring.cloud.vault.database.backend |
|
数据库后端路径。 |
spring.cloud.vault.database.enabled |
|
启用数据库后端的使用。 |
spring.cloud.vault.database.password-property |
|
目标属性为获取到的密码。 |
spring.cloud.vault.database.role |
凭证的名称。 |
|
spring.cloud.vault.database.static-role |
|
启用静态角色使用。 |
spring.cloud.vault.database.username-property |
|
目标属性为获取到的用户名。 |
spring.cloud.vault.databases |
||
spring.cloud.vault.discovery.enabled |
|
标志用于指示启用Vault服务器发现(将通过发现机制查找Vault服务器URL)。 |
spring.cloud.vault.discovery.service-id |
|
用于定位 Vault 的服务 ID。 |
spring.cloud.vault.elasticsearch.backend |
|
数据库后端路径。 |
spring.cloud.vault.elasticsearch.enabled |
|
启用 elasticsearch 后端的使用。 |
spring.cloud.vault.elasticsearch.password-property |
|
目标属性为获取到的密码。 |
spring.cloud.vault.elasticsearch.role |
凭证的名称。 |
|
spring.cloud.vault.elasticsearch.static-role |
|
启用静态角色使用。 |
spring.cloud.vault.elasticsearch.username-property |
|
目标属性为获取到的用户名。 |
spring.cloud.vault.enabled |
|
启用 Vault 配置服务器。 |
spring.cloud.vault.fail-fast |
|
快速失败如果无法从Vault获取数据。 |
spring.cloud.vault.gcp-gce.gcp-path |
|
Kubernetes 认证后端的映射路径。 |
spring.cloud.vault.gcp-gce.role |
尝试登录所针对的角色名称。 |
|
spring.cloud.vault.gcp-gce.service-account |
可选的服务账户ID。若未配置则使用默认ID。 |
|
spring.cloud.vault.gcp-iam.credentials.encoded-key |
Base64 编码的 OAuth2 账户私钥的 JSON 格式内容。 |
|
spring.cloud.vault.gcp-iam.credentials.location |
OAuth2凭据私钥的位置。 <p> 由于这是一个资源,私钥可以位于多种位置,例如本地文件系统、类路径、URL等。 |
|
spring.cloud.vault.gcp-iam.gcp-path |
|
Kubernetes 认证后端的映射路径。 |
spring.cloud.vault.gcp-iam.jwt-validity |
|
JWTTokens的有效性。 |
spring.cloud.vault.gcp-iam.project-id |
覆盖 GCP 项目 ID。 |
|
spring.cloud.vault.gcp-iam.role |
尝试登录所针对的角色名称。 |
|
spring.cloud.vault.gcp-iam.service-account-id |
覆盖 GCP 服务账户 ID。 |
|
spring.cloud.vault.host |
|
Vault 服务器主机。 |
spring.cloud.vault.kubernetes.kubernetes-path |
|
Kubernetes 认证后端的映射路径。 |
spring.cloud.vault.kubernetes.role |
尝试登录所针对的角色名称。 |
|
spring.cloud.vault.kubernetes.service-account-token-file |
|
服务账户Tokens文件的路径。 |
spring.cloud.vault.kv.application-name |
|
用于上下文的应用程序名称。 |
spring.cloud.vault.kv.backend |
|
默认后端的名称。 |
spring.cloud.vault.kv.backend-version |
|
键值后端版本。目前支持的版本包括: <ul> <li>版本 1(无版本键值后端)。</li> <li>版本 2(带版本键值后端)。</li> </ul> |
spring.cloud.vault.kv.default-context |
|
默认上下文的名称。 |
spring.cloud.vault.kv.enabled |
|
启用键值后端。 |
spring.cloud.vault.kv.profile-separator |
|
将应用程序名称和配置文件组合的配置文件分隔符。 |
spring.cloud.vault.kv.profiles |
激活的配置文件列表。@自3.0版本起 |
|
spring.cloud.vault.mongodb.backend |
|
MongoDB 后端路径。 |
spring.cloud.vault.mongodb.enabled |
|
启用 mongodb 后端使用。 |
spring.cloud.vault.mongodb.password-property |
|
目标属性为获取到的密码。 |
spring.cloud.vault.mongodb.role |
凭证的名称。 |
|
spring.cloud.vault.mongodb.static-role |
|
启用静态角色使用。@since 2.2 |
spring.cloud.vault.mongodb.username-property |
|
目标属性为获取到的用户名。 |
spring.cloud.vault.mysql.backend |
|
mysql 后端路径。 |
spring.cloud.vault.mysql.enabled |
|
启用 mysql 后端的使用。 |
spring.cloud.vault.mysql.password-property |
|
目标属性为获取到的用户名。 |
spring.cloud.vault.mysql.role |
凭证的名称。 |
|
spring.cloud.vault.mysql.username-property |
|
目标属性为获取到的用户名。 |
spring.cloud.vault.namespace |
Vault 命名空间(需要 Vault 企业版)。 |
|
spring.cloud.vault.pcf.instance-certificate |
实例证书的路径(PEM)。默认值为 {@code CF_INSTANCE_CERT} 环境变量。 |
|
spring.cloud.vault.pcf.instance-key |
实例键的路径(PEM)。默认为 {@code CF_INSTANCE_KEY} 环境变量。 |
|
spring.cloud.vault.pcf.pcf-path |
|
Kubernetes 认证后端的映射路径。 |
spring.cloud.vault.pcf.role |
尝试登录所针对的角色名称。 |
|
spring.cloud.vault.port |
|
Vault 服务器端口。 |
spring.cloud.vault.postgresql.backend |
|
postgresql 后端路径。 |
spring.cloud.vault.postgresql.enabled |
|
启用 postgresql 后端的使用。 |
spring.cloud.vault.postgresql.password-property |
|
目标属性为获取到的用户名。 |
spring.cloud.vault.postgresql.role |
凭证的名称。 |
|
spring.cloud.vault.postgresql.username-property |
|
目标属性为获取到的用户名。 |
spring.cloud.vault.rabbitmq.backend |
|
rabbitmq 后端路径。 |
spring.cloud.vault.rabbitmq.enabled |
|
启用 rabbitmq 后端使用。 |
spring.cloud.vault.rabbitmq.password-property |
|
目标属性为获取到的密码。 |
spring.cloud.vault.rabbitmq.role |
凭证的名称。 |
|
spring.cloud.vault.rabbitmq.username-property |
|
目标属性为获取到的用户名。 |
spring.cloud.vault.reactive.enabled |
|
标志用于指示响应式发现是否启用 |
spring.cloud.vault.read-timeout |
|
读取超时。 |
spring.cloud.vault.scheme |
|
协议方案。可以是 either "http" 或 "https"。 |
spring.cloud.vault.session.lifecycle.enabled |
|
启用会话生命周期管理。 |
spring.cloud.vault.session.lifecycle.expiry-threshold |
|
关于{@link LoginToken}的到期阈值。该阈值表示考虑登录Tokens有效的最小TTL持续时间。TTL较短的Tokens被视为已过期并将不再使用。应大于 {@code refreshBeforeExpiry} 以防止Tokens过期。 |
spring.cloud.vault.session.lifecycle.refresh-before-expiry |
|
在刷新 {@link 登录Tokens} 之前所需至少的时间段。 |
spring.cloud.vault.ssl.cert-auth-path |
|
TLS证书认证后端的挂载路径。 |
spring.cloud.vault.ssl.enabled-cipher-suites |
启用的SSL/TLS加密套件列表。 @since 3.0.2 |
|
spring.cloud.vault.ssl.enabled-protocols |
启用的 SSL/TLS 协议列表。 @since 3.0.2 |
|
spring.cloud.vault.ssl.key-store |
受信任库,用于存储证书和私钥。 |
|
spring.cloud.vault.ssl.key-store-password |
用于访问密钥库的密码。 |
|
spring.cloud.vault.ssl.key-store-type |
键存储类型。 @since 3.0 |
|
spring.cloud.vault.ssl.trust-store |
用于存储SSL证书的信任库。 |
|
spring.cloud.vault.ssl.trust-store-password |
用于访问信任库的密码。 |
|
spring.cloud.vault.ssl.trust-store-type |
信任存储的类型。 @since 3.0 |
|
spring.cloud.vault.token |
静态 vault token。在 {@link #authentication} 为 {@code TOKEN} 时必需。 |
|
spring.cloud.vault.uri |
Vault URI。可以使用 scheme、host 和 port 设置。 |