VMBackup: Document vmbackup.conf options including df -kl local flag#2180
Open
jonathanbrenes wants to merge 1 commit into
Open
VMBackup: Document vmbackup.conf options including df -kl local flag#2180jonathanbrenes wants to merge 1 commit into
jonathanbrenes wants to merge 1 commit into
Conversation
Document user-facing configuration options in README.txt and the template vmbackup.conf. This addresses the lack of documentation for the onlyLocalFilesystems option originally introduced in PR Azure#1562 ("Fix local filesystems size calculation"), which added the 'df -kl' flag to restrict size calculation to local filesystems only and prevent hangs on unreachable network mounts. Documented options: - fsfreeze: filesystem freeze before snapshot - onlyLocalFilesystems: use 'df -kl' instead of 'df -k' (PR Azure#1562) - MountsToSkip: mount points to exclude from freeze - seqsnapshot: parallel vs sequential snapshot ordering Also added commented-out examples with descriptions to the template vmbackup.conf so options are discoverable without reading the code.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the user-facing configuration options available in
/etc/azure/vmbackup.conf, which were previously undocumented outside of inline code comments.This was prompted by the
onlyLocalFilesystemsoption introduced in PR #1562, which switchesdf -ktodf -klto prevent the size calculation from hanging when network mounts (NFS, CIFS, FUSE, etc.) are unreachable or slow. That option had no documentation in the README or the template config file, making it essentially undiscoverable.What's documented
fsfreezeonlyLocalFilesystemsdf -klto avoid hangs on network mounts (PR #1562)MountsToSkipseqsnapshotChanges
Impact
Documentation-only change. No behavior changes.