summaryrefslogtreecommitdiff
path: root/rst/backends.rst
diff options
context:
space:
mode:
Diffstat (limited to 'rst/backends.rst')
-rw-r--r--rst/backends.rst20
1 files changed, 18 insertions, 2 deletions
diff --git a/rst/backends.rst b/rst/backends.rst
index a8ad9f1..75b621a 100644
--- a/rst/backends.rst
+++ b/rst/backends.rst
@@ -195,12 +195,13 @@ authentication, the storage URL is ::
swift://<hostname>[:<port>]/<container>[/<prefix>]
-for Keystone (v2) authentication, the storage URL is ::
+for Keystone (v2 and v3) authentication, the storage URL is ::
swiftks://<hostname>[:<port>]/<region>:<container>[/<prefix>]
Note that when using Keystone authentication, you can (and have to)
-specify the storage region of the container as well.
+specify the storage region of the container as well. Also note that when
+using Keystone v3 authentication, the `domain` option is required.
In both cases, *hostname* name should be the name of the
authentication server. The storage container must already exist (most
@@ -256,6 +257,21 @@ The OpenStack backend accepts the following backend options:
use the least common denominator of supported Swift versions and
configurations.
+.. option:: domain
+
+ If this option is specified, S3QL will use the Keystone v3 API. The
+ default domain for OpenStack installations is `Default`. If this
+ option is specified without setting the `project-domain` option, this
+ will be used for both the project and the user domain. Note: some
+ instances of the Keystone v3 API prefer the use of UUIDs rather than
+ names for tenant (called project in newer OpenStack versions), as
+ well as domains.
+
+.. option:: project-domain
+ In simple cases, the project domain will be the same as the auth
+ domain. If the `project-domain` option is not specified, it will be
+ assumed to be the same as the user domain.
+
.. __: http://tools.ietf.org/html/rfc2616#section-8.2.3
.. _OpenStack: http://www.openstack.org/
.. _Swift: http://openstack.org/projects/storage/