Changeset View
Changeset View
Standalone View
Standalone View
head/sysutils/zrepl/files/pkg-message.in
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ||||
| zrepl must be configured before it is started the first time. | Messages from sysutils/zrepl: | ||||
| SETUP BEFORE FIRST USE: | |||||
| - Create the log file /var/log/zrepl.log: | - Create the log file /var/log/zrepl.log: | ||||
| # service newsyslog restart | # service newsyslog restart | ||||
| - Teach syslogd to redirect facility local0 to the zrepl.log file: | - Teach syslogd to redirect facility local0 to the zrepl.log file: | ||||
| # service syslogd reload | # service syslogd reload | ||||
| - Modify the %%PREFIX%%/etc/zrepl/zrepl.yml configuration file | - Modify the %%PREFIX%%/etc/zrepl/zrepl.yml configuration file | ||||
| - For remote backups, create the SSH key pair and authorized_keys file | - For remote backups, create the SSH key pair and authorized_keys file | ||||
| - Enable the zrepl daemon to start automatically at boot: | - Enable the zrepl daemon to start automatically at boot: | ||||
| # sysrc zrepl_enable="YES" | # sysrc zrepl_enable="YES" | ||||
| - Start the zrepl daemon: | - Start the zrepl daemon: | ||||
| # service zrepl start | # service zrepl start | ||||
| For documentation, refer to https://zrepl.github.io/. | Documentation: https://zrepl.github.io/ | ||||
| Changelog: https://zrepl.github.io/master/changelog.html | |||||
| *** BREAKING CHANGES WITH THE 0.0.3 RELEASE: *** | WARNING - BREAKING CHANGES WITH THE ZREPL 0.1.X RELEASE: | ||||
| - Snapshots are automatically bookmarked and pruning of bookmarks must | There are a number of breaking changes this release. To ensure zrepl | ||||
| be configured by adding the keep_bookmarks parameter to the prune | continues to function correctly, ensure you read the changelog, and then | ||||
| policy section of the zrepl configuration file (source side only). | perform the following on both sides of the replication: | ||||
| Be sure to understand the meaning bookmarks have for maximum | - Stop the zrepl service: # service zrepl stop | ||||
| allowable replication downtime. | - Upgrade the zrepl package: # pkg upgrade zrepl | ||||
| - The ssh+stdinserver transport protocol has changed, requiring zrepl | - Modify the zrepl config: # vi %%PREFIX%%/etc/zrepl/zrepl.yml | ||||
| to be updates on both the sending and receiving side, and the daemon | - Check the configuration: # service zrepl configtest | ||||
| restarted on both sides. | - Start the zrepl service: # service zrepl start | ||||
| - The first outlet in the global.logging section of the configuration | - Monitor the zrepl service: # zrepl status | ||||
| file is now used for logging meta-errors (e.g. problems encountered | |||||
| when writing to other logging outlets). | DANGER - SNAPSHOT PRUNING REQUIRES EXPLICIT KEEP RULES: | ||||
| For any ZFS snapshot that you want to keep, at least one rule must match. This | |||||
| is different from previous releases where pruning only affected snapshots with | |||||
| the configured snapshotting prefix. Make sure that snapshots to be kept or | |||||
| ignored by zrepl are covered, e.g. by using the regex keep rule. | |||||
| This also applies to snapshots taken by means other than zrepl (e.g. manually). | |||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ||||