Update site.

* Update supported authentication mechanisms * Add link to examples repo * Add VaultPropertySource sample See gh-60.
2017-03-16 13:58:41 +01:00
parent 30ce9667c7
commit 04eb02554e
3 changed files with 223 additions and 42 deletions
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -0,0 +1,2 @@
+_site/
+Gemfile.lock
--- a/docs/Gemfile.lock
+++ b/docs/Gemfile.lock
@@ -1,50 +1,201 @@
 GEM
  remote: http://rubygems.org/
  specs:
-    RedCloth (4.2.9)
-    classifier (1.3.3)
-      fast-stemmer (>= 1.0.0)
-    colorator (0.1)
-    commander (4.1.5)
-      highline (~> 1.6.11)
-    directory_watcher (1.4.1)
-    fast-stemmer (1.0.2)
-    github-pages (1)
-      RedCloth (= 4.2.9)
-      jekyll (= 1.1.2)
-      kramdown (= 1.0.2)
-      liquid (= 2.5.1)
-      maruku (= 0.6.1)
-      rdiscount (= 1.6.8)
-      redcarpet (= 2.2.2)
-    highline (1.6.19)
-    jekyll (1.1.2)
-      classifier (~> 1.3)
-      colorator (~> 0.1)
-      commander (~> 4.1.3)
-      directory_watcher (~> 1.4.1)
-      kramdown (~> 1.0.2)
-      liquid (~> 2.5.1)
-      maruku (~> 0.5)
-      pygments.rb (~> 0.5.0)
-      redcarpet (~> 2.2.2)
-      safe_yaml (~> 0.7.0)
-    kramdown (1.0.2)
-    liquid (2.5.1)
-    maruku (0.6.1)
-      syntax (>= 1.0.0)
-    posix-spawn (0.3.6)
-    pygments.rb (0.5.2)
-      posix-spawn (~> 0.3.6)
-      yajl-ruby (~> 1.1.0)
-    rdiscount (1.6.8)
-    redcarpet (2.2.2)
-    safe_yaml (0.7.1)
-    syntax (1.0.0)
-    yajl-ruby (1.1.0)
+    activesupport (4.2.7)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.12.2)
+    colorator (1.1.0)
+    ethon (0.10.1)
+      ffi (>= 1.3.0)
+    execjs (2.7.0)
+    faraday (0.11.0)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.18)
+    forwardable-extended (2.6.0)
+    gemoji (3.0.0)
+    github-pages (127)
+      activesupport (= 4.2.7)
+      github-pages-health-check (= 1.3.3)
+      jekyll (= 3.4.1)
+      jekyll-avatar (= 0.4.2)
+      jekyll-coffeescript (= 1.0.1)
+      jekyll-default-layout (= 0.1.4)
+      jekyll-feed (= 0.9.1)
+      jekyll-gist (= 1.4.0)
+      jekyll-github-metadata (= 2.3.1)
+      jekyll-mentions (= 1.2.0)
+      jekyll-optional-front-matter (= 0.1.2)
+      jekyll-paginate (= 1.1.0)
+      jekyll-readme-index (= 0.0.4)
+      jekyll-redirect-from (= 0.12.1)
+      jekyll-relative-links (= 0.3.0)
+      jekyll-sass-converter (= 1.5.0)
+      jekyll-seo-tag (= 2.1.0)
+      jekyll-sitemap (= 1.0.0)
+      jekyll-swiss (= 0.4.0)
+      jekyll-theme-architect (= 0.0.3)
+      jekyll-theme-cayman (= 0.0.3)
+      jekyll-theme-dinky (= 0.0.3)
+      jekyll-theme-hacker (= 0.0.3)
+      jekyll-theme-leap-day (= 0.0.3)
+      jekyll-theme-merlot (= 0.0.3)
+      jekyll-theme-midnight (= 0.0.3)
+      jekyll-theme-minimal (= 0.0.3)
+      jekyll-theme-modernist (= 0.0.3)
+      jekyll-theme-primer (= 0.1.7)
+      jekyll-theme-slate (= 0.0.3)
+      jekyll-theme-tactile (= 0.0.3)
+      jekyll-theme-time-machine (= 0.0.3)
+      jekyll-titles-from-headings (= 0.1.4)
+      jemoji (= 0.8.0)
+      kramdown (= 1.13.2)
+      liquid (= 3.0.6)
+      listen (= 3.0.6)
+      mercenary (~> 0.3)
+      minima (= 2.0.0)
+      nokogiri (= 1.6.8.1)
+      rouge (= 1.11.1)
+      terminal-table (~> 1.4)
+    github-pages-health-check (1.3.3)
+      addressable (~> 2.3)
+      net-dns (~> 0.8)
+      octokit (~> 4.0)
+      public_suffix (~> 2.0)
+      typhoeus (~> 0.7)
+    html-pipeline (2.5.0)
+      activesupport (>= 2)
+      nokogiri (>= 1.4)
+    i18n (0.8.1)
+    jekyll (3.4.1)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 3.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (~> 1.7)
+      safe_yaml (~> 1.0)
+    jekyll-avatar (0.4.2)
+      jekyll (~> 3.0)
+    jekyll-coffeescript (1.0.1)
+      coffee-script (~> 2.2)
+    jekyll-default-layout (0.1.4)
+      jekyll (~> 3.0)
+    jekyll-feed (0.9.1)
+      jekyll (~> 3.3)
+    jekyll-gist (1.4.0)
+      octokit (~> 4.2)
+    jekyll-github-metadata (2.3.1)
+      jekyll (~> 3.1)
+      octokit (~> 4.0, != 4.4.0)
+    jekyll-mentions (1.2.0)
+      activesupport (~> 4.0)
+      html-pipeline (~> 2.3)
+      jekyll (~> 3.0)
+    jekyll-optional-front-matter (0.1.2)
+      jekyll (~> 3.0)
+    jekyll-paginate (1.1.0)
+    jekyll-readme-index (0.0.4)
+      jekyll (~> 3.0)
+    jekyll-redirect-from (0.12.1)
+      jekyll (~> 3.3)
+    jekyll-relative-links (0.3.0)
+      jekyll (~> 3.3)
+    jekyll-sass-converter (1.5.0)
+      sass (~> 3.4)
+    jekyll-seo-tag (2.1.0)
+      jekyll (~> 3.3)
+    jekyll-sitemap (1.0.0)
+      jekyll (~> 3.3)
+    jekyll-swiss (0.4.0)
+    jekyll-theme-architect (0.0.3)
+      jekyll (~> 3.3)
+    jekyll-theme-cayman (0.0.3)
+      jekyll (~> 3.3)
+    jekyll-theme-dinky (0.0.3)
+      jekyll (~> 3.3)
+    jekyll-theme-hacker (0.0.3)
+      jekyll (~> 3.3)
+    jekyll-theme-leap-day (0.0.3)
+      jekyll (~> 3.3)
+    jekyll-theme-merlot (0.0.3)
+      jekyll (~> 3.3)
+    jekyll-theme-midnight (0.0.3)
+      jekyll (~> 3.3)
+    jekyll-theme-minimal (0.0.3)
+      jekyll (~> 3.3)
+    jekyll-theme-modernist (0.0.3)
+      jekyll (~> 3.3)
+    jekyll-theme-primer (0.1.7)
+      jekyll (~> 3.3)
+    jekyll-theme-slate (0.0.3)
+      jekyll (~> 3.3)
+    jekyll-theme-tactile (0.0.3)
+      jekyll (~> 3.3)
+    jekyll-theme-time-machine (0.0.3)
+      jekyll (~> 3.3)
+    jekyll-titles-from-headings (0.1.4)
+      jekyll (~> 3.3)
+    jekyll-watch (1.5.0)
+      listen (~> 3.0, < 3.1)
+    jemoji (0.8.0)
+      activesupport (~> 4.0)
+      gemoji (~> 3.0)
+      html-pipeline (~> 2.2)
+      jekyll (>= 3.0)
+    json (1.7.7)
+    kramdown (1.13.2)
+    liquid (3.0.6)
+    listen (3.0.6)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    mercenary (0.3.6)
+    mini_portile2 (2.1.0)
+    minima (2.0.0)
+    minitest (5.10.1)
+    multipart-post (2.0.0)
+    net-dns (0.8.0)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    octokit (4.6.2)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    pathutil (0.14.0)
+      forwardable-extended (~> 2.6)
+    public_suffix (2.0.5)
+    rb-fsevent (0.9.8)
+    rb-inotify (0.9.8)
+      ffi (>= 0.5.0)
+    rouge (1.11.1)
+    safe_yaml (1.0.4)
+    sass (3.4.23)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    terminal-table (1.7.3)
+      unicode-display_width (~> 1.1.1)
+    thread_safe (0.3.6)
+    typhoeus (0.8.0)
+      ethon (>= 0.8.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.1.3)

 PLATFORMS
  ruby

 DEPENDENCIES
  github-pages
