Fix cross references

This commit is contained in:
spencergibb
2023-09-14 10:41:54 -04:00
parent 2bbb19c653
commit 19e9039ceb
5 changed files with 18 additions and 18 deletions

View File

@@ -167,7 +167,7 @@ See also: https://www.vaultproject.io/docs/auth/app-id.html[Vault Documentation:
[[approle-authentication]]
== AppRole authentication
https://www.vaultproject.io/docs/auth/app-id.html[AppRole] is intended for machine authentication, like the deprecated (since Vault 0.6.1) <<vault.config.authentication.appid>>.
https://www.vaultproject.io/docs/auth/app-id.html[AppRole] is intended for machine authentication, like the deprecated (since Vault 0.6.1) xref:authentication.adoc#vault.config.authentication.appid[AppId authentication].
AppRole authentication consists of two hard to guess (secret) tokens: RoleId and SecretId.
Spring Vault supports various AppRole scenarios (push/pull mode and wrapped).
@@ -415,7 +415,7 @@ The `cert` auth backend allows authentication using SSL/TLS client certificates
To enable `cert` authentication you need to:
1. Use SSL, see <<vault.config.ssl>>
1. Use SSL, see xref:other-topics.adoc#vault.config.ssl[Vault Client SSL configuration]
2. Configure a Java `Keystore` that contains the client certificate and the private key
3. Set the `spring.cloud.vault.authentication` to `CERT`

View File

@@ -19,12 +19,12 @@ Spring Cloud Vault supports two config locations:
* `vault://` (default location)
* `vault:///<context-path>` (contextual location)
Using the default location mounts property sources for all enabled <<vault.config.backends>>.
Using the default location mounts property sources for all enabled xref:secret-backends.adoc[Secret Backends].
Without further configuration, Spring Cloud Vault mounts the key-value backend at `/secret/${spring.application.name}`.
Each activated profile adds another context path following the form `/secret/${spring.application.name}/${profile}`.
Adding further modules to the classpath, such as `spring-cloud-config-databases`, provides additional secret backend configuration options which get mounted as property sources if enabled.
If you want to control which context paths are mounted from Vault as `PropertySource`, you can either use a contextual location (`vault:///my/context/path`) or configure a <<vault.config.backends.configurer,`VaultConfigurer`>>.
If you want to control which context paths are mounted from Vault as `PropertySource`, you can either use a contextual location (`vault:///my/context/path`) or configure a xref:secret-backends.adoc#vault.config.backends.configurer[`VaultConfigurer`].
Contextual locations are specified and mounted individually.
Spring Cloud Vault mounts each location as a unique `PropertySource`.
@@ -65,7 +65,7 @@ In some cases, it can be required to launch an application without Vault. You ca
Optional locations are skipped during application startup if Vault support was disabled through `spring.cloud.vault.enabled=false`.
NOTE: Vault context paths that cannot be found (HTTP Status 404) are skipped regardless of whether the config location is marked optional. <<vault.config.fail-fast>> allows failing on start if a Vault context path cannot be found because of HTTP Status 404.
NOTE: Vault context paths that cannot be found (HTTP Status 404) are skipped regardless of whether the config location is marked optional. xref:other-topics.adoc#vault.config.fail-fast[Vault Client Fail Fast] allows failing on start if a Vault context path cannot be found because of HTTP Status 404.
[[vault.configdata.customization]]
@@ -109,4 +109,4 @@ application.addBootstrapRegistryInitializer(registry -> registry.register(RestTe
----
====
See also <<vault.config.backends.configurer>> and the source of `VaultConfigDataLoader` for customization hooks.
See also xref:secret-backends.adoc#vault.config.backends.configurer[Customize which secret backends to expose as PropertySource] and the source of `VaultConfigDataLoader` for customization hooks.

View File

@@ -6,8 +6,8 @@ This section briefly covers items that are new and noteworthy in the latest rele
[[new-in-3.0.0]]
== New in Spring Cloud Vault 3.0
* Migration of `PropertySource` initialization from Spring Cloud's Bootstrap Context to Spring Boot's <<vault.configdata,ConfigData API>>.
* Support for the <<vault.config.backends.couchbase>> backend.
* Migration of `PropertySource` initialization from Spring Cloud's Bootstrap Context to Spring Boot's xref:config-data.adoc[ConfigData API].
* Support for the xref:secret-backends.adoc#vault.config.backends.couchbase[Couchbase Database] backend.
* Configuration of keystore/truststore types through `spring.cloud.vault.ssl.key-store-type=…`/`spring.cloud.vault.ssl.trust-store-type=…` including PEM support.
* Support for `ReactiveDiscoveryClient` by configuring a `ReactiveVaultEndpointProvider`.
* Support to configure <<vault.config.backends.databases>>.
* Support to configure xref:secret-backends.adoc#vault.config.backends.databases[Multiple Databases].

View File

@@ -229,7 +229,7 @@ If the application imports the `spring-boot-starter-actuator` project, the statu
The vault health indicator can be enabled or disabled through the property `management.health.vault.enabled` (default to `true`).
NOTE: With Spring Cloud Vault 3.0 and Spring Boot 2.4, the bootstrap context initialization (`bootstrap.yml`, `bootstrap.properties`) of property sources was deprecated.
Instead, Spring Cloud Vault favors Spring Boot's Config Data API which allows importing configuration from Vault. With Spring Boot Config Data approach, you need to set the `spring.config.import` property in order to bind to Vault. You can read more about it in the <<vault.configdata.locations, Config Data Locations section>>.
Instead, Spring Cloud Vault favors Spring Boot's Config Data API which allows importing configuration from Vault. With Spring Boot Config Data approach, you need to set the `spring.config.import` property in order to bind to Vault. You can read more about it in the xref:config-data.adoc#vault.configdata.locations[Config Data Locations section].
You can enable the bootstrap context either by setting the configuration property `spring.cloud.bootstrap.enabled=true` or by including the dependency `org.springframework.cloud:spring-cloud-starter-bootstrap`.
[[authentication]]
@@ -239,7 +239,7 @@ Vault requires an https://www.vaultproject.io/docs/concepts/auth.html[authentica
Spring Cloud Vault supports multiple {docs}#vault.config.authentication[authentication mechanisms] to authenticate applications with Vault.
For a quickstart, use the root token printed by the <<quickstart.vault.start,Vault initialization>>.
For a quickstart, use the root token printed by the xref:quickstart.adoc#quickstart.vault.start[Vault initialization].
.application.yml
====

View File

@@ -263,13 +263,13 @@ This means services that need to access a database no longer need to configure c
Spring Cloud Vault integrates with these backends:
* <<vault.config.backends.database>>
* <<vault.config.backends.cassandra>>
* <<vault.config.backends.couchbase>>
* <<vault.config.backends.elasticsearch>>
* <<vault.config.backends.mongodb>>
* <<vault.config.backends.mysql>>
* <<vault.config.backends.postgresql>>
* xref:secret-backends.adoc#vault.config.backends.database[Database]
* xref:secret-backends.adoc#vault.config.backends.cassandra[Apache Cassandra]
* xref:secret-backends.adoc#vault.config.backends.couchbase[Couchbase Database]
* xref:secret-backends.adoc#vault.config.backends.elasticsearch[Elasticsearch]
* xref:secret-backends.adoc#vault.config.backends.mongodb[MongoDB]
* xref:secret-backends.adoc#vault.config.backends.mysql[MySQL]
* xref:secret-backends.adoc#vault.config.backends.postgresql[PostgreSQL]
Using a database secret backend requires to enable the backend in the configuration and the `spring-cloud-vault-config-databases`
dependency.