SpringCloud/spring-cloud-vault
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync docs from master to gh-pages

Browse Source
This commit is contained in:
buildmaster
2019-09-09 12:54:53 +00:00
parent 7bcd09eb7c
commit 8f89984466
2 changed files with 152 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
reference/html/spring-cloud-vault.html
View File

@@ -118,6 +118,7 @@ $(addBlockSwitches);
<li><a href="#vault.config.authentication.gcpgce">GCP-GCE authentication</a></li>
<li><a href="#vault.config.authentication.gcpiam">GCP-IAM authentication</a></li>
<li><a href="#vault.config.authentication.kubernetes">Kubernetes authentication</a></li>
<li><a href="#vault.config.authentication.pcf">Pivotal CloudFoundry authentication</a></li>
</ul>
</li>
<li><a href="#vault.config.backends">Secret Backends</a>
@@ -1529,6 +1530,77 @@ The authentication is role based and the role is bound to a service account name
</ul>
</div>
</div>
<div class="sect2">
<h3 id="vault.config.authentication.pcf"><a class="link" href="#vault.config.authentication.pcf">Pivotal CloudFoundry authentication</a></h3>
<div class="paragraph">
<p>The <a href="https://www.vaultproject.io/docs/auth/pcf.html">pcf</a>
auth backend provides a secure introduction mechanism for applications running within Pivotal&#8217;s CloudFoundry instances allowing automated retrieval of a Vault token.
Unlike most Vault authentication backends, this backend does not require first-deploying, or provisioning security-sensitive credentials (tokens, username/password, client certificates, etc.) as identity provisioning is handled by PCF itself.
Instead, it treats PCF as a Trusted Third Party and uses the managed instance identity.</p>
</div>
<div class="exampleblock">
<div class="title">Example 26. bootstrap.yml with required PCF Authentication properties</div>
<div class="content">
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">spring.cloud.vault:
authentication: PCF
pcf:
role: my-dev-role</code></pre>
</div>
</div>
</div>
</div>
<div class="exampleblock">
<div class="title">Example 27. bootstrap.yml with all PCF Authentication properties</div>
<div class="content">
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">spring.cloud.vault:
authentication: PCF
pcf:
role: my-dev-role
pcf-path: path
instance-certificate: /etc/cf-instance-credentials/instance.crt
instance-key: /etc/cf-instance-credentials/instance.key</code></pre>
</div>
</div>
</div>
</div>
<div class="ulist">
<ul>
<li>
<p><code>role</code> sets the name of the role against which the login is being attempted.</p>
</li>
<li>
<p><code>pcf-path</code> sets the path of the PCF mount to use.</p>
</li>
<li>
<p><code>instance-certificate</code> sets the path to the PCF instance identity certificate.
Defaults to <code>${CF_INSTANCE_CERT}</code> env variable.</p>
</li>
<li>
<p><code>instance-key</code> sets the path to the PCF instance identity key.
Defaults to <code>${CF_INSTANCE_KEY}</code> env variable.</p>
</li>
</ul>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
PCF authentication requires BouncyCastle (bcpkix-jdk15on) to be on the classpath for RSA PSS signing.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>See also: <a href="https://www.vaultproject.io/docs/auth/pcf.html">Vault Documentation: Using the pcf auth backend</a></p>
</div>
</div>
</div>
</div>
<div class="sect1">
@@ -1778,7 +1850,7 @@ The Consul integration requires the <code>spring-cloud-vault-config-consul</code
dependency.</p>
</div>
<div class="exampleblock">
<div class="title">Example 26. pom.xml</div>
<div class="title">Example 28. pom.xml</div>
<div class="content">
<div class="listingblock">
<div class="content">
@@ -1848,7 +1920,7 @@ the property name by setting <code>spring.cloud.vault.consul.token-property</cod
dependency.</p>
</div>
<div class="exampleblock">
<div class="title">Example 27. pom.xml</div>
<div class="title">Example 29. pom.xml</div>
<div class="content">
<div class="listingblock">
<div class="content">
@@ -1923,7 +1995,7 @@ by setting <code>spring.cloud.vault.rabbitmq.username-property</code> and
dependency.</p>
</div>
<div class="exampleblock">
<div class="title">Example 28. pom.xml</div>
<div class="title">Example 30. pom.xml</div>
<div class="content">
<div class="listingblock">
<div class="content">
@@ -2034,7 +2106,7 @@ generic database backend. Make sure to specify the appropriate
backend path, e.g. <code>spring.cloud.vault.mysql.role.backend=database</code>.</p>
</div>
<div class="exampleblock">
<div class="title">Example 29. pom.xml</div>
<div class="title">Example 31. pom.xml</div>
<div class="content">
<div class="listingblock">
<div class="content">