From f013662e3fb89b3b67cf1319d7a7db20e9dd2f2e Mon Sep 17 00:00:00 2001 From: Nick Douma Date: Wed, 11 Nov 2020 15:11:14 +0100 Subject: [PATCH] Remove separate section on Ceph, and move s3.list-objects-v1 note to S3 section --- doc/030_preparing_a_new_repo.rst | 39 +++++--------------------------- 1 file changed, 6 insertions(+), 33 deletions(-) diff --git a/doc/030_preparing_a_new_repo.rst b/doc/030_preparing_a_new_repo.rst index 5e9cf1c4a..164cb7007 100644 --- a/doc/030_preparing_a_new_repo.rst +++ b/doc/030_preparing_a_new_repo.rst @@ -239,6 +239,12 @@ For an S3-compatible server that is not Amazon (like Minio, see below), or is only available via HTTP, you can specify the URL to the server like this: ``s3:http://server:port/bucket_name``. + +.. note:: Certain S3-compatible servers do not properly implement the ListObjectsV2 API, + most notably Ceph versions before v14.2.5. On these backends you need to + provide the ``-o s3.list-objects-v1=true`` option to use the ListObjects API instead. + + Minio Server ************ @@ -339,39 +345,6 @@ For example with an actual endpoint: $ restic -o s3.bucket-lookup=dns -o s3.region=oss-eu-west-1 -r s3:https://oss-eu-west-1.aliyuncs.com/bucketname init -Ceph -**** - -`Ceph Object Gateway `__ is an object -storage interface built on top of librados to provide applications with a RESTful -gateway to Ceph Storage Clusters. - -Ceph Rados Gateway (RGW) provides a S3 interface that is compatible with a large -subset of the Amazon S3 RESTful API. - -You will need to setup the following environment variables with the proper credentials: - -.. code-block:: console - - $ export AWS_ACCESS_KEY_ID= - $ export AWS_SECRET_ACCESS_KEY= - -Now you can easily initialize restic to use Ceph RGW as a backend with -this command. - -.. code-block:: console - - $ restic -r s3:/// init - enter password for new backend: - enter password again: - created restic backend xxxxxxxxxx at s3:/// - Please note that knowledge of your password is required to access - the repository. Losing your password means that your data is irrecoverably lost. - -.. note:: Version of Ceph before v14.2.5 do not implement the ListObjectsV2 API properly. - On these backends you need to provide the ``-o s3.list-objects-v1=true`` option - to use the ListObjects API instead. - OpenStack Swift ***************