Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #48

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update docs #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions HACKING.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ Hacking
Development setup
=================

Backy is intended to be compatible with Python 3.4. It is expected to work
Backy is intended to be compatible with Python 3.10. It is expected to work
properly on Linux and Mac OS X, even though specific backends may not be
available on all platforms. Use `zc.buildout` to get a development setup::
available on all platforms. Use `poetry` to get a development setup::

$ hg clone https://bitbucket.org/flyingcircus/backy
$ git clone https://github.com/flyingcircusio/backy.git
$ cd backy
$ virtualenv --python=python3.4 .
$ bin/pip install zc.buildout
$ bin/buildout
$ poetry install
or
$ nix develop


Running tests
Expand All @@ -24,17 +24,16 @@ Running tests
Backy has some end-to-end tests which take a while. To run only quick unit
tests::

$ bin/py.test
$ pytest -m "not slow"

To run all tests::

$ bin/py.test -m 1
$ pytest


Releasing
=========

Install `zest.releaser` on your workstation. Then use::
Install `zest.releaser` (`nix develop`) on your workstation. Then use::

$ fullrelease

Expand Down
24 changes: 14 additions & 10 deletions README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,16 @@ Restore the full image through a Pipe::

$ backy restore -r <revision> - | rbd import - <pool>/<rootimage>

Restoring individual files
--------------------------

Take a look at `backy-extract`_ to mount a backup via fuse and extract
single files.

Setting up backy
----------------

#. Create a sufficiently large backup partition using a COW-capable filesystem
like btrfs and mount it under `/srv/backy`.
#. Create a sufficiently large backup partition and mount it under `/srv/backy`.

#. Create a configuration file at `/etc/backy.conf`. See man page for details.

Expand All @@ -63,7 +67,7 @@ Setting up backy

The scheduler runs in the foreground until it is shot by SIGTERM.

#. Set up monitoring using `backy check`.
#. Set up monitoring using `backy client -c /path/to/backy.conf check`.

#. Set up log rotation for `/var/log/backy.conf` and `/srv/backy/*/backy.log`.

Expand All @@ -77,13 +81,13 @@ Features
Self-check
----------

Backy includes a self-checking facility. Invoke `backy check` to see if there is
a recent revision present for all configured backup jobs::
Backy includes a self-checking facility. Invoke `backy client check` to see if
there is a recent revision present for all configured backup jobs::

$ backy check
OK: 9 jobs within SLA
$ backy client check
[...] CLIClient/check-exit exitcode=0 jobs=9

Both output and exit code are suited for processing with Nagios-compatible
The exit code is suited for processing with Nagios-compatible
monitoring systems.


Expand Down Expand Up @@ -188,9 +192,9 @@ GPLv3
Links
=====

* `Bitbucket repository <https://bitbucket.org/flyingcircus/backy>`_
* `Github repository <https://github.com/flyingcircusio/backy>`_
* `PyPI page <https://pypi.python.org/pypi/backy>`_
* `Online docs <http://pythonhosted.org/backy/>`_
* `Build server <https://builds.flyingcircus.io/job/backy/>`_
* `backy-extract <https://github.com/flyingcircusio/backy-extract>`_

.. vim: set ft=rst spell spelllang=en sw=3:
Loading
Loading