diff --git a/docs/modules/ROOT/pages/README.adoc b/docs/modules/ROOT/pages/README.adoc index 4f74e3d2..d1bf91de 100644 --- a/docs/modules/ROOT/pages/README.adoc +++ b/docs/modules/ROOT/pages/README.adoc @@ -2,8 +2,10 @@ include::intro.adoc[] +[[features]] == Features +[[spring-cloud-vault-config-client]] === Spring Cloud Vault Config Client Specifically for Spring applications: @@ -28,12 +30,15 @@ Specifically for Spring applications: * Bootstrap application context: a parent context for the main application that can be trained to do anything. +[[quick-start]] == Quick Start include::quickstart.adoc[] +[[building]] == Building +[[build-requirements-for-vault]] === Build requirements for Vault Spring Cloud Vault Config requires SSL certificates and a running Vault instance listening on `localhost:8200`. @@ -64,6 +69,7 @@ This script requires ruby and the asciidoctor gem installed (`gem install asciid include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/building.adoc[] +[[contributing]] == Contributing include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[] diff --git a/docs/modules/ROOT/pages/_configprops.adoc b/docs/modules/ROOT/pages/_configprops.adoc index c63e2b7a..0a77b628 100644 --- a/docs/modules/ROOT/pages/_configprops.adoc +++ b/docs/modules/ROOT/pages/_configprops.adoc @@ -137,4 +137,4 @@ |spring.cloud.vault.token | | Static vault token. Required if {@link #authentication} is {@code TOKEN}. |spring.cloud.vault.uri | | Vault URI. Can be set with scheme, host and port. -|=== \ No newline at end of file +|=== diff --git a/docs/modules/ROOT/pages/authentication.adoc b/docs/modules/ROOT/pages/authentication.adoc index 3579e077..ed725d7c 100644 --- a/docs/modules/ROOT/pages/authentication.adoc +++ b/docs/modules/ROOT/pages/authentication.adoc @@ -125,6 +125,7 @@ $ echo -n 0AFEDE1234AC | sha256sum NOTE: The Mac address is specified uppercase and without colons. Including the line break of `echo` leads to a different hash value so make sure to include the `-n` flag. +[[custom-userid]] ==== Custom UserId The UserId generation is an open mechanism. @@ -163,6 +164,7 @@ public class MyUserIdMechanism implements AppIdUserIdMechanism { See also: https://www.vaultproject.io/docs/auth/app-id.html[Vault Documentation: Using the App ID auth backend] +[[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) <>. @@ -690,14 +692,17 @@ This section explains which paths are accessed by Spring Vault so you can derive See also https://www.vaultproject.io/guides/identity/policies. +[[authentication]] === Authentication Login: `POST auth/$authMethod/login` +[[keyvalue-mount-discovery]] === KeyValue Mount Discovery `GET sys/internal/ui/mounts/$mountPath` +[[secretleasecontainer]] === SecretLeaseContainer `SecretLeaseContainer` uses different paths depending on the configured lease endpoint. @@ -712,6 +717,7 @@ Login: `POST auth/$authMethod/login` * Revocation: `PUT sys/leases/revoke` * Renewal: `PUT sys/leases/renew` +[[session-management]] === Session Management * Token lookup: `GET auth/token/lookup-self` diff --git a/docs/modules/ROOT/pages/new-features.adoc b/docs/modules/ROOT/pages/new-features.adoc index 0684ccc8..07ad1832 100644 --- a/docs/modules/ROOT/pages/new-features.adoc +++ b/docs/modules/ROOT/pages/new-features.adoc @@ -1,3 +1,4 @@ +[[new-noteworthy]] == New & Noteworthy This section briefly covers items that are new and noteworthy in the latest releases. diff --git a/docs/modules/ROOT/pages/other-topics.adoc b/docs/modules/ROOT/pages/other-topics.adoc index 67ef84e6..821d67e1 100644 --- a/docs/modules/ROOT/pages/other-topics.adoc +++ b/docs/modules/ROOT/pages/other-topics.adoc @@ -1,3 +1,4 @@ +[[service-registry-configuration]] == Service Registry Configuration You can use a `DiscoveryClient` (such as from Spring Cloud Consul) to locate a Vault server by setting spring.cloud.vault.discovery.enabled=true (default `false`). diff --git a/docs/modules/ROOT/pages/quickstart.adoc b/docs/modules/ROOT/pages/quickstart.adoc index 755be787..2e8b83df 100644 --- a/docs/modules/ROOT/pages/quickstart.adoc +++ b/docs/modules/ROOT/pages/quickstart.adoc @@ -126,6 +126,7 @@ where the "application" is injected as the `spring.application.name` in the `SpringApplication` (i.e. what is normally "application" in a regular Spring Boot app), "profile" is an active profile (or comma-separated list of properties). Properties retrieved from Vault will be used "as-is" without further prefixing of the property names. +[[client-side-usage]] == Client Side Usage To use these features in an application, just build it as a Spring Boot application that depends on `spring-cloud-vault-config` (e.g. see the test cases). @@ -231,6 +232,7 @@ NOTE: With Spring Cloud Vault 3.0 and Spring Boot 2.4, the bootstrap context ini 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 <>. 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]] === Authentication Vault requires an https://www.vaultproject.io/docs/concepts/auth.html[authentication mechanism] to https://www.vaultproject.io/docs/concepts/tokens.html[authorize client requests]. diff --git a/docs/modules/ROOT/pages/spring-cloud-vault.adoc b/docs/modules/ROOT/pages/spring-cloud-vault.adoc index 42cb1093..bc5e7e46 100644 --- a/docs/modules/ROOT/pages/spring-cloud-vault.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-vault.adoc @@ -1,3 +1,4 @@ +[[spring-cloud-vault]] = Spring Cloud Vault :github: https://github.com/spring-cloud/spring-cloud-vault :githubmaster: {github}/tree/master @@ -16,6 +17,7 @@ include::_attributes.adoc[] include::new-features.adoc[] +[[quick-start]] == Quick Start include::quickstart.adoc[]