Skip to content

Commit aeeb430

Browse files
committed
docs(managing_deis): use non-forked s3cmd
We no longer need to maintain the Deis fork of s3cmd, as the necessary patches for Ceph have been merged upstream. When this commit is merged, we should delete https://github.com/deis/s3cmd
1 parent fe23bec commit aeeb430

1 file changed

Lines changed: 9 additions & 15 deletions

File tree

docs/managing_deis/backing_up_data.rst

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,8 @@ Setup
2828
-----
2929

3030
The ``deis-store-gateway`` component exposes an S3-compatible API, so we can use a tool like `s3cmd`_
31-
to work with the object store. First, install our fork of s3cmd with a patch for Ceph support:
32-
33-
.. code-block:: console
34-
35-
$ pip install git+https://github.com/deis/s3cmd
31+
to work with the object store. First, `download s3cmd`_ and install it (you'll need at least version
32+
1.5.0 for Ceph support).
3633

3734
We'll need the generated access key and secret key for use with the gateway. We can get these using
3835
``deisctl``, either on one of the cluster machines or on a remote machine with ``DEISCTL_TUNNEL`` set:
@@ -43,23 +40,19 @@ We'll need the generated access key and secret key for use with the gateway. We
4340
$ deisctl config store get gateway/secretKey
4441
4542
Back on the local machine, run ``s3cmd --configure`` and enter your access key and secret key.
46-
Other settings can be left at the defaults. If the configure script prompts you to test the credentials,
47-
skip that step - it will try to authenticate against Amazon S3 and fail.
4843

49-
You'll need to change a few additional configuration settings. First, edit ``~/.s3cfg`` and change
44+
When prompted with the ``Use HTTPS protocol`` option, answer ``No``. Other settings can be left at
45+
the defaults. If the configure script prompts to test the credentials, skip that step - it will
46+
try to authenticate against Amazon S3 and fail.
47+
48+
You'll need to change two configuration settings - edit ``~/.s3cfg`` and change
5049
``host_base`` and ``host_bucket`` to match ``deis-store.<your domain>``. For example, for my local
5150
Vagrant setup, I've changed the lines to:
5251

5352
.. code-block:: console
5453
5554
host_base = deis-store.local3.deisapp.com
56-
host_bucket = deis-store.local3.deisapp.com/%(bucket)
57-
58-
You'll also need to enable ``use_path_mode``:
59-
60-
.. code-block:: console
61-
62-
use_path_mode = True
55+
host_bucket = deis-store.local3.deisapp.com
6356
6457
We can now use ``s3cmd`` to back up and restore data from the store-gateway.
6558

@@ -224,4 +217,5 @@ use in the ``export`` command should correspond to the IP of the host machine wh
224217
That's it! The cluster should be fully restored.
225218

226219
.. _`Ceph`: http://ceph.com
220+
.. _`download s3cmd`: http://s3tools.org/download
227221
.. _`s3cmd`: http://s3tools.org/

0 commit comments

Comments
 (0)