From abba0b2342ca2715b63fbab1e1f0ec84ea405904 Mon Sep 17 00:00:00 2001 From: Alex Buchanan Date: Wed, 15 Nov 2017 10:09:15 -0800 Subject: [PATCH] website: update known issues related to swift config --- docs/docs/index.xml | 4 ++-- docs/docs/storage/swift/index.html | 5 +++-- docs/index.xml | 4 ++-- website/content/docs/storage/swift.md | 5 +++-- 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/docs/index.xml b/docs/docs/index.xml index 313db597e..0f2a1c0eb 100644 --- a/docs/docs/index.xml +++ b/docs/docs/index.xml @@ -211,8 +211,8 @@ Worker: ActiveEventWriters: - log - mongodb EventWriters: MongoDB: Addrs: - & https://ohsu-comp-bio.github.io/funnel/docs/storage/swift/ 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. +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. diff --git a/docs/docs/storage/swift/index.html b/docs/docs/storage/swift/index.html index d6a4cb3d2..e6b9add17 100644 --- a/docs/docs/storage/swift/index.html +++ b/docs/docs/storage/swift/index.html @@ -299,9 +299,10 @@

OpenStack Swift

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.

+

The config currently only supports OpenStack v2 auth. See issue #336.

-

In the future, Swift will be enabled by default, with automatic detection of credentials from the environment. See issue #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.

diff --git a/docs/index.xml b/docs/index.xml index 40b6e4ca3..ca9b6ef19 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -225,8 +225,8 @@ Worker: ActiveEventWriters: - log - mongodb EventWriters: MongoDB: Addrs: - & https://ohsu-comp-bio.github.io/funnel/docs/storage/swift/ 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. +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.
diff --git a/website/content/docs/storage/swift.md b/website/content/docs/storage/swift.md index d9577948d..6fd8f53ef 100644 --- 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).