2017-07-06 13:03:44 +02:00
|
|
|
// See cmd package.
|
|
|
|
|
package main
|
|
|
|
|
|
|
|
|
|
import (
|
2018-10-13 15:07:50 +02:00
|
|
|
"github.com/zrepl/zrepl/cli"
|
2018-08-29 22:06:24 +02:00
|
|
|
"github.com/zrepl/zrepl/client"
|
2020-03-27 20:37:17 +01:00
|
|
|
"github.com/zrepl/zrepl/client/status"
|
2018-08-27 19:10:55 +02:00
|
|
|
"github.com/zrepl/zrepl/daemon"
|
2017-07-06 13:03:44 +02:00
|
|
|
)
|
|
|
|
|
|
2018-08-27 19:10:55 +02:00
|
|
|
func init() {
|
2018-10-13 15:07:50 +02:00
|
|
|
cli.AddSubcommand(daemon.DaemonCmd)
|
2020-03-27 20:37:17 +01:00
|
|
|
cli.AddSubcommand(status.Subcommand)
|
2018-10-13 15:07:50 +02:00
|
|
|
cli.AddSubcommand(client.SignalCmd)
|
2021-03-21 19:00:59 +01:00
|
|
|
cli.AddSubcommand(client.WaitCmd)
|
2018-10-13 15:07:50 +02:00
|
|
|
cli.AddSubcommand(client.StdinserverCmd)
|
|
|
|
|
cli.AddSubcommand(client.ConfigcheckCmd)
|
|
|
|
|
cli.AddSubcommand(client.VersionCmd)
|
|
|
|
|
cli.AddSubcommand(client.PprofCmd)
|
2018-10-13 15:53:52 +02:00
|
|
|
cli.AddSubcommand(client.TestCmd)
|
2019-03-19 17:43:28 +01:00
|
|
|
cli.AddSubcommand(client.MigrateCmd)
|
endpoint: refactor, fix stale holds on initial replication failure, zfs-abstractions subcmd, more efficient ZFS queries
The motivation for this recatoring are based on two independent issues:
- @JMoVS found that the changes merged as part of #259 slowed his OS X
based installation down significantly.
Analysis of the zfs command logging introduced in #296 showed that
`zfs holds` took most of the execution time, and they pointed out
that not all of those `zfs holds` invocations were actually necessary.
I.e.: zrepl was inefficient about retrieving information from ZFS.
- @InsanePrawn found that failures on initial replication would lead
to step holds accumulating on the sending side, i.e. they would never
be cleaned up in the HintMostRecentCommonAncestor RPC handler.
That was because we only sent that RPC if there was a most recent
common ancestor detected during replication planning.
@InsanePrawn prototyped an implementation of a `zrepl zfs-abstractions release`
command to mitigate the situation.
As part of that development work and back-and-forth with @problame,
it became evident that the abstractions that #259 built on top of
zfs in package endpoint (step holds, replication cursor,
last-received-hold), were not well-represented for re-use in the
`zrepl zfs-abstractions release` subocommand prototype.
This commit refactors package endpoint to address both of these issues:
- endpoint abstractions now share an interface `Abstraction` that, among
other things, provides a uniform `Destroy()` method.
However, that method should not be destroyed directly but instead
the package-level `BatchDestroy` function should be used in order
to allow for a migration to zfs channel programs in the future.
- endpoint now has a query facitilty (`ListAbstractions`) which is
used to find on-disk
- step holds and bookmarks
- replication cursors (v1, v2)
- last-received-holds
By describing the query in a struct, we can centralized the retrieval
of information via the ZFS CLI and only have to be clever once.
We are "clever" in the following ways:
- When asking for hold-based abstractions, we only run `zfs holds` on
snapshot that have `userrefs` > 0
- To support this functionality, add field `UserRefs` to zfs.FilesystemVersion
and retrieve it anywhere we retrieve zfs.FilesystemVersion from ZFS.
- When asking only for bookmark-based abstractions, we only run
`zfs list -t bookmark`, not with snapshots.
- Currently unused (except for CLI) per-filesystem concurrent lookup
- Option to only include abstractions with CreateTXG in a specified range
- refactor `endpoint`'s various ZFS info retrieval methods to use
`ListAbstractions`
- rename the `zrepl holds list` command to `zrepl zfs-abstractions list`
- make `zrepl zfs-abstractions list` consume endpoint.ListAbstractions
- Add a `ListStale` method which, given a query template,
lists stale holds and bookmarks.
- it uses replication cursor has different modes
- the new `zrepl zfs-abstractions release-{all,stale}` commands can be used
to remove abstractions of package endpoint
- Adjust HintMostRecentCommonAncestor RPC for stale-holds cleanup:
- send it also if no most recent common ancestor exists between sender and receiver
- have the sender clean up its abstractions when it receives the RPC
with no most recent common ancestor, using `ListStale`
- Due to changed semantics, bump the protocol version.
- Adjust HintMostRecentCommonAncestor RPC for performance problems
encountered by @JMoVS
- by default, per (job,fs)-combination, only consider cleaning
step holds in the createtxg range
`[last replication cursor,conservatively-estimated-receive-side-version)`
- this behavior ensures resumability at cost proportional to the
time that replication was donw
- however, as explained in a comment, we might leak holds if
the zrepl daemon stops running
- that trade-off is acceptable because in the presumably rare
this might happen the user has two tools at their hand:
- Tool 1: run `zrepl zfs-abstractions release-stale`
- Tool 2: use env var `ZREPL_ENDPOINT_SENDER_HINT_MOST_RECENT_STEP_HOLD_CLEANUP_MODE`
to adjust the lower bound of the createtxg range (search for it in the code).
The env var can also be used to disable hold-cleanup on the
send-side entirely.
supersedes closes #293
supersedes closes #282
fixes #280
fixes #278
Additionaly, we fixed a couple of bugs:
- zfs: fix half-nil error reporting of dataset-does-not-exist for ZFSListChan and ZFSBookmark
- endpoint: Sender's `HintMostRecentCommonAncestor` handler would not
check whether access to the specified filesystem was allowed.
2020-03-26 23:43:17 +01:00
|
|
|
cli.AddSubcommand(client.ZFSAbstractionsCmd)
|
2018-08-27 19:10:55 +02:00
|
|
|
}
|
|
|
|
|
|
2017-07-06 13:03:44 +02:00
|
|
|
func main() {
|
2018-10-13 15:07:50 +02:00
|
|
|
cli.Run()
|
2017-07-06 13:03:44 +02:00
|
|
|
}
|
