常用应用程序属性
各种属性可以在您的application.properties文件中、application.yml文件中或作为命令行开关指定。本附录提供了Spring Cloud Vault常见属性的列表以及引用使用它们的底层类。
| 属性贡献可能来自您 classpath 中的其他 jar 文件,因此您不应将其视为详尽列表。此外,您还可以定义自己的属性。 |
| 名称 | 默认值 | 描述 |
|---|---|---|
spring.cloud.vault.app-id.app-id-path |
|
AppId 认证后端的挂载路径。 |
spring.cloud.vault.app-id.network-interface |
“MAC_ADDRESS” UserId 机制的网络接口提示。 |
|
spring.cloud.vault.app-id.user-id |
|
UserId 机制。可以是“MAC_ADDRESS”、“IP_ADDRESS”、字符串或类名。 |
spring.cloud.vault.app-role.app-role-path |
|
AppRole 认证后端的挂载路径。 |
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服务器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 |
如果Vault角色关联了多个角色,则用于假定角色的角色arn。@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令牌的TTL。默认为Vault角色可能拥有的最大值。也受限于AWS支持的STS最大值。@since 3.0.2 |
spring.cloud.vault.azure-msi.azure-path |
|
Azure MSI 认证后端的挂载路径。 |
spring.cloud.vault.azure-msi.identity-token-service |
身份令牌服务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 Duration}时间进行续订。@since 2.2 |
|
spring.cloud.vault.config.lifecycle.lease-endpoints |
设置{@link LeaseEndpoints}以委托续订/撤销调用。{@link LeaseEndpoints}封装了Vault版本之间影响续订/撤销端点位置的差异。可以是Vault 0.8或更高版本的{@link LeaseEndpoints#SysLeases},也可以是旧版本的{@link LeaseEndpoints#Legacy}(默认)。@since 2.2 |
|
spring.cloud.vault.config.lifecycle.lease-strategy |
设置与{@link org.springframework.vault.core.lease.SecretLeaseContainer#setLeaseStrategy(LeaseStrategy)}一起使用的{@link LeaseStrategy},以在续订错误时保留或丢弃令牌。@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 |
|
获取到的令牌的目标属性。 |
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 |
OAuth2账户私钥的Base64编码内容,为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 |
|
JWT令牌的有效期。 |
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.github.github-path |
|
GitHub认证后端的挂载路径。 |
spring.cloud.vault.github.token |
GitHub个人令牌。 |
|
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 |
|
服务账户令牌文件的路径。 |
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 |
活动配置文件列表。@since 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 Enterprise)。 |
|
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 |
|
协议方案。可以是“http”或“https”。 |
spring.cloud.vault.session.lifecycle.enabled |
|
启用会话生命周期管理。 |
spring.cloud.vault.session.lifecycle.expiry-threshold |
|
{@link LoginToken}的到期阈值。该阈值表示将登录令牌视为有效的最小TTL持续时间。TTL较短的令牌被视为已过期且不再使用。应大于{@code refreshBeforeExpiry}以防止令牌到期。 |
spring.cloud.vault.session.lifecycle.refresh-before-expiry |
|
在续订{@link LoginToken}之前至少需要的时间段。 |
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令牌。如果{@link #authentication}是{@code TOKEN},则必需。 |
|
spring.cloud.vault.uri |
Vault URI。可以设置方案、主机和端口。 |