Project

General

Profile

Bug #16203

Suggest improving Guide text re recursive snapshotting and replication

Added by Jim Worrall over 3 years ago. Updated about 3 years ago.

Status:
Resolved
Priority:
Nice to have
Assignee:
Warren Block
Category:
Documentation
Target version:
Severity:
New
Reason for Closing:
Reason for Blocked:
Needs QA:
Yes
Needs Doc:
Yes
Needs Merging:
Yes
Needs Automation:
No
Support Suite Ticket:
n/a
Hardware Configuration:
ChangeLog Required:
No

Description

I suggest improvements in the Guide to the descriptions of what happens when you check the 'recursive' boxes for snapshots and replication. It is currently unclear to me and others. Snapshot recursion was recently explained to me, so I have a suggested change for that, but I still don't know about replication recursion. At least I can point out the ambiguity.

Table 8.2a: Options When Creating a Periodic Snapshot
Recursive Snapshots

What it says:
"Select this box to take separate snapshots of the volume/dataset and each of its child datasets; if unchecked, only one snapshot is taken of the specified Volume/Dataset."

How it can be interpreted:
"Select this box to take separate snapshots of the volume/dataset and each of its child datasets; if unchecked, only one snapshot is taken of the specified Volume/Dataset, and that snapshot will include the child datasets."

How it might be rephrased (if this is correct):
"Select this box to take separate snapshots of the volume/dataset and each of its child datasets. If unchecked, a single snapshot is taken of only the selected volume or dataset, without any child datasets."

Table 8.3a: Adding a Replication Task

Recursive Replications

What it says:
"if checked will also replicate child datasets"

I don't know enough about the behavior to recommend a more detailed explanation, but that is needed. How is this related to recursive snapshots? When checking this box, will child datasets be replicated even if only the parent dataset is snapshotted (ie, snapshots of the parent not done recursively)? Or, for recursive replication to work as expected, must all the child datasets have snapshots also?

If the latter is true, I might suggest:
"If checked, child datasets will also be replicated. Each dataset in the hierarchy must have a periodic snapshot for replication to work. These can be done as separate periodic snapshot tasks or as a single task with the recursive box checked."

History

#1 Updated by Dru Lavigne over 3 years ago

  • Status changed from Unscreened to Screened

#2 Updated by Warren Block over 3 years ago

  • % Done changed from 0 to 50

updated periodic snapshot description in docs

#3 Updated by Vaibhav Chauhan about 3 years ago

do we gave a target version for this change ?

#4 Updated by Dru Lavigne about 3 years ago

  • Target version set to 9.10.1-U3

I still have to talk to Josh about the second half of the doc change, so let's say U3.

#5 Updated by Dru Lavigne about 3 years ago

  • Assignee changed from Dru Lavigne to Warren Block

#6 Avatar?id=14398&size=24x24 Updated by Kris Moore about 3 years ago

  • Target version changed from 9.10.1-U3 to 9.10.2

#7 Avatar?id=14398&size=24x24 Updated by Kris Moore about 3 years ago

  • Priority changed from No priority to Nice to have

#8 Updated by Vaibhav Chauhan about 3 years ago

can this be marked RFR ?

#9 Updated by Warren Block about 3 years ago

Vaibhav Chauhan wrote:

can this be marked RFR ?

I committed an update just now which I think addresses this bug although maybe not in the way the reporter suggested (https://github.com/freenas/freenas-docs/commit/f3d20eb651ab39c5de3d82842b85aff006cfb2be). Please review.

#10 Updated by Warren Block about 3 years ago

  • Status changed from Screened to Resolved

Also available in: Atom PDF