附录 A:常见应用程序属性
可以在文件内、文件内或作为命令行开关指定各种属性。
本附录提供了常见的 Spring Cloud Vault 属性列表以及对使用它们的基础类的引用。application.properties
application.yml
属性贡献可能来自 Classpath 上的其他 jar 文件,因此您不应将其视为详尽的列表。 此外,您还可以定义自己的属性。 |
名字 | 违约 | 描述 |
---|---|---|
spring.cloud.vault.app-id.app ID 路径 |
|
AppId 鉴权后端的挂载路径。 |
spring.cloud.vault.app id.network-interface |
“MAC_ADDRESS”UserId 机制的网络接口提示。 |
|
spring.cloud.vault.app id.用户 ID |
|
UserId 机制。可以是 “MAC_ADDRESS”、“IP_ADDRESS”、字符串或类名。 |
spring.cloud.vault.app-role.app 角色路径 |
|
AppRole 鉴权后端的挂载路径。 |
spring.cloud.vault.app-role.role |
角色的名称(可选),用于 pull-mode。 |
|
spring.cloud.vault.app-role.role-id |
The RoleId. |
|
spring.cloud.vault.app-role.secret-id |
The SecretId. |
|
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 身份验证的 Nonce。空 nonce 默认为 nonce 生成。 |
|
spring.cloud.vault.aws-ec2.role |
角色的名称(可选)。 |
|
spring.cloud.vault.aws-iam.aws-路径 |
|
AWS 身份验证后端的挂载路径。 |
spring.cloud.vault.aws-iam.endpoint-uri |
STS 服务器 URI 的 URI 中。@since 2.2 |
|
spring.cloud.vault.aws-iam.role |
角色的名称(可选)。如果未设置,则默认为友好的 IAM 名称。 |
|
spring.cloud.vault.aws-iam.server-名称 |
用于在登录请求的标头中设置 {@code X-Vault-AWS-IAM-Server-ID} 标头的服务器名称。 |
|
spring.cloud.vault.aws.access-key-property |
|
Target 属性。 |
spring.cloud.vault.aws.backend |
|
aws 后端路径。 |
spring.cloud.vault.aws.凭证类型 |
AWS 凭证类型 |
|
spring.cloud.vault.aws.enabled |
|
启用 aws 后端使用。 |
spring.cloud.vault.aws.role |
凭证的 Role name (角色名称)。 |
|
spring.cloud.vault.aws.role-arn |
角色 arn assumed_role以防我们有多个角色与文件库角色关联。@since 3.0.2 |
|
spring.cloud.vault.aws.secret-key-property |
|
Target 属性。 |
spring.cloud.vault.aws.session-token-key-property |
|
Target 属性。 |
spring.cloud.vault.aws.ttl |
|
sts 令牌的 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 |
身份令牌服务 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 |
|
Target 属性。 |
spring.cloud.vault.cassandra.role |
凭证的 Role name (角色名称)。 |
|
spring.cloud.vault.cassandra.static-role |
|
启用静态角色使用。@since 2.2 |
spring.cloud.vault.cassandra.username-property |
|
Target 属性。 |
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 版本之间的差异。对于 Vault 的 0.8 或更高版本,可以是 {@link LeaseEndpoints#SysLeases},对于旧版本(默认值),可以是 {@link LeaseEndpoints#Legacy}。@since 2.2 |
|
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 |
凭证的 Role name (角色名称)。 |
|
spring.cloud.vault.consul.token-property |
|
Target 属性。 |
spring.cloud.vault.couchbase.backend |
|
Couchbase 后端路径。 |
spring.cloud.vault.couchbase.enabled |
|
启用 couchbase 后端使用。 |
spring.cloud.vault.couchbase.password-property |
|
Target 属性。 |
spring.cloud.vault.couchbase.role |
凭证的 Role name (角色名称)。 |
|
spring.cloud.vault.couchbase.static-role |
|
启用静态角色使用。 |
spring.cloud.vault.couchbase.用户名属性 |
|
Target 属性。 |
spring.cloud.vault.database.backend |
|
数据库后端路径。 |
spring.cloud.vault.database.enabled |
|
启用数据库后端使用。 |
spring.cloud.vault.database.password-property |
|
Target 属性。 |
spring.cloud.vault.database.role |
凭证的 Role name (角色名称)。 |
|
spring.cloud.vault.database.static-role |
|
启用静态角色使用。 |
spring.cloud.vault.database.username-property |
|
Target 属性。 |
spring.cloud.vault.databases |
||
spring.cloud.vault.discovery.enabled |
|
指示已启用 Vault 服务器发现的标志(将通过发现查找 Vault 服务器 URL)。 |
spring.cloud.vault.discovery.service-id |
|
Service ID 查找 Vault。 |
spring.cloud.vault.elasticsearch.backend |
|
数据库后端路径。 |
spring.cloud.vault.elasticsearch.enabled |
|
启用 elasticsearch 后端使用。 |
spring.cloud.vault.elasticsearch.password-property |
|
Target 属性。 |
spring.cloud.vault.elasticsearch.role |
凭证的 Role name (角色名称)。 |
|
spring.cloud.vault.elasticsearch.static-role |
|
启用静态角色使用。 |
spring.cloud.vault.elasticsearch.用户名属性 |
|
Target 属性。 |
spring.cloud.vault.enabled |
|
启用 Vault config server。 |
spring.cloud.vault.fail-fast |
|
如果无法从 Vault 获取数据,则快速失败。 |
spring.cloud.vault.gcp-gce.gcp-路径 |
|
Kubernetes 鉴权后端的挂载路径。 |
spring.cloud.vault.gcp-gce.role |
尝试登录的角色的名称。 |
|
spring.cloud.vault.gcp-gce.service-account |
可选服务账户 ID。如果未配置,则使用默认 ID。 |
|
spring.cloud.vault.gcp-iam.credentials.encoded-key |
JSON 格式的 OAuth2 帐户私钥的 base64 编码内容。 |
|
spring.cloud.vault.gcp-iam.credentials.location |
OAuth2 凭据私钥的位置。<p> 由于这是一个 Resource,私钥可以位于多个位置,例如本地文件系统、Classpath、URL 等。 |
|
spring.cloud.vault.gcp-iam.gcp-路径 |
|
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.host |
|
Vault 服务器主机。 |
spring.cloud.vault.kubernetes.kubernetes-path |
|
Kubernetes 鉴权后端的挂载路径。 |
spring.cloud.vault.kubernetes.role |
尝试登录的角色的名称。 |
|
spring.cloud.vault.kubernetes.service-account-token-文件 |
|
服务帐户令牌文件的路径。 |
spring.cloud.vault.kv.应用程序名称 |
|
要用于上下文的应用程序名称。 |
spring.cloud.vault.kv.backend |
|
默认后端的名称。 |
spring.cloud.vault.kv.backend-version |
|
Key-Value 后端版本。当前支持的版本为:<ul> <li>Version 1(无版本控制的键值后端).</li> <li>Version 2(有版本控制的键值后端).</li> </ul> |
spring.cloud.vault.kv.default-context的 |
|
默认上下文的名称。 |
spring.cloud.vault.kv.enabled |
|
启用 key-value 后端。 |
spring.cloud.vault.kv.profile-separator |
|
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 |
|
Target 属性。 |
spring.cloud.vault.mongodb.role |
凭证的 Role name (角色名称)。 |
|
spring.cloud.vault.mongodb.static-role |
|
启用静态角色使用。@since 2.2 |
spring.cloud.vault.mongodb.用户名属性 |
|
Target 属性。 |
spring.cloud.vault.mysql.backend |
|
mysql 后端路径。 |
spring.cloud.vault.mysql.enabled |
|
启用 mysql 后端使用。 |
spring.cloud.vault.mysql.password-property |
|
Target 属性。 |
spring.cloud.vault.mysql.role |
凭证的 Role name (角色名称)。 |
|
spring.cloud.vault.mysql.username-property |
|
Target 属性。 |
spring.cloud.vault.命名空间 |
Vault 命名空间(需要 Vault Enterprise)。 |
|
spring.cloud.vault.pcf.instance-certificate |
实例证书 (PEM) 的路径。默认为 {@code CF_INSTANCE_CERT} env 变量。 |
|
spring.cloud.vault.pcf.instance-key |
实例密钥 (PEM) 的路径。默认为 {@code CF_INSTANCE_KEY} env 变量。 |
|
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 |
|
Target 属性。 |
spring.cloud.vault.postgresql.role |
凭证的 Role name (角色名称)。 |
|
spring.cloud.vault.postgresql.username-property |
|
Target 属性。 |
spring.cloud.vault.rabbitmq.backend |
|
RabbitMQ 后端路径。 |
spring.cloud.vault.rabbitmq.enabled |
|
启用 rabbitmq 后端使用。 |
spring.cloud.vault.rabbitmq.password-property |
|
Target 属性。 |
spring.cloud.vault.rabbitmq.role |
凭证的 Role name (角色名称)。 |
|
spring.cloud.vault.rabbitmq.用户名属性 |
|
Target 属性。 |
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店 |
保存证书和私钥的信任存储。 |
|
spring.cloud.vault.ssl.key store 密码 |
用于访问密钥库的密码。 |
|
spring.cloud.vault.ssl.key 店型 |
密钥存储的类型。@since 3.0 |
|
spring.cloud.vault.ssl.信任存储 |
保存 SSL 证书的信任存储。 |
|
spring.cloud.vault.ssl.trust-store-password |
用于访问信任存储的密码。 |
|
spring.cloud.vault.ssl.trust-store-type |
信任存储的类型。@since 3.0 |
|
spring.cloud.vault.token |
静态文件库令牌。如果 {@link #authentication} 为 {@code TOKEN},则为必需。 |
|
spring.cloud.vault.uri |
Vault URI 的 URI 中。可以使用 scheme、host 和 port 进行设置。 |