From 354b7e89cc7b5b8777d305a3114c86f462982d2c Mon Sep 17 00:00:00 2001 From: Nick Douma Date: Wed, 11 Nov 2020 12:32:46 +0100 Subject: [PATCH] Document the extended s3.list-objects-v1 flag in a new Ceph section --- doc/030_preparing_a_new_repo.rst | 33 ++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/doc/030_preparing_a_new_repo.rst b/doc/030_preparing_a_new_repo.rst index f470cf383..5e9cf1c4a 100644 --- a/doc/030_preparing_a_new_repo.rst +++ b/doc/030_preparing_a_new_repo.rst @@ -339,6 +339,39 @@ 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 ***************