From 9f40b38d3e1baab8febf1a4b31154acbbdd0dd7f Mon Sep 17 00:00:00 2001 From: Matthew Oliver Date: Fri, 1 Nov 2019 01:02:39 +0000 Subject: [PATCH] doc: Add a RGW swift auth note Swift accounts are not like normal accounts, they are more akin to a bank account that multile people could share. Or in the case of a cloud it is usually mapped to the tenant. Radosgw deals with this with a user and subuser, which is great, but a little confusing. So this patch adds a note to those used to the Swift API to make it more clear. Signed-off-by: Matthew Oliver --- doc/radosgw/swift/auth.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/radosgw/swift/auth.rst b/doc/radosgw/swift/auth.rst index 26290505c13..12d6b23ffee 100644 --- a/doc/radosgw/swift/auth.rst +++ b/doc/radosgw/swift/auth.rst @@ -14,6 +14,11 @@ For details on RADOS Gateway administration, see `radosgw-admin`_. .. _radosgw-admin: ../../../man/8/radosgw-admin/ +.. note:: + For those used to the Swift API this is implementing the Swift auth v1.0 API, as such + `{username}` above is generally equivalent to a Swift `account` and `{subusername}` + is a user under that account. + Auth Get -------- -- 2.39.5