website: update known issues related to swift config

ohsu-comp-bio · Nov 15, 2017 · abba0b2 · abba0b2
1 parent ee37b25
commit abba0b2
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 8 deletions.
diff --git a/docs/docs/index.xml b/docs/docs/index.xml
@@ -211,8 +211,8 @@ Worker: ActiveEventWriters: - log - mongodb EventWriters: MongoDB: Addrs: - &amp
       <guid>https://ohsu-comp-bio.github.io/funnel/docs/storage/swift/</guid>
       <description>OpenStack Swift Funnel supports using OpenStack Swift for file storage.
 The Swift client is NOT enabled by default, you must explicitly give the credentials in the worker config:
-Worker: Storage: Swift: UserName: Password: AuthURL: TenantName: TenantID: RegionName:  The config currently only supports OpenStack v2 auth, which unfortunately requires the password to be saved in the config file. Make sure to protect this file appropriately. See issue #336.
-In the future, Swift will be enabled by default, with automatic detection of credentials from the environment.</description>
+Worker: Storage: Swift: UserName: Password: AuthURL: TenantName: TenantID: RegionName:  The config currently only supports OpenStack v2 auth. See issue #336.
+As always, if you set the password in this file, make sure you protect it appropriately. Alternatively, the Swift client can pull credentials from these environment variables: https://godoc.</description>
     </item>
 
     <item>

diff --git a/docs/docs/storage/swift/index.html b/docs/docs/storage/swift/index.html
@@ -299,9 +299,10 @@ <h1 id="openstack-swift">OpenStack Swift</h1>
         RegionName:
 </code></pre>
 
-<p>The config currently only supports OpenStack v2 auth, which unfortunately requires the password to be saved in the config file. Make sure to protect this file appropriately. See <a href="https://github.com/ohsu-comp-bio/funnel/issues/336">issue #336</a>.</p>
+<p>The config currently only supports OpenStack v2 auth. See <a href="https://github.com/ohsu-comp-bio/funnel/issues/336">issue #336</a>.</p>
 
-<p>In the future, Swift will be enabled by default, with automatic detection of credentials from the environment. See <a href="https://github.com/ohsu-comp-bio/funnel/issues/253">issue #253</a>.</p>
+<p>As always, if you set the password in this file, make sure you protect it appropriately. Alternatively, the Swift client
+can pull credentials from these environment variables: <a href="https://godoc.org/github.com/ncw/swift#Connection.ApplyEnvironment">https://godoc.org/github.com/ncw/swift#Connection.ApplyEnvironment</a></p>
 
 <p>Swift currently fails while uploading large objects. See <a href="https://github.com/ohsu-comp-bio/funnel/issues/257">issue #257</a>.</p>
 

diff --git a/docs/index.xml b/docs/index.xml
@@ -225,8 +225,8 @@ Worker: ActiveEventWriters: - log - mongodb EventWriters: MongoDB: Addrs: - &amp
       <guid>https://ohsu-comp-bio.github.io/funnel/docs/storage/swift/</guid>
       <description>OpenStack Swift Funnel supports using OpenStack Swift for file storage.
 The Swift client is NOT enabled by default, you must explicitly give the credentials in the worker config:
-Worker: Storage: Swift: UserName: Password: AuthURL: TenantName: TenantID: RegionName:  The config currently only supports OpenStack v2 auth, which unfortunately requires the password to be saved in the config file. Make sure to protect this file appropriately. See issue #336.
-In the future, Swift will be enabled by default, with automatic detection of credentials from the environment.</description>
+Worker: Storage: Swift: UserName: Password: AuthURL: TenantName: TenantID: RegionName:  The config currently only supports OpenStack v2 auth. See issue #336.
+As always, if you set the password in this file, make sure you protect it appropriately. Alternatively, the Swift client can pull credentials from these environment variables: https://godoc.</description>
     </item>
 
     <item>

diff --git a/website/content/docs/storage/swift.md b/website/content/docs/storage/swift.md
@@ -23,9 +23,10 @@ Worker:
         RegionName:
 ```
 
-The config currently only supports OpenStack v2 auth, which unfortunately requires the password to be saved in the config file. Make sure to protect this file appropriately. See [issue #336](https://github.com/ohsu-comp-bio/funnel/issues/336).
+The config currently only supports OpenStack v2 auth. See [issue #336](https://github.com/ohsu-comp-bio/funnel/issues/336).
 
-In the future, Swift will be enabled by default, with automatic detection of credentials from the environment. See [issue #253](https://github.com/ohsu-comp-bio/funnel/issues/253).
+As always, if you set the password in this file, make sure you protect it appropriately. Alternatively, the Swift client
+can pull credentials from these environment variables: https://godoc.org/github.com/ncw/swift#Connection.ApplyEnvironment  
 
 Swift currently fails while uploading large objects. See [issue #257](https://github.com/ohsu-comp-bio/funnel/issues/257).