常用應用程式屬性
各種屬性可以在您的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。可以設定方案、主機和埠。 |