diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index cd40339d..7fe4bd26 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -1,8 +1,7 @@ -* xref:index.adoc[Introduction] -* xref:new-features.adoc[] +* xref:index.adoc[Overview] * xref:quickstart.adoc[] * xref:config-data.adoc[] * xref:authentication.adoc[] * xref:secret-backends.adoc[] -* xref:other-topics.adoc[] +* xref:advanced-topics.adoc[Advanced Topics] * xref:appendix.adoc[] diff --git a/docs/modules/ROOT/pages/other-topics.adoc b/docs/modules/ROOT/pages/advanced-topics.adoc similarity index 100% rename from docs/modules/ROOT/pages/other-topics.adoc rename to docs/modules/ROOT/pages/advanced-topics.adoc diff --git a/docs/modules/ROOT/pages/authentication.adoc b/docs/modules/ROOT/pages/authentication.adoc index 9e4fd3dc..0ed53077 100644 --- a/docs/modules/ROOT/pages/authentication.adoc +++ b/docs/modules/ROOT/pages/authentication.adoc @@ -385,7 +385,7 @@ The `cert` auth backend allows authentication using SSL/TLS client certificates To enable `cert` authentication you need to: -1. Use SSL, see xref:other-topics.adoc#vault.config.ssl[Vault Client SSL configuration] +1. Use SSL, see xref:advanced-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` diff --git a/docs/modules/ROOT/pages/config-data.adoc b/docs/modules/ROOT/pages/config-data.adoc index f094f9df..123a3cd3 100644 --- a/docs/modules/ROOT/pages/config-data.adoc +++ b/docs/modules/ROOT/pages/config-data.adoc @@ -63,7 +63,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. 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. +NOTE: Vault context paths that cannot be found (HTTP Status 404) are skipped regardless of whether the config location is marked optional. xref:advanced-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]] diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index 58168dfb..ae00c184 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -1 +1,21 @@ -include::intro.adoc[] \ No newline at end of file += Spring Cloud Vault +:feature-scroll: true + +Spring Cloud Vault Config provides client-side support for externalized configuration in a distributed system built on top of https://docs.spring.io/spring-vault/reference/[Spring Vault]. +With https://www.vaultproject.io[HashiCorp's Vault] you have a central place to manage external secret properties for applications across all environments. +Vault can manage static and dynamic secrets such as username/password for remote applications/resources and provide credentials for external services such as MySQL, PostgreSQL, Apache Cassandra, Couchbase, MongoDB, Consul, AWS and more. + + + + + +[horizontal] +xref:config-data.adoc[Config Data API] :: Application Configuration using Vault Secrets +xref:authentication.adoc[Authentication] :: Configuring Authentication with Vault +xref:secret-backends.adoc[Secret Backends] :: Mounting Secret Backends +xref:advanced-topics.adoc[Advanced Topics] :: Service Discovery, Fail-Fast, SSL Configuration, Lifecycle Management + +Mark Paluch, Jay Bryant, Spencer Gibb + +(C) 2008-2023 VMware, Inc. + +Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically. + diff --git a/docs/modules/ROOT/pages/intro.adoc b/docs/modules/ROOT/pages/intro.adoc deleted file mode 100644 index 9d6514e6..00000000 --- a/docs/modules/ROOT/pages/intro.adoc +++ /dev/null @@ -1,3 +0,0 @@ -Spring Cloud Vault Config provides client-side support for externalized configuration in a distributed system. -With https://www.vaultproject.io[HashiCorp's Vault] you have a central place to manage external secret properties for applications across all environments. -Vault can manage static and dynamic secrets such as username/password for remote applications/resources and provide credentials for external services such as MySQL, PostgreSQL, Apache Cassandra, Couchbase, MongoDB, Consul, AWS and more. diff --git a/docs/modules/ROOT/pages/new-features.adoc b/docs/modules/ROOT/pages/new-features.adoc deleted file mode 100644 index 5865f5ef..00000000 --- a/docs/modules/ROOT/pages/new-features.adoc +++ /dev/null @@ -1,14 +0,0 @@ -[[new-noteworthy]] -= New & Noteworthy -:page-section-summary-toc: 1 - -This section briefly covers items that are new and noteworthy in the latest releases. - -[[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 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 xref:secret-backends.adoc#vault.config.backends.databases[Multiple Databases]. diff --git a/docs/modules/ROOT/pages/quickstart.adoc b/docs/modules/ROOT/pages/quickstart.adoc index 434eb34c..99ff4aa8 100644 --- a/docs/modules/ROOT/pages/quickstart.adoc +++ b/docs/modules/ROOT/pages/quickstart.adoc @@ -1,7 +1,9 @@ [[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: @@ -21,9 +23,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`) @@ -36,7 +38,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: @@ -139,7 +141,7 @@ Example Maven configuration: org.springframework.boot spring-boot-starter-parent - 2.4.0.RELEASE + $\{springBootVersion} @@ -216,7 +218,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. @@ -232,7 +234,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].