Common application properties

可以直接在您的 application.properties 文件中、在您的 application.yml 文件中、或作为命令行开关来指定一些属性。本附录提供了一些常见的 {project-full-name} 属性及其被它们所使用的底层类的引用。

属性贡献可以来自类路径上的其他 jar 文件,因此你不应该将此视为一份详尽的清单。此外,你可以定义自己的属性。

Name Default Description

spring.cloud.vault.app-id.app-id-path

app-id

AppId 认证后端的挂载路径。

spring.cloud.vault.app-id.network-interface

适用于“MAC_ADDRESS”的用户 ID 机制的网络接口提示。

spring.cloud.vault.app-id.user-id

MAC_ADDRESS

用户 ID 机制。可以是“MAC_ADDRESS”、“IP_ADDRESS”,也可以是字符串或类名。

spring.cloud.vault.app-role.app-role-path

approle

AppRole 身份验证后端的装载路径。

spring.cloud.vault.app-role.role

角色名,为可选,用于拉取模式。

spring.cloud.vault.app-role.role-id

The RoleId.

spring.cloud.vault.app-role.secret-id

The SecretId.

spring.cloud.vault.application-name

application

AppId 身份验证的应用程序名。

spring.cloud.vault.authentication

spring.cloud.vault.aws-ec2.aws-ec2-path

aws-ec2

AWS EC2 身份验证后端的装载路径。

spring.cloud.vault.aws-ec2.identity-document

http://169.254.169.254/latest/dynamic/instance-identity/pkcs7

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

AWS 身份验证后端的装载路径。

spring.cloud.vault.aws-iam.endpoint-uri

STS 服务器 URI。@since 2.2

spring.cloud.vault.aws-iam.region

区域名,为可选。如果不设置,则通过 AWS 默认设置进行推断。@自 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

cloud.aws.credentials.accessKey

已获取访问密钥的目标属性。

spring.cloud.vault.aws.backend

aws

aws backend path.

spring.cloud.vault.aws.credential-type

aws credential type

spring.cloud.vault.aws.enabled

false

Enable aws backend usage.

spring.cloud.vault.aws.role

Role name for credentials.

spring.cloud.vault.aws.role-arn

对于与 Vault 角色关联的多个角色,在 assume_role 中的角色 ARN。@since 3.0.2

spring.cloud.vault.aws.secret-key-property

cloud.aws.credentials.secretKey

已获取密钥的目标属性。

spring.cloud.vault.aws.session-token-key-property

cloud.aws.credentials.sessionToken

已获取密钥的目标属性。

spring.cloud.vault.aws.ttl

0

STS 令牌的 TTL。默认值为 Vault 角色的 Max 所设定的值。也受到 AWS 对 STS 最长的支持值的限制。@since 3.0.2

spring.cloud.vault.azure-msi.azure-path

azure

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

Name of the role.

spring.cloud.vault.cassandra.backend

cassandra

Cassandra backend path.

spring.cloud.vault.cassandra.enabled

false

Enable cassandra backend usage.

spring.cloud.vault.cassandra.password-property

spring.data.cassandra.password

已获取密码的目标属性。

spring.cloud.vault.cassandra.role

Role name for credentials.

spring.cloud.vault.cassandra.static-role

false

启用静态角色使用。@since 2.2

spring.cloud.vault.cassandra.username-property

spring.data.cassandra.username

已获取用户名的目标属性。

spring.cloud.vault.config.lifecycle.enabled

true

Enable lifecycle management.

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.lease-strategy

将 {@link LeaseStrategy} 设置为与 {@link org.springframework.vault.core.lease.SecretLeaseContainer#setLeaseStrategy(LeaseStrategy)} 一起使用,以在续订错误时保留或丢弃令牌。@since 4.1

spring.cloud.vault.config.lifecycle.min-renewal

在续订租约之前至少需要的时间段。@since 2.2

spring.cloud.vault.config.order

0

用于设置 {@link org.springframework.core.env.PropertySource} 优先级。这对将 Vault 用作其他属性源的覆盖很有用。@see org.springframework.core.PriorityOrdered

spring.cloud.vault.connection-timeout

5000

Connection timeout.

spring.cloud.vault.consul.backend

consul

Consul backend path.

spring.cloud.vault.consul.enabled

false

Enable consul backend usage.

spring.cloud.vault.consul.role

Role name for credentials.

spring.cloud.vault.consul.token-property

spring.cloud.consul.token

获取令牌的目标属性。

spring.cloud.vault.couchbase.backend

database

Couchbase backend path.

spring.cloud.vault.couchbase.enabled

false

Enable couchbase backend usage.

spring.cloud.vault.couchbase.password-property

spring.couchbase.password

已获取密码的目标属性。

spring.cloud.vault.couchbase.role

Role name for credentials.

spring.cloud.vault.couchbase.static-role

false

Enable static role usage.

spring.cloud.vault.couchbase.username-property

spring.couchbase.username

已获取用户名的目标属性。

spring.cloud.vault.database.backend

database

Database backend path.

spring.cloud.vault.database.enabled

false

Enable database backend usage.

spring.cloud.vault.database.password-property

spring.datasource.password

已获取密码的目标属性。

spring.cloud.vault.database.role

Role name for credentials.

spring.cloud.vault.database.static-role

false

Enable static role usage.

spring.cloud.vault.database.username-property

spring.datasource.username

已获取用户名的目标属性。

spring.cloud.vault.databases

spring.cloud.vault.discovery.enabled

false

标志,用于指示启用了 Vault 服务器发现(将通过发现查找 Vault 服务器 URL)。

spring.cloud.vault.discovery.service-id

vault

用于定位 Vault 的服务 ID。

spring.cloud.vault.elasticsearch.backend

database

Database backend path.

spring.cloud.vault.elasticsearch.enabled

false

Enable elasticsearch backend usage.

spring.cloud.vault.elasticsearch.password-property

spring.elasticsearch.rest.password

已获取密码的目标属性。

spring.cloud.vault.elasticsearch.role

Role name for credentials.

spring.cloud.vault.elasticsearch.static-role

false

Enable static role usage.

spring.cloud.vault.elasticsearch.username-property

spring.elasticsearch.rest.username

已获取用户名的目标属性。

spring.cloud.vault.enabled

true

Enable Vault config server.

spring.cloud.vault.fail-fast

false

如果无法从 Vault 获取数据,则快速失败。

spring.cloud.vault.gcp-gce.gcp-path

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

OAuth2 帐户私钥的 base64 编码内容,采用 JSON 格式。

spring.cloud.vault.gcp-iam.credentials.location

OAuth2 凭证私钥的位置。<p>由于这是一个资源,因此私钥可以位于多种位置,例如本地文件系统、类路径、URL 等。

spring.cloud.vault.gcp-iam.gcp-path

gcp

Kubernetes 身份验证后端的挂载路径。

spring.cloud.vault.gcp-iam.jwt-validity

15m

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

localhost

Vault server host.

spring.cloud.vault.kubernetes.kubernetes-path

kubernetes

Kubernetes 身份验证后端的挂载路径。

spring.cloud.vault.kubernetes.role

尝试登录的角色名称。

spring.cloud.vault.kubernetes.service-account-token-file

/var/run/secrets/kubernetes.io/serviceaccount/token

指向服务帐号令牌文件的路径。

spring.cloud.vault.kv.application-name

application

将用于上下文的应用程序名称。

spring.cloud.vault.kv.backend

secret

默认后端的名称。

spring.cloud.vault.kv.backend-version

2

键值后端版本。目前支持的版本有:<ul> <li>版本 1(无版本键值后端)。</li> <li>版本 2(有版本键值后端)。</li> </ul>

spring.cloud.vault.kv.default-context

application

默认上下文的名称。

spring.cloud.vault.kv.enabled

true

Enable the key-value backend.

spring.cloud.vault.kv.profile-separator

/

配置文件分隔符合并应用程序名称和配置文件。

spring.cloud.vault.kv.profiles

活动配置文件列表。@since 3.0

spring.cloud.vault.mongodb.backend

mongodb

MongoDB backend path.

spring.cloud.vault.mongodb.enabled

false

Enable mongodb backend usage.

spring.cloud.vault.mongodb.password-property

spring.data.mongodb.password

已获取密码的目标属性。

spring.cloud.vault.mongodb.role

Role name for credentials.

spring.cloud.vault.mongodb.static-role

false

启用静态角色使用。@since 2.2

spring.cloud.vault.mongodb.username-property

spring.data.mongodb.username

已获取用户名的目标属性。

spring.cloud.vault.mysql.backend

mysql

mysql backend path.

spring.cloud.vault.mysql.enabled

false

Enable mysql backend usage.

spring.cloud.vault.mysql.password-property

spring.datasource.password

已获取用户名的目标属性。

spring.cloud.vault.mysql.role

Role name for credentials.

spring.cloud.vault.mysql.username-property

spring.datasource.username

已获取用户名的目标属性。

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

pcf

Kubernetes 身份验证后端的挂载路径。

spring.cloud.vault.pcf.role

尝试登录的角色名称。

spring.cloud.vault.port

8200

Vault server port.

spring.cloud.vault.postgresql.backend

postgresql

postgresql backend path.

spring.cloud.vault.postgresql.enabled

false

Enable postgresql backend usage.

spring.cloud.vault.postgresql.password-property

spring.datasource.password

已获取用户名的目标属性。

spring.cloud.vault.postgresql.role

Role name for credentials.

spring.cloud.vault.postgresql.username-property

spring.datasource.username

已获取用户名的目标属性。

spring.cloud.vault.rabbitmq.backend

rabbitmq

rabbitmq backend path.

spring.cloud.vault.rabbitmq.enabled

false

Enable rabbitmq backend usage.

spring.cloud.vault.rabbitmq.password-property

spring.rabbitmq.password

已获取密码的目标属性。

spring.cloud.vault.rabbitmq.role

Role name for credentials.

spring.cloud.vault.rabbitmq.username-property

spring.rabbitmq.username

已获取用户名的目标属性。

spring.cloud.vault.reactive.enabled

true

标志,表示启用反应式发现

spring.cloud.vault.read-timeout

15000

Read timeout.

spring.cloud.vault.scheme

https

协议方案。可以是 “http” 或 “https”。

spring.cloud.vault.session.lifecycle.enabled

true

Enable session lifecycle management.

spring.cloud.vault.session.lifecycle.expiry-threshold

7s

{@link LoginToken} 的过期阈值。该阈值代表将登录令牌视为有效的最小 TTL 持续时间。TTL 较短的令牌将被视为已过期,不再使用。应大于 {@code refreshBeforeExpiry} 以防令牌过期。

spring.cloud.vault.session.lifecycle.refresh-before-expiry

5s

续订 {@link LoginToken} 之前至少需要的时间段。

spring.cloud.vault.ssl.cert-auth-path

cert

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

静态保管库令牌。如果 {@link #authentication} 为 {@code TOKEN},则需要。

spring.cloud.vault.uri

Vault URI。可以设置方案、主机和端口。