diff --git a/docs/changelog.rst b/docs/changelog.rst index 627daa4..672cd61 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -42,8 +42,7 @@ Notes to Package Maintainers * If the daemon crashes, the stack trace produced by the Go runtime and possibly diagnostic output of zrepl will be written to stderr. This behavior is independent from the ``stdout`` outlet type. - Please make sure the stderr output of the daemon is captured to a file. - Rotation should not be necessary because stderr is not written to under normal circumstances. + Please make sure the stderr output of the daemon is captured somewhere. To conserve precious stack traces, make sure that multiple service restarts do not directly discard previous stderr output. * Make it obvious for users how to set the ``GOTRACEBACK`` environment variable to ``GOTRACEBACK=crash``. This functionality will cause SIGABRT on panics and can be used to capture a coredump of the panicking process. @@ -59,10 +58,10 @@ Changes * |feature| :issue:`55` : Push replication (see :ref:`push job ` and :ref:`sink job `) * |feature| :ref:`TCP Transport ` * |feature| :ref:`TCP + TLS client authentication transport ` -* |feature| :issue:`78` TODO MERGE COMMIT Replication protocol rewrite +* |feature| :issue:`78` :commit:`074f989` : Replication protocol rewrite * Uses ``github.com/problame/go-streamrpc`` for RPC layer - * |break| zrepl 0.1 and restart on both sides of a replication setup is required + * |break| Protocol breakage, update and restart of all zrepl daemons is required * |feature| :issue:`83`: Improved error handling of network-level errors (zrepl retries instead of failing the entire job) * |bugfix| :issue:`75` :issue:`81`: use connection timeouts and protocol-level heartbeats * |break| |break_config|: mappings are no longer supported @@ -74,7 +73,8 @@ Changes * |feature| :issue:`69`: include manually created snapshots in replication * |break_config| ``manual`` and ``periodic`` :ref:`snapshotting types ` - * |feature| ``zrepl wakeup JOB`` subcommand to trigger *just* replication + * |feature| ``zrepl signal wakeup JOB`` subcommand to trigger replication + pruning + * |feature| ``zrepl signal reset JOB`` subcommand to abort current replication + pruning * |feature| |break| |break_config| New pruning system @@ -88,7 +88,7 @@ Changes * |feature| |break| Bookmark pruning is no longer necessary * Per filesystem, zrepl creates a single bookmark (``#zrepl_replication_cursor``) and moves it forward with the most recent successfully replicated snapshot on the receiving side. - * Old bookmarks created prior to zrepl 0.1 (named like their corresponding snapshot) must be deleted manually. + * Old bookmarks created by prior versions of zrepl (named like their corresponding snapshot) must be deleted manually. * |break_config| ``keep_bookmarks`` parameter of the ``grid`` keep rule has been removed * |feature| ``zrepl status`` for live-updating replication progress (it's really cool!) diff --git a/docs/configuration/jobs.rst b/docs/configuration/jobs.rst index cdbafba..a7bdcae 100644 --- a/docs/configuration/jobs.rst +++ b/docs/configuration/jobs.rst @@ -140,7 +140,7 @@ There is also a ``manual`` snapshotting type, which covers the following use cas * Run scripts before and after taking snapshots (like locking database tables). We are working on better integration for this use case: see :issue:`74`. -Note that you will have to trigger replication manually using the ``zrepl wakeup JOB`` subcommand in that case. +Note that you will have to trigger replication manually using the ``zrepl signal wakeup JOB`` subcommand in that case. :: diff --git a/docs/usage.rst b/docs/usage.rst index 3bddfab..9d086a0 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -27,8 +27,10 @@ CLI Overview - show job activity, or with ``--raw`` for JSON output * - ``zrepl stdinserver`` - see :ref:`transport-ssh+stdinserver` - * - ``zrepl wakeup JOB`` - - manually trigger replication + pruning + * - ``zrepl signal wakeup JOB`` + - manually trigger replication + pruning of JOB + * - ``zrepl signal reset JOB`` + - manually abort current replication + pruning of JOB * - ``zrepl configcheck`` - check if config can be parsed without errors