Skip to content

Commit 5333fcc

Browse files
authored
docs(admin): document OpenStack Keystone v3 for external Swift storage
Signed-off-by: whoalin1 <whoalin414@gmail.com>
1 parent 2de9481 commit 5333fcc

1 file changed

Lines changed: 45 additions & 8 deletions

File tree

‎admin_manual/configuration_files/external_storage/openstack.rst‎

Lines changed: 45 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,59 @@ OpenStack Object Storage
33
========================
44

55
OpenStack Object Storage is used to connect to an OpenStack Swift server, or to
6-
Rackspace. Two authentication mechanisms are available: one is the generic
7-
OpenStack mechanism, and the other is used exclusively for Rackspace, a provider
8-
of object storage that uses the OpenStack Swift protocol.
6+
Rackspace. Nextcloud supports OpenStack Keystone **v2** and **v3** authentication,
7+
plus a Rackspace-specific mechanism that uses the OpenStack Swift protocol.
98

10-
The OpenStack authentication mechanism uses the OpenStack Keystone v2
11-
protocol. Your Nextcloud configuration needs:
9+
Shared backend fields (all OpenStack/Rackspace mounts)
10+
------------------------------------------------------
1211

1312
* **Bucket**. This is user-defined; think of it as a subdirectory of your total
1413
storage. The bucket will be created if it does not exist.
15-
* **Username** of your account.
14+
* **Region**. Your region as shown in the OpenStack or Rackspace account.
15+
* **Service name** (optional). Defaults depend on the provider; Rackspace uses
16+
``cloudFiles``.
17+
* **Request timeout** (optional), in seconds.
18+
19+
OpenStack Keystone v2
20+
---------------------
21+
22+
Select the **OpenStack v2** authentication mechanism. Your Nextcloud configuration
23+
needs:
24+
25+
* **Login** (username) of your account.
1626
* **Password** of your account.
1727
* **Tenant name** of your account. (A tenant is similar to a user group.)
18-
* **Identity Endpoint URL**, the URL to log in to your OpenStack account.
28+
* **Identity endpoint URL**, typically ending in ``/v2.0``.
1929

2030
.. figure:: images/openstack.png
21-
:alt: OpenStack configuration.
31+
:alt: OpenStack Keystone v2 configuration.
32+
33+
OpenStack Keystone v3
34+
---------------------
35+
36+
Select the **OpenStack v3** authentication mechanism when your cloud requires
37+
Keystone v3 (common on current OpenStack deployments). In addition to the shared
38+
backend fields above, configure:
39+
40+
* **Login** (username) of your account.
41+
* **Domain** of the user (often ``Default``).
42+
* **Password** of your account.
43+
* **Tenant name** (project name) of your account.
44+
* **Identity endpoint URL**, typically ending in ``/v3``.
45+
46+
The user domain is required for v3. The tenant/project is scoped using the
47+
project name together with the identity endpoint; map these from your OpenRC
48+
file (``OS_USERNAME``, ``OS_USER_DOMAIN_NAME``, ``OS_PASSWORD``,
49+
``OS_PROJECT_NAME`` / ``OS_TENANT_NAME``, ``OS_AUTH_URL``).
50+
51+
.. note::
52+
53+
Primary object storage (``config.php`` ``objectstore``) has separate v2/v3
54+
examples in :doc:`../primary_storage`. Field names differ slightly from the
55+
External Storage GUI described here.
56+
57+
Rackspace
58+
---------
2259

2360
The Rackspace authentication mechanism requires:
2461

0 commit comments

Comments
 (0)