mirror/restic
1
0
Fork 0
mirror of https://github.com/restic/restic.git synced 2024-12-26 01:37:12 +00:00
Code Issues Releases Wiki Activity

Merge pull request #3136 from restic/rawtaz-copy-doc

Browse source 
doc: Emphasize double transfer and duplication in copy command
This commit is contained in:
Alexander Neumann 2020-11-29 13:57:10 +01:00 committed by GitHub
commit 04d856e601
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
cmd/restic/cmd_copy.go
View file

@ -14,12 +14,19 @@ var cmdCopy = &cobra.Command{
Use: "copy [flags] [snapshotID ...]", Use: "copy [flags] [snapshotID ...]",
Short: "Copy snapshots from one repository to another", Short: "Copy snapshots from one repository to another",
Long: ` Long: `
The "copy" command copies one or more snapshots from one repository to another The "copy" command copies one or more snapshots from one repository to another.
repository. Note that this will have to read (download) and write (upload) the
entire snapshot(s) due to the different encryption keys on the source and NOTE: This process will have to both download (read) and upload (write) the
destination, and that transferred files are not re-chunked, which may break entire snapshot(s) due to the different encryption keys used in the source and
their deduplication. This can be mitigated by the "--copy-chunker-params" destination repositories. This /may incur higher bandwidth usage and costs/ than
option when initializing a new destination repository using the "init" command. expected during normal backup runs.
NOTE: The copying process does not re-chunk files, which may break deduplication
between the files copied and files already stored in the destination repository.
This means that copied files, which existed in both the source and destination
repository, /may occupy up to twice their space/ in the destination repository.
This can be mitigated by the "--copy-chunker-params" option when initializing a
new destination repository using the "init" command.
`, `,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
return runCopy(copyOptions, globalOptions, args) return runCopy(copyOptions, globalOptions, args)

32
doc/045_working_with_repos.rst
View file

@ -106,12 +106,16 @@ The example command copies all snapshots from the source repository
Snapshots which have previously been copied between repositories will Snapshots which have previously been copied between repositories will
be skipped by later copy runs. be skipped by later copy runs.
.. note:: Note that this process will have to read (download) and write (upload) the .. important:: This process will have to both download (read) and upload (write)
entire snapshot(s) due to the different encryption keys used in the source and the entire snapshot(s) due to the different encryption keys used in the
destination repository. Also, the transferred files are not re-chunked, which source and destination repository. This *may incur higher bandwidth usage
may break deduplication between files already stored in the destination repo and costs* than expected during normal backup runs.
and files copied there using this command. See the next section for how to avoid
this problem. .. important:: The copying process does not re-chunk files, which may break
deduplication between the files copied and files already stored in the
destination repository. This means that copied files, which existed in
both the source and destination repository, *may occupy up to twice their
space* in the destination repository. See below for how to avoid this.
For the destination repository ``--repo2`` the password can be read from For the destination repository ``--repo2`` the password can be read from
a file ``--password-file2`` or from a command ``--password-command2``. a file ``--password-file2`` or from a command ``--password-command2``.
@ -121,12 +125,15 @@ pass the password via ``$RESTIC_PASSWORD2``. The key which should be used
for decryption can be selected by passing its ID via the flag ``--key-hint2`` for decryption can be selected by passing its ID via the flag ``--key-hint2``
or the environment variable ``$RESTIC_KEY_HINT2``. or the environment variable ``$RESTIC_KEY_HINT2``.
In case the source and destination repository use the same backend, then .. note:: In case the source and destination repository use the same backend,
configuration options and environment variables to configure the backend the configuration options and environment variables used to configure the
apply to both repositories. For example it might not be possible to specify backend may apply to both repositories – for example it might not be
different accounts for the source and destination repository. You can possible to specify different accounts for the source and destination
avoid this limitation by using the rclone backend along with remotes which repository. You can avoid this limitation by using the rclone backend
are configured in rclone. along with remotes which are configured in rclone.
Filtering snapshots to copy
---------------------------
The list of snapshots to copy can be filtered by host, path in the backup The list of snapshots to copy can be filtered by host, path in the backup
and / or a comma-separated tag list: and / or a comma-separated tag list:
@ -142,7 +149,6 @@ which case only these instead of all snapshots will be copied:
$ restic -r /srv/restic-repo copy --repo2 /srv/restic-repo-copy 410b18a2 4e5d5487 latest $ restic -r /srv/restic-repo copy --repo2 /srv/restic-repo-copy 410b18a2 4e5d5487 latest
Ensuring deduplication for copied snapshots Ensuring deduplication for copied snapshots
------------------------------------------- -------------------------------------------