Fix reference docs links.
This commit is contained in:
Mark Paluch
40
README.adoc
40
README.adoc
@@ -1,5 +1,7 @@
|
||||
// Do not edit this file (e.g. go instead to docs/src/main/asciidoc)
|
||||
|
||||
:docs: http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault.html
|
||||
|
||||
|
||||
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, MongoDB, Consul, AWS and more.
|
||||
|
||||
@@ -10,25 +12,27 @@ Spring Cloud Vault Config provides client-side support for externalized configur
|
||||
Specifically for Spring applications:
|
||||
|
||||
* Retrieve secrets from Vault and initialize Spring Environment with remote property sources
|
||||
* Obtain http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.generic[secrets] secured with SSL
|
||||
* Obtain {docs}#vault.config.backends.generic[secrets] secured with SSL
|
||||
* Generate credentials for
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.mysql[MySQL],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.postgresql[PostgreSQL],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.cassandra[Apache Cassandra],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.mongodb[MongoDB],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.consul[Consul],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.aws[AWS], and http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.rabbitmq[RabbitMQ].
|
||||
* http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.authentication.token[Token],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.authentication.appid[AppId],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.authentication.approle[AppRole],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.authentication.clientcert[Client Certificate],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.authentication.cubbyhole[Cubbyhole], and
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.authentication.awsec2[AWS-EC2] authentication
|
||||
{docs}#vault.config.backends.mysql[MySQL],
|
||||
{docs}#vault.config.backends.postgresql[PostgreSQL],
|
||||
{docs}#vault.config.backends.cassandra[Apache Cassandra],
|
||||
{docs}#vault.config.backends.mongodb[MongoDB],
|
||||
{docs}#vault.config.backends.consul[Consul],
|
||||
{docs}#vault.config.backends.aws[AWS], and {docs}#vault.config.backends.rabbitmq[RabbitMQ].
|
||||
* {docs}#vault.config.authentication.token[Token],
|
||||
{docs}#vault.config.authentication.appid[AppId],
|
||||
{docs}#vault.config.authentication.approle[AppRole],
|
||||
{docs}#vault.config.authentication.clientcert[Client Certificate],
|
||||
{docs}#vault.config.authentication.cubbyhole[Cubbyhole], and
|
||||
{docs}#vault.config.authentication.awsec2[AWS-EC2] authentication
|
||||
* Bootstrap application context: a parent context for the main application that can be trained to do anything
|
||||
|
||||
|
||||
== Quick Start
|
||||
|
||||
:docs: http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault.html
|
||||
|
||||
*Prerequisites*
|
||||
|
||||
To get started with Vault and this guide you need a
|
||||
@@ -214,23 +218,21 @@ 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
|
||||
https://github.com/spring-cloud/spring-cloud-vault-config/blob/master/docs/src/main/asciidoc/spring-cloud-vault-config.adoc#vault-client-ssl-configuration[SSL] and
|
||||
https://github.com/spring-cloud/spring-cloud-vault-config/blob/master/docs/src/main/asciidoc/spring-cloud-vault-config.adoc#token-authentication[authentication]. Checkout these
|
||||
chapters in the
|
||||
https://github.com/spring-cloud/spring-cloud-vault-config/blob/master/docs/src/main/asciidoc/spring-cloud-vault-config.adoc[reference guide].
|
||||
{docs}#vault.config.ssl[SSL] and
|
||||
{docs}#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.
|
||||
|
||||
The vault health indicator can be enabled or disabled through the
|
||||
property `health.vault.enabled` (default `true`)
|
||||
property `health.vault.enabled` (default `true`).
|
||||
|
||||
|
||||
=== 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].
|
||||
|
||||
Spring Cloud Vault Config supports multiple http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.authentication[authentication mechanisms] to authenticate applications with Vault.
|
||||
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>>.
|
||||
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
:docs: http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault.html
|
||||
|
||||
include::intro.adoc[]
|
||||
|
||||
@@ -8,20 +9,20 @@ include::intro.adoc[]
|
||||
Specifically for Spring applications:
|
||||
|
||||
* Retrieve secrets from Vault and initialize Spring Environment with remote property sources
|
||||
* Obtain http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.generic[secrets] secured with SSL
|
||||
* Obtain {docs}#vault.config.backends.generic[secrets] secured with SSL
|
||||
* Generate credentials for
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.mysql[MySQL],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.postgresql[PostgreSQL],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.cassandra[Apache Cassandra],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.mongodb[MongoDB],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.consul[Consul],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.aws[AWS], and http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.backends.rabbitmq[RabbitMQ].
|
||||
* http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.authentication.token[Token],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.authentication.appid[AppId],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.authentication.approle[AppRole],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.authentication.clientcert[Client Certificate],
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.authentication.cubbyhole[Cubbyhole], and
|
||||
http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.authentication.awsec2[AWS-EC2] authentication
|
||||
{docs}#vault.config.backends.mysql[MySQL],
|
||||
{docs}#vault.config.backends.postgresql[PostgreSQL],
|
||||
{docs}#vault.config.backends.cassandra[Apache Cassandra],
|
||||
{docs}#vault.config.backends.mongodb[MongoDB],
|
||||
{docs}#vault.config.backends.consul[Consul],
|
||||
{docs}#vault.config.backends.aws[AWS], and {docs}#vault.config.backends.rabbitmq[RabbitMQ].
|
||||
* {docs}#vault.config.authentication.token[Token],
|
||||
{docs}#vault.config.authentication.appid[AppId],
|
||||
{docs}#vault.config.authentication.approle[AppRole],
|
||||
{docs}#vault.config.authentication.clientcert[Client Certificate],
|
||||
{docs}#vault.config.authentication.cubbyhole[Cubbyhole], and
|
||||
{docs}#vault.config.authentication.awsec2[AWS-EC2] authentication
|
||||
* Bootstrap application context: a parent context for the main application that can be trained to do anything
|
||||
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
:docs: http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault.html
|
||||
|
||||
*Prerequisites*
|
||||
|
||||
To get started with Vault and this guide you need a
|
||||
@@ -183,23 +185,21 @@ 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
|
||||
https://github.com/spring-cloud/spring-cloud-vault-config/blob/master/docs/src/main/asciidoc/spring-cloud-vault-config.adoc#vault-client-ssl-configuration[SSL] and
|
||||
https://github.com/spring-cloud/spring-cloud-vault-config/blob/master/docs/src/main/asciidoc/spring-cloud-vault-config.adoc#token-authentication[authentication]. Checkout these
|
||||
chapters in the
|
||||
https://github.com/spring-cloud/spring-cloud-vault-config/blob/master/docs/src/main/asciidoc/spring-cloud-vault-config.adoc[reference guide].
|
||||
{docs}#vault.config.ssl[SSL] and
|
||||
{docs}#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.
|
||||
|
||||
The vault health indicator can be enabled or disabled through the
|
||||
property `health.vault.enabled` (default `true`)
|
||||
property `health.vault.enabled` (default `true`).
|
||||
|
||||
|
||||
=== 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].
|
||||
|
||||
Spring Cloud Vault Config supports multiple http://cloud.spring.io/spring-cloud-vault/spring-cloud-vault-config.html#vault.config.authentication[authentication mechanisms] to authenticate applications with Vault.
|
||||
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>>.
|
||||
|
||||
|
||||
@@ -523,7 +523,7 @@ spring.cloud.vault:
|
||||
* `username-property` sets the property name in which the RabbitMQ username is stored
|
||||
* `password-property` sets the property name in which the RabbitMQ password is stored
|
||||
|
||||
See also: https://www.vaultproject.io/docs/secrets/rabbit/index.html[Vault Documentation: Setting up RabbitMQ with Vault]
|
||||
See also: https://www.vaultproject.io/docs/secrets/rabbitmq/index.html[Vault Documentation: Setting up RabbitMQ with Vault]
|
||||
|
||||
[[vault.config.backends.aws]]
|
||||
=== AWS
|
||||
|
||||
Reference in New Issue
Block a user