diff --git a/README.adoc b/README.adoc index 08c03b41..e18f4780 100644 --- a/README.adoc +++ b/README.adoc @@ -4,8 +4,8 @@ Manual changes to this file will be lost when it is generated again. Edit the files in the src/main/asciidoc/ directory instead. //// -:docs: https://cloud.spring.io/spring-cloud-vault/spring-cloud-vault.html +:docs: https://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. @@ -18,7 +18,7 @@ Vault can manage static and dynamic secrets such as username/password for remote Specifically for Spring applications: * Retrieve secrets from Vault and initialize Spring Environment with remote property sources. -* Obtain {docs}#vault.config.backends.generic[secrets] secured with SSL. +* Obtain {docs}#vault.config.backends.kv[Key-Value secrets] secured with SSL. * Generate credentials for {docs}#vault.config.backends.mysql[MySQL], {docs}#vault.config.backends.postgresql[PostgreSQL], @@ -46,35 +46,62 @@ Specifically for Spring applications: To get started with Vault and this guide you need a *NIX-like operating systems that provides: * `wget`, `openssl` and `unzip` -* at least Java 7 and a properly configured `JAVA_HOME` environment variable +* at least Java 8 and a properly configured `JAVA_HOME` environment variable + +NOTE: This guide explains Vault setup from a Spring Cloud Vault perspective for integration testing. +You can find a getting started guide directly on the Vault project site: https://learn.hashicorp.com/vault *Install Vault* [source,bash] ---- -$ src/test/bash/install_vault.sh +$ wget https://releases.hashicorp.com/vault/${vault_version}/vault_${vault_version}_${platform}.zip +$ 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* -[source,bash] ----- -$ src/test/bash/create_certificates.sh ----- +Next, you'r required to generate a set of certificates: -NOTE: `create_certificates.sh` creates certificates in `work/ca` and a JKS truststore `work/keystore.jks`. +* Root CA +* Vault Certificate (decrypted key `work/ca/private/localhost.decrypted.key.pem` and certificate `work/ca/certs/localhost.cert.pem`) + +Make sure to import the Root Certificate into a Java-compliant truststore. + +The easiest way to achieve this is by using OpenSSL. + +NOTE: https://github.com/spring-cloud/spring-cloud-vault/blob/master/src/test/bash/[`create_certificates.sh`] creates certificates in `work/ca` and a JKS truststore `work/keystore.jks`. 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* -[source,bash] +Next create a config file along the lines of: + +[source] ---- -$ src/test/bash/local_run_vault.sh +backend "inmem" { +} + +listener "tcp" { + address = "0.0.0.0:8200" + tls_cert_file = "work/ca/certs/localhost.cert.pem" + tls_key_file = "work/ca/private/localhost.decrypted.key.pem" +} + +disable_mlock = true ---- -Vault is started listening on `0.0.0.0:8200` using the `inmem` storage and -`https`. +NOTE: You can find an example config file at https://github.com/spring-clod/spring-cloud-vault/blob/master/src/test/bash/vault.conf[`vault.conf`]. + +[source,bash] +---- +$ vault server -config=vault.conf +---- + +Vault is started listening on `0.0.0.0:8200` using the `inmem` storage and `https`. Vault is sealed and not initialized when starting up. NOTE: If you want to run tests, leave Vault uninitialized. @@ -298,65 +325,84 @@ This script requires ruby and the asciidoctor gem installed (`gem install asciid To build the source you will need to install JDK {jdkversion}. -Spring Cloud uses Maven for most build-related activities, and you should be able to get off the ground quite quickly by cloning the project you are interested in and typing +Spring Cloud uses Maven for most build-related activities, and you +should be able to get off the ground quite quickly by cloning the +project you are interested in and typing ---- $ ./mvnw install ---- -NOTE: You can also install Maven (>=3.3.3) yourself and run the `mvn` command in place of `./mvnw` in the examples below. -If you do that you also might need to add `-P spring` if your local Maven settings do not contain repository declarations for spring pre-release artifacts. +NOTE: You can also install Maven (>=3.3.3) yourself and run the `mvn` command +in place of `./mvnw` in the examples below. If you do that you also +might need to add `-P spring` if your local Maven settings do not +contain repository declarations for spring pre-release artifacts. -NOTE: Be aware that you might need to increase the amount of memory available to Maven by setting a `MAVEN_OPTS` environment variable with a value like `-Xmx512m -XX:MaxPermSize=128m`. -We try to cover this in the `.mvn` configuration, so if you find you have to do it to make a build succeed, please raise a ticket to get the settings added to source control. +NOTE: Be aware that you might need to increase the amount of memory +available to Maven by setting a `MAVEN_OPTS` environment variable with +a value like `-Xmx512m -XX:MaxPermSize=128m`. We try to cover this in +the `.mvn` configuration, so if you find you have to do it to make a +build succeed, please raise a ticket to get the settings added to +source control. -For hints on how to build the project look in `.travis.yml` if there is one. -There should be a "script" and maybe "install" command. -Also look at the "services" section to see if any services need to be running locally (e.g. mongo or rabbit). -Ignore the git-related bits that you might find in "before_install" since they're related to setting git credentials and you already have those. +For hints on how to build the project look in `.travis.yml` if there +is one. There should be a "script" and maybe "install" command. Also +look at the "services" section to see if any services need to be +running locally (e.g. mongo or rabbit). Ignore the git-related bits +that you might find in "before_install" since they're related to setting git +credentials and you already have those. The projects that require middleware generally include a `docker-compose.yml`, so consider using -https://docs.docker.com/compose/[Docker Compose] to run the middeware servers in Docker containers. -See the README in the +https://docs.docker.com/compose/[Docker Compose] to run the middeware servers +in Docker containers. See the README in the https://github.com/spring-cloud-samples/scripts[scripts demo -repository] for specific instructions about the common cases of mongo, rabbit and redis. +repository] for specific instructions about the common cases of mongo, +rabbit and redis. NOTE: If all else fails, build with the command from `.travis.yml` (usually `./mvnw install`). === Documentation -The spring-cloud-build module has a "docs" profile, and if you switch that on it will try to build asciidoc sources from -`src/main/asciidoc`. -As part of that process it will look for a -`README.adoc` and process it by loading all the includes, but not parsing or rendering it, just copying it to `${main.basedir}` -(defaults to `${basedir}`, i.e. the root of the project). -If there are any changes in the README it will then show up after a Maven build as a modified file in the correct place. -Just commit it and push the change. +The spring-cloud-build module has a "docs" profile, and if you switch +that on it will try to build asciidoc sources from +`src/main/asciidoc`. As part of that process it will look for a +`README.adoc` and process it by loading all the includes, but not +parsing or rendering it, just copying it to `${main.basedir}` +(defaults to `${basedir}`, i.e. the root of the project). If there are +any changes in the README it will then show up after a Maven build as +a modified file in the correct place. Just commit it and push the change. === Working with the code - If you don't have an IDE preference we would recommend that you use https://www.springsource.com/developer/sts[Spring Tools Suite] or -https://eclipse.org[Eclipse] when working with the code. -We use the -https://eclipse.org/m2e/[m2eclipse] eclipse plugin for maven support. -Other IDEs and tools should also work without issue as long as they use Maven 3.3.3 or better. +https://eclipse.org[Eclipse] when working with the code. We use the +https://eclipse.org/m2e/[m2eclipse] eclipse plugin for maven support. Other IDEs and tools +should also work without issue as long as they use Maven 3.3.3 or better. + +==== Activate the Spring Maven profile +Spring Cloud projects require the 'spring' Maven profile to be activated to resolve +the spring milestone and snapshot repositories. Use your preferred IDE to set this +profile to be active, or you may experience build errors. ==== Importing into eclipse with m2eclipse +We recommend the https://eclipse.org/m2e/[m2eclipse] eclipse plugin when working with +eclipse. If you don't already have m2eclipse installed it is available from the "eclipse +marketplace". -We recommend the https://eclipse.org/m2e/[m2eclipse] eclipse plugin when working with eclipse. -If you don't already have m2eclipse installed it is available from the "eclipse marketplace". - -NOTE: Older versions of m2e do not support Maven 3.3, so once the projects are imported into Eclipse you will also need to tell m2eclipse to use the right profile for the projects. -If you see many different errors related to the POMs in the projects, check that you have an up to date installation. -If you can't upgrade m2e, add the "spring" profile to your `settings.xml`. -Alternatively you can copy the repository settings from the "spring" profile of the parent pom into your `settings.xml`. +NOTE: Older versions of m2e do not support Maven 3.3, so once the +projects are imported into Eclipse you will also need to tell +m2eclipse to use the right profile for the projects. If you +see many different errors related to the POMs in the projects, check +that you have an up to date installation. If you can't upgrade m2e, +add the "spring" profile to your `settings.xml`. Alternatively you can +copy the repository settings from the "spring" profile of the parent +pom into your `settings.xml`. ==== Importing into eclipse without m2eclipse - -If you prefer not to use m2eclipse you can generate eclipse project metadata using the following command: +If you prefer not to use m2eclipse you can generate eclipse project metadata using the +following command: [indent=0] ---- @@ -366,54 +412,59 @@ If you prefer not to use m2eclipse you can generate eclipse project metadata usi The generated eclipse projects can be imported by selecting `import existing projects` from the `file` menu. + == Contributing :spring-cloud-build-branch: master -Spring Cloud is released under the non-restrictive Apache 2.0 license, and follows a very standard Github development process, using Github tracker for issues and merging pull requests into master. -If you want to contribute even something trivial please do not hesitate, but follow the guidelines below. +Spring Cloud is released under the non-restrictive Apache 2.0 license, +and follows a very standard Github development process, using Github +tracker for issues and merging pull requests into master. If you want +to contribute even something trivial please do not hesitate, but +follow the guidelines below. === Sign the Contributor License Agreement - Before we accept a non-trivial patch or pull request we will need you to sign the https://cla.pivotal.io/sign/spring[Contributor License Agreement]. -Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. -Active contributors might be asked to join the core team, and given the ability to merge pull requests. +Signing the contributor's agreement does not grant anyone commit rights to the main +repository, but it does mean that we can accept your contributions, and you will get an +author credit if we do. Active contributors might be asked to join the core team, and +given the ability to merge pull requests. === Code of Conduct - This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc[code of -conduct]. -By participating, you are expected to uphold this code. -Please report unacceptable behavior to spring-code-of-conduct@pivotal.io. +conduct]. By participating, you are expected to uphold this code. Please report +unacceptable behavior to spring-code-of-conduct@pivotal.io. === Code Conventions and Housekeeping +None of these is essential for a pull request, but they will all help. They can also be +added after the original pull request but before a merge. -None of these is essential for a pull request, but they will all help. -They can also be added after the original pull request but before a merge. - -* Use the Spring Framework code format conventions. -If you use Eclipse you can import formatter settings using the -`eclipse-code-formatter.xml` file from the -https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring - Cloud Build] project. -If using IntelliJ, you can use the -https://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter - Plugin] to import the same file. +* Use the Spring Framework code format conventions. If you use Eclipse + you can import formatter settings using the + `eclipse-code-formatter.xml` file from the + https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring + Cloud Build] project. If using IntelliJ, you can use the + https://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter + Plugin] to import the same file. * Make sure all new `.java` files to have a simple Javadoc class comment with at least an -`@author` tag identifying you, and preferably at least a paragraph on what the class is for. -* Add the ASF license header comment to all new `.java` files (copy from existing files in the project) -* Add yourself as an `@author` to the .java files that you modify substantially (more than cosmetic changes). + `@author` tag identifying you, and preferably at least a paragraph on what the class is + for. +* Add the ASF license header comment to all new `.java` files (copy from existing files + in the project) +* Add yourself as an `@author` to the .java files that you modify substantially (more + than cosmetic changes). * Add some Javadocs and, if you change the namespace, some XSD doc elements. * A few unit tests would help a lot as well -- someone has to do it. -* If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project). -* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit message (where XXXX is the issue number). +* If no-one else is using your branch, please rebase it against the current master (or + other target branch in the main project). +* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], + if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit + message (where XXXX is the issue number). === Checkstyle -Spring Cloud Build comes with a set of checkstyle rules. -You can find them in the `spring-cloud-build-tools` module. -The most notable files under the module are: +Spring Cloud Build comes with a set of checkstyle rules. You can find them in the `spring-cloud-build-tools` module. The most notable files under the module are: .spring-cloud-build-tools/ ---- @@ -431,8 +482,7 @@ The most notable files under the module are: ==== Checkstyle configuration -Checkstyle rules are *disabled by default*. -To add checkstyle to your project just define the following properties and plugins. +Checkstyle rules are *disabled by default*. To add checkstyle to your project just define the following properties and plugins. .pom.xml ---- @@ -472,8 +522,7 @@ To add checkstyle to your project just define the following properties and plugi <4> Add the Spring Java Format plugin that will reformat your code to pass most of the Checkstyle formatting rules <5> Add checkstyle plugin to your build and reporting phases -If you need to suppress some rules (e.g. line length needs to be longer), then it's enough for you to define a file under `${project.root}/src/checkstyle/checkstyle-suppressions.xml` with your suppressions. -Example: +If you need to suppress some rules (e.g. line length needs to be longer), then it's enough for you to define a file under `${project.root}/src/checkstyle/checkstyle-suppressions.xml` with your suppressions. Example: .projectRoot/src/checkstyle/checkstyle-suppresions.xml ---- @@ -487,9 +536,7 @@ Example: ---- -It's advisable to copy the `${spring-cloud-build.rootFolder}/.editorconfig` and `${spring-cloud-build.rootFolder}/.springformat` to your project. -That way, some default formatting rules will be applied. -You can do so by running this script: +It's advisable to copy the `${spring-cloud-build.rootFolder}/.editorconfig` and `${spring-cloud-build.rootFolder}/.springformat` to your project. That way, some default formatting rules will be applied. You can do so by running this script: ```bash $ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/.editorconfig -o .editorconfig @@ -523,37 +570,27 @@ The following files can be found in the https://github.com/spring-cloud/spring-c <5> Project style conventions for Intellij that apply most of Checkstyle rules .Code style + image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-code-style.png[Code style] -Go to `File` -> `Settings` -> `Editor` -> `Code style`. -There click on the icon next to the `Scheme` section. -There, click on the `Import Scheme` value and pick the `Intellij IDEA code style XML` option. -Import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Spring_Boot_Java_Conventions.xml` file. +Go to `File` -> `Settings` -> `Editor` -> `Code style`. There click on the icon next to the `Scheme` section. There, click on the `Import Scheme` value and pick the `Intellij IDEA code style XML` option. Import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Spring_Boot_Java_Conventions.xml` file. .Inspection profiles + image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-inspections.png[Code style] -Go to `File` -> `Settings` -> `Editor` -> `Inspections`. -There click on the icon next to the `Profile` section. -There, click on the `Import Profile` and import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Project_Defaults.xml` file. +Go to `File` -> `Settings` -> `Editor` -> `Inspections`. There click on the icon next to the `Profile` section. There, click on the `Import Profile` and import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Project_Defaults.xml` file. .Checkstyle -To have Intellij work with Checkstyle, you have to install the `Checkstyle` plugin. -It's advisable to also install the `Assertions2Assertj` to automatically convert the JUnit assertions + +To have Intellij work with Checkstyle, you have to install the `Checkstyle` plugin. It's advisable to also install the `Assertions2Assertj` to automatically convert the JUnit assertions image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-checkstyle.png[Checkstyle] -Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. -There click on the `+` icon in the `Configuration file` section. -There, you'll have to define where the checkstyle rules should be picked from. -In the image above, we've picked the rules from the cloned Spring Cloud Build repository. -However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables: +Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on the `+` icon in the `Configuration file` section. There, you'll have to define where the checkstyle rules should be picked from. In the image above, we've picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables: - `checkstyle.header.file` - please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` URL. -- `checkstyle.suppressions.file` - default suppressions. -Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL. -- `checkstyle.additional.suppressions.file` - this variable corresponds to suppressions in your local project. E.g. you're working on `spring-cloud-contract`. -Then point to the `project-root/src/checkstyle/checkstyle-suppressions.xml` folder. -Example for `spring-cloud-contract` would be: `/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml`. +- `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL. +- `checkstyle.additional.suppressions.file` - this variable corresponds to suppressions in your local project. E.g. you're working on `spring-cloud-contract`. Then point to the `project-root/src/checkstyle/checkstyle-suppressions.xml` folder. Example for `spring-cloud-contract` would be: `/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml`. IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources. diff --git a/docs/pom.xml b/docs/pom.xml index 71daf749..a7db0a5d 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -21,72 +21,46 @@ spring-cloud-vault ${basedir}/.. - 2.1.x,2.2.x + spring.vault.*|spring.cloud.vault.* + deploy - - - - - org.apache.maven.plugins - maven-jar-plugin - 3.0.2 - - - org.apache.maven.plugins - maven-source-plugin - 3.0.1 - - - org.apache.maven.plugins - maven-javadoc-plugin - 2.10.4 - - - org.apache.maven.plugins - maven-deploy-plugin - 2.8.2 - - - org.apache.maven.plugins - maven-release-plugin - 2.5.3 - - - - - - - - maven-deploy-plugin - - true - - - - + + + ${project.groupId} + spring-cloud-starter-vault-config + + docs - + - org.apache.maven.plugins + pl.project13.maven + git-commit-id-plugin + + maven-dependency-plugin - org.apache.maven.plugins maven-resources-plugin + + org.codehaus.mojo + exec-maven-plugin + org.asciidoctor asciidoctor-maven-plugin - org.apache.maven.plugins maven-antrun-plugin + + maven-deploy-plugin + diff --git a/docs/src/main/asciidoc/_configprops.adoc b/docs/src/main/asciidoc/_configprops.adoc new file mode 100644 index 00000000..d85f67c9 --- /dev/null +++ b/docs/src/main/asciidoc/_configprops.adoc @@ -0,0 +1,74 @@ +|=== +|Name | Default | Description + +|spring.cloud.vault.app-id.app-id-path | app-id | Mount path of the AppId authentication backend. +|spring.cloud.vault.app-id.network-interface | | Network interface hint for the "MAC_ADDRESS" UserId mechanism. +|spring.cloud.vault.app-id.user-id | MAC_ADDRESS | UserId mechanism. Can be either "MAC_ADDRESS", "IP_ADDRESS", a string or a class name. +|spring.cloud.vault.app-role.app-role-path | approle | Mount path of the AppRole authentication backend. +|spring.cloud.vault.app-role.role | | Name of the role, optional, used for pull-mode. +|spring.cloud.vault.app-role.role-id | | The RoleId. +|spring.cloud.vault.app-role.secret-id | | The SecretId. +|spring.cloud.vault.application-name | application | Application name for AppId authentication. +|spring.cloud.vault.authentication | | +|spring.cloud.vault.aws-ec2.aws-ec2-path | aws-ec2 | Mount path of the AWS-EC2 authentication backend. +|spring.cloud.vault.aws-ec2.identity-document | http://169.254.169.254/latest/dynamic/instance-identity/pkcs7 | URL of the AWS-EC2 PKCS7 identity document. +|spring.cloud.vault.aws-ec2.nonce | | Nonce used for AWS-EC2 authentication. An empty nonce defaults to nonce generation. +|spring.cloud.vault.aws-ec2.role | | Name of the role, optional. +|spring.cloud.vault.aws-iam.aws-path | aws | Mount path of the AWS authentication backend. +|spring.cloud.vault.aws-iam.endpoint-uri | | STS server URI. @since 2.2 +|spring.cloud.vault.aws-iam.role | | Name of the role, optional. Defaults to the friendly IAM name if not set. +|spring.cloud.vault.aws-iam.server-name | | Name of the server used to set {@code X-Vault-AWS-IAM-Server-ID} header in the headers of login requests. +|spring.cloud.vault.azure-msi.azure-path | azure | Mount path of the Azure MSI authentication backend. +|spring.cloud.vault.azure-msi.role | | Name of the role. +|spring.cloud.vault.config.lifecycle.enabled | true | Enable lifecycle management. +|spring.cloud.vault.config.lifecycle.expiry-threshold | | The expiry threshold. {@link Lease} is renewed the given {@link Duration} before it expires. @since 2.2 +|spring.cloud.vault.config.lifecycle.lease-endpoints | | Set the {@link LeaseEndpoints} to delegate renewal/revocation calls to. {@link LeaseEndpoints} encapsulates differences between Vault versions that affect the location of renewal/revocation endpoints. Can be {@link LeaseEndpoints#SysLeases} for version 0.8 or above of Vault or {@link LeaseEndpoints#Legacy} for older versions (the default). @since 2.2 +|spring.cloud.vault.config.lifecycle.min-renewal | | The time period that is at least required before renewing a lease. @since 2.2 +|spring.cloud.vault.config.order | 0 | Used to set a {@link org.springframework.core.env.PropertySource} priority. This is useful to use Vault as an override on other property sources. @see org.springframework.core.PriorityOrdered +|spring.cloud.vault.connection-timeout | 5000 | Connection timeout. +|spring.cloud.vault.discovery.enabled | false | Flag to indicate that Vault server discovery is enabled (vault server URL will be looked up via discovery). +|spring.cloud.vault.discovery.service-id | vault | Service id to locate Vault. +|spring.cloud.vault.enabled | true | Enable Vault config server. +|spring.cloud.vault.fail-fast | false | Fail fast if data cannot be obtained from Vault. +|spring.cloud.vault.gcp-gce.gcp-path | gcp | Mount path of the Kubernetes authentication backend. +|spring.cloud.vault.gcp-gce.role | | Name of the role against which the login is being attempted. +|spring.cloud.vault.gcp-gce.service-account | | Optional service account id. Using the default id if left unconfigured. +|spring.cloud.vault.gcp-iam.credentials.encoded-key | | The base64 encoded contents of an OAuth2 account private key in JSON format. +|spring.cloud.vault.gcp-iam.credentials.location | | Location of the OAuth2 credentials private key.

Since this is a Resource, the private key can be in a multitude of locations, such as a local file system, classpath, URL, etc. +|spring.cloud.vault.gcp-iam.gcp-path | gcp | Mount path of the Kubernetes authentication backend. +|spring.cloud.vault.gcp-iam.jwt-validity | 15m | Validity of the JWT token. +|spring.cloud.vault.gcp-iam.project-id | | Overrides the GCP project Id. +|spring.cloud.vault.gcp-iam.role | | Name of the role against which the login is being attempted. +|spring.cloud.vault.gcp-iam.service-account-id | | Overrides the GCP service account Id. +|spring.cloud.vault.generic.application-name | application | Application name to be used for the context. +|spring.cloud.vault.generic.backend | secret | Name of the default backend. +|spring.cloud.vault.generic.default-context | application | Name of the default context. +|spring.cloud.vault.generic.enabled | true | Enable the generic backend. +|spring.cloud.vault.generic.profile-separator | / | Profile-separator to combine application name and profile. +|spring.cloud.vault.host | localhost | Vault server host. +|spring.cloud.vault.kubernetes.kubernetes-path | kubernetes | Mount path of the Kubernetes authentication backend. +|spring.cloud.vault.kubernetes.role | | Name of the role against which the login is being attempted. +|spring.cloud.vault.kubernetes.service-account-token-file | /var/run/secrets/kubernetes.io/serviceaccount/token | Path to the service account token file. +|spring.cloud.vault.kv.application-name | application | Application name to be used for the context. +|spring.cloud.vault.kv.backend | secret | Name of the default backend. +|spring.cloud.vault.kv.backend-version | 2 | Key-Value backend version. Currently supported versions are:

+|spring.cloud.vault.kv.default-context | application | Name of the default context. +|spring.cloud.vault.kv.enabled | false | Enable the kev-value backend. +|spring.cloud.vault.kv.profile-separator | / | Profile-separator to combine application name and profile. +|spring.cloud.vault.namespace | | Vault namespace (requires Vault Enterprise). +|spring.cloud.vault.pcf.instance-certificate | | Path to the instance certificate (PEM). Defaults to {@code CF_INSTANCE_CERT} env variable. +|spring.cloud.vault.pcf.instance-key | | Path to the instance key (PEM). Defaults to {@code CF_INSTANCE_KEY} env variable. +|spring.cloud.vault.pcf.pcf-path | pcf | Mount path of the Kubernetes authentication backend. +|spring.cloud.vault.pcf.role | | Name of the role against which the login is being attempted. +|spring.cloud.vault.port | 8200 | Vault server port. +|spring.cloud.vault.read-timeout | 15000 | Read timeout. +|spring.cloud.vault.scheme | https | Protocol scheme. Can be either "http" or "https". +|spring.cloud.vault.ssl.cert-auth-path | cert | Mount path of the TLS cert authentication backend. +|spring.cloud.vault.ssl.key-store | | Trust store that holds certificates and private keys. +|spring.cloud.vault.ssl.key-store-password | | Password used to access the key store. +|spring.cloud.vault.ssl.trust-store | | Trust store that holds SSL certificates. +|spring.cloud.vault.ssl.trust-store-password | | Password used to access the trust store. +|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/pom.xml b/pom.xml index d20eabc3..0a778ceb 100644 --- a/pom.xml +++ b/pom.xml @@ -7,7 +7,7 @@ org.springframework.cloud spring-cloud-build - 2.3.0.RELEASE + 2.3.1.BUILD-SNAPSHOT