diff --git a/README.adoc b/README.adoc index c431660a..11dfa533 100644 --- a/README.adoc +++ b/README.adoc @@ -15,6 +15,7 @@ Edit the files in the src/main/asciidoc/ directory instead. Specifically for Spring applications: +// TODO: fix links * Retrieve secrets from Vault and initialize Spring Environment with remote property sources. * Obtain {docs}#vault.config.backends.kv[Key-Value secrets] secured with SSL. * Generate credentials for @@ -38,7 +39,9 @@ Specifically for Spring applications: [[quick-start]] = Quick Start -*Prerequisites* +This section explains how to get you started with Vault and Spring Cloud Vault. + +== Prerequisites To get started with Vault and this guide you need a *NIX-like operating systems that provides: @@ -58,9 +61,9 @@ $ unzip vault_${vault_version}_${platform}.zip NOTE: These steps can be achieved by downloading and running https://github.com/spring-cloud/spring-cloud-vault/blob/master/src/test/bash/install_vault.sh[`install_vault.sh`]. -*Create SSL certificates for Vault* +== Create SSL certificates for Vault -Next, you'r required to generate a set of certificates: +Next, you're required to generate a set of certificates: * Root CA * Vault Certificate (decrypted key `work/ca/private/localhost.decrypted.key.pem` and certificate `work/ca/certs/localhost.cert.pem`) @@ -73,7 +76,7 @@ NOTE: https://github.com/spring-cloud/spring-cloud-vault/blob/master/src/test/ba If you want to run Spring Cloud Vault using this quickstart guide you need to configure the truststore the `spring.cloud.vault.ssl.trust-store` property to `file:work/keystore.jks`. [[quickstart.vault.start]] -*Start Vault server* +== Start Vault server Next create a config file along the lines of: @@ -176,7 +179,7 @@ Example Maven configuration: org.springframework.boot spring-boot-starter-parent - 2.4.0.RELEASE + $\{springBootVersion} @@ -253,7 +256,7 @@ Supported schemes are `http` and `https`. Enabling further integrations requires additional dependencies and configuration. Depending on how you have set up Vault you might need additional configuration like -xref:other-topics.adoc#vault.config.ssl[SSL] and +xref:advanced-topics.adoc#vault.config.ssl[SSL] and xref:authentication.adoc#vault.config.authentication[authentication]. If the application imports the `spring-boot-starter-actuator` project, the status of the vault server will be available via the `/health` endpoint. @@ -269,7 +272,7 @@ You can enable the bootstrap context either by setting the configuration propert 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]. -Spring Cloud Vault supports multiple xref:authentication.adoc#vault.config.authentication[authentication mechanisms] to authenticate applications with Vault. +Spring Cloud Vault supports multiple xref:authentication.adoc[authentication mechanisms] to authenticate applications with Vault. For a quickstart, use the root token printed by the xref:quickstart.adoc#quickstart.vault.start[Vault initialization].