+
+BUNDLED WITH
+   1.14.6
--- a/docs/index.html
+++ b/docs/index.html
@@ -52,7 +52,7 @@ Vault can manage static and dynamic secrets such as application data, username/p

 * Connection package as low-level abstraction
 * Reading, writing and deleting data from Vault with object mapping support
-* Multiple authentication mechanisms: AppId, AppRole, Client Certificates, and Cubbyhole (wrapped/stored token)
+* Multiple authentication mechanisms: AppId, AppRole, AWS EC2, Client Certificates, and Cubbyhole (wrapped/stored token)

 <span id="quick-start"></span>

@@ -104,9 +104,37 @@ public class Example {
 }
 ```

+#### Vault `PropertySource`
+
+```java
+@VaultPropertySource(value = "aws/creds/s3",
+  propertyNamePrefix = "aws."
+  renewal = Renewal.RENEW)
+public class MyConfig {
+
+}
+
+public class Example {
+
+  // inject the actual values
+  @Value("${aws.access_key}
+  private String awsAccessKey;
+
+  @Value("${aws.secret_key}
+  private String awsSecretKeyKey;
+
+  public InputStream getFileFromS3(String filenname) {
+    // …
+  }
+}
+```
+
 {% endcapture %}

 {% capture related_resources %}
+### Getting Started
+
+[Examples](https://github.com/mp911de/spring-cloud-vault-config-samples)

 {% endcapture %}