Editing Man/ploop.8
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 20: | Line 20: | ||
[<b>-t </b><i>fstype</i>] | [<b>-t </b><i>fstype</i>] | ||
[<b>-b </b><i>blocksize</i>] | [<b>-b </b><i>blocksize</i>] | ||
− | [<b>-B </b><i>fsblocksize</i>] | + | [<b>-B </b><i>fsblocksize</i>] <i>delta_file</i></p></td></tr> |
− | <i>delta_file</i></p> </td></tr> | ||
<tr valign="top" align="left"> | <tr valign="top" align="left"> | ||
<td width="11%"></td> | <td width="11%"></td> | ||
Line 73: | Line 72: | ||
<p style="margin-top: 1em">{ <b>-u</b> <i>uuid</i> | | <p style="margin-top: 1em">{ <b>-u</b> <i>uuid</i> | | ||
<b>-l</b> <i>level</i> | <b>-o</b> <i>cur_image_file</i> } | <b>-l</b> <i>level</i> | <b>-o</b> <i>cur_image_file</i> } | ||
− | + | <b>-i</b> <i>image_file DiskDescriptor.xml</i></p></td></tr> | |
− | DiskDescriptor.xml</i></p> </td></tr> | ||
<tr valign="top" align="left"> | <tr valign="top" align="left"> | ||
<td width="11%"></td> | <td width="11%"></td> | ||
Line 102: | Line 100: | ||
</table> | </table> | ||
− | <p style="margin-left:11%;">[<b>-u </b><i> | + | <p style="margin-left:11%;">[<b>-u </b><i>UUID</i>] |
<i>DiskDescriptor.xml</i></p> | <i>DiskDescriptor.xml</i></p> | ||
Line 126: | Line 124: | ||
<td width="72%"> | <td width="72%"> | ||
− | <p style="margin-top: 1em">[<b>-s | + | <p style="margin-top: 1em">[<b>-s</b>] |
<i>DiskDescriptor.xml</i></p> </td></tr> | <i>DiskDescriptor.xml</i></p> </td></tr> | ||
<tr valign="top" align="left"> | <tr valign="top" align="left"> | ||
Line 158: | Line 156: | ||
<p style="margin-top: 1em"><b>ploop snapshot-merge</b></p> </td> | <p style="margin-top: 1em"><b>ploop snapshot-merge</b></p> </td> | ||
− | <td width=" | + | <td width="51%"> |
− | <p style="margin-top: 1em">[<b>-u </b><i>uuid </i> | + | <p style="margin-top: 1em">[<b>-u </b><i>uuid </i>| <b>-A</b>] |
− | + | <i>DiskDescriptor.xml</i></p> </td> | |
− | + | <td width="6%"> | |
+ | </td></tr> | ||
<tr valign="top" align="left"> | <tr valign="top" align="left"> | ||
<td width="11%"></td> | <td width="11%"></td> | ||
Line 168: | Line 167: | ||
<p style="margin-top: 1em"><b>ploop snapshot-switch</b></p> </td> | <p style="margin-top: 1em"><b>ploop snapshot-switch</b></p> </td> | ||
− | <td width=" | + | <td width="51%"> |
<p style="margin-top: 1em"><b>-u</b> <i>uuid | <p style="margin-top: 1em"><b>-u</b> <i>uuid | ||
− | DiskDescriptor.xml</i></p> </td></tr> | + | DiskDescriptor.xml</i></p> </td> |
+ | <td width="6%"> | ||
+ | </td></tr> | ||
<tr valign="top" align="left"> | <tr valign="top" align="left"> | ||
<td width="11%"></td> | <td width="11%"></td> | ||
Line 177: | Line 178: | ||
<p style="margin-top: 1em"><b>ploop snapshot-delete</b></p> </td> | <p style="margin-top: 1em"><b>ploop snapshot-delete</b></p> </td> | ||
− | <td width=" | + | <td width="51%"> |
<p style="margin-top: 1em"><b>-u</b> <i>uuid | <p style="margin-top: 1em"><b>-u</b> <i>uuid | ||
− | DiskDescriptor.xml</i></p> </td></tr> | + | DiskDescriptor.xml</i></p> </td> |
+ | <td width="6%"> | ||
+ | </td></tr> | ||
<tr valign="top" align="left"> | <tr valign="top" align="left"> | ||
<td width="11%"></td> | <td width="11%"></td> | ||
Line 186: | Line 189: | ||
<p style="margin-top: 1em"><b>ploop snapshot-list</b></p> </td> | <p style="margin-top: 1em"><b>ploop snapshot-list</b></p> </td> | ||
− | <td width=" | + | <td width="51%"></td> |
+ | <td width="6%"> | ||
</td></tr> | </td></tr> | ||
</table> | </table> | ||
Line 203: | Line 207: | ||
<p style="margin-top: 1em"><b>ploop copy</b></p></td> | <p style="margin-top: 1em"><b>ploop copy</b></p></td> | ||
<td width="2%"></td> | <td width="2%"></td> | ||
− | <td width=" | + | <td width="57%"> |
<p style="margin-top: 1em"><b>-s</b> <i>device</i> | <p style="margin-top: 1em"><b>-s</b> <i>device</i> | ||
− | [<b>-F </b><i>stop_command</i>] | + | [<b>-F </b><i>stop_command</i>] |
− | [<b>-d </b><i>file</i>] | + | [<b>-d </b><i>file</i>]</p> </td> |
− | + | <td width="15%"> | |
− | + | </td></tr> | |
<tr valign="top" align="left"> | <tr valign="top" align="left"> | ||
<td width="11%"></td> | <td width="11%"></td> | ||
Line 216: | Line 220: | ||
<p style="margin-top: 1em"><b>ploop copy</b></p></td> | <p style="margin-top: 1em"><b>ploop copy</b></p></td> | ||
<td width="2%"></td> | <td width="2%"></td> | ||
− | <td width=" | + | <td width="57%"> |
− | <p style="margin-top: 1em"><b>-d</b> <i>file</i> | + | <p style="margin-top: 1em"><b>-d</b> <i>file</i></p></td> |
− | + | <td width="15%"> | |
− | + | </td></tr> | |
</table> | </table> | ||
Line 228: | Line 232: | ||
<p style="margin-top: 1em"><b>ploop balloon discard</b></p> <td width="45%"></td> | <p style="margin-top: 1em"><b>ploop balloon discard</b></p> <td width="45%"></td> | ||
− | <td width=" | + | <td width="55%"> |
<p style="margin-top: 1em">[<b>--automount</b>] | <p style="margin-top: 1em">[<b>--automount</b>] | ||
[<b>--to-free </b><i>size</i>] | [<b>--to-free </b><i>size</i>] | ||
− | [<b>--min-block </b><i>min_size</i | + | [<b>--min-block </b><i>min_size</i>] |
− | <i>DiskDescriptor.xml | + | <i>DiskDescriptor.xml</i></p> </td></tr> |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</table> | </table> | ||
Line 305: | Line 295: | ||
[<b>-t </b><i>fstype</i>] | [<b>-t </b><i>fstype</i>] | ||
[<b>-b </b><i>blocksize</i>] | [<b>-b </b><i>blocksize</i>] | ||
− | [<b>-B </b><i>fsblocksize</i>] | + | [<b>-B </b><i>fsblocksize</i>] <i>delta_file</i></p></td></tr> |
− | <i>delta_file</i></p> </td></tr> | ||
<tr valign="top" align="left"> | <tr valign="top" align="left"> | ||
<td width="11%"></td> | <td width="11%"></td> | ||
Line 360: | Line 349: | ||
<p style="margin-left:28%;">Filesystem block size, in | <p style="margin-left:28%;">Filesystem block size, in | ||
bytes. Default is 4096 bytes.</p> | bytes. Default is 4096 bytes.</p> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<table width="100%" border="0" rules="none" frame="void" | <table width="100%" border="0" rules="none" frame="void" | ||
Line 613: | Line 594: | ||
<p style="margin-top: 1em">{ <b>-u</b> <i>uuid</i> | | <p style="margin-top: 1em">{ <b>-u</b> <i>uuid</i> | | ||
<b>-l</b> <i>level</i> | <b>-o</b> <i>cur_image_file</i> } | <b>-l</b> <i>level</i> | <b>-o</b> <i>cur_image_file</i> } | ||
− | + | <b>-i</b> <i>image_file DiskDescriptor.xml</i></p></td></tr> | |
− | DiskDescriptor.xml</i></p> </td></tr> | ||
<tr valign="top" align="left"> | <tr valign="top" align="left"> | ||
<td width="11%"></td> | <td width="11%"></td> | ||
Line 641: | Line 621: | ||
<p style="margin-left:32%;">A current image file (the one | <p style="margin-left:32%;">A current image file (the one | ||
to replace).</p> | to replace).</p> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<table width="100%" border="0" rules="none" frame="void" | <table width="100%" border="0" rules="none" frame="void" | ||
Line 764: | Line 735: | ||
<td width="43%"> | <td width="43%"> | ||
− | <p style="margin-top: 1em">[<b>-u </b><i> | + | <p style="margin-top: 1em">[<b>-u </b><i>UUID</i>] |
<i>DiskDescriptor.xml</i></p> </td> | <i>DiskDescriptor.xml</i></p> </td> | ||
<td width="28%"> | <td width="28%"> | ||
Line 772: | Line 743: | ||
<p style="margin-top: 1em">Check all the images in | <p style="margin-top: 1em">Check all the images in | ||
<i>DiskDescriptor.xml</i> up to the one denoted by the | <i>DiskDescriptor.xml</i> up to the one denoted by the | ||
− | <i> | + | <i>UUID</i> (or default top delta, if UUID is not |
specified). Default built-in check options are used, and the | specified). Default built-in check options are used, and the | ||
ones specified on the command line, if any, are ignored.</p> | ones specified on the command line, if any, are ignored.</p> | ||
Line 891: | Line 862: | ||
</table> | </table> | ||
− | <p> | + | <p>Show information about disk space and inodes usage and |
− | disk space and inodes usage and limits on the inner ploop | + | limits on the inner ploop filesystem, somewhat similar to |
− | filesystem, somewhat similar to [[Man/vzquota.8|<b>vzquota</b>(8)]] | + | [[Man/vzquota.8|<b>vzquota</b>(8)]] <b>stat</b> or <b>show</b> commands.</p> |
− | <b>stat</b> or <b>show</b> commands.</p> | ||
<table width="100%" border="0" rules="none" frame="void" | <table width="100%" border="0" rules="none" frame="void" | ||
Line 904: | Line 874: | ||
<p style="margin-top: 1em"><b>ploop info</b></p></td> | <p style="margin-top: 1em"><b>ploop info</b></p></td> | ||
<td width="2%"></td> | <td width="2%"></td> | ||
− | <td width=" | + | <td width="32%"> |
− | <p style="margin-top: 1em"> | + | <p style="margin-top: 1em"><b>-s</b> |
<i>DiskDescriptor.xml</i></p> </td> | <i>DiskDescriptor.xml</i></p> </td> | ||
− | <td width=" | + | <td width="40%"> |
</td></tr> | </td></tr> | ||
</table> | </table> | ||
− | <p> | + | <p>Show information about ploop device size, block size, |
− | + | and format version.</p> | |
− | size, block size, and format version | ||
− | |||
− | |||
==== list ==== | ==== list ==== | ||
Line 940: | Line 907: | ||
column).</p> | column).</p> | ||
− | === | + | === Working with snapshots === |
− | + | <p style="margin-top: 1em">Ploop snapshots is a mechanism | |
− | + | for creating and managing instant states of a running file | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | <p style="margin-top: 1em">Ploop snapshots is a mechanism | ||
− | for creating and managing instant states of a running file | ||
system. Creating a snapshot leads to creating a new empty | system. Creating a snapshot leads to creating a new empty | ||
ploop image which is layered on top of an old one, then all | ploop image which is layered on top of an old one, then all | ||
Line 984: | Line 920: | ||
<p style="margin-top: 1em">Snapshots are identified by a | <p style="margin-top: 1em">Snapshots are identified by a | ||
unique UUID. A snapshot can be mounted using <b>ploop mount | unique UUID. A snapshot can be mounted using <b>ploop mount | ||
− | -u</b> <i> | + | -u</b> <i>UUID</i> command, see above.</p> |
==== snapshot ==== | ==== snapshot ==== | ||
Line 1,019: | Line 955: | ||
<p style="margin-top: 1em">Merge a snapshot with its | <p style="margin-top: 1em">Merge a snapshot with its | ||
− | + | parent.</p> | |
− | |||
− | |||
− | |||
− | |||
− | |||
<table width="100%" border="0" rules="none" frame="void" | <table width="100%" border="0" rules="none" frame="void" | ||
Line 1,036: | Line 967: | ||
<td width="57%"> | <td width="57%"> | ||
− | <p style="margin-top: 1em">[<b>-u </b><i>uuid </i> | + | <p style="margin-top: 1em">[<b>-u </b><i>uuid </i>| <b>-A</b>] |
− | |||
<i>DiskDescriptor.xml</i></p> </td></tr> | <i>DiskDescriptor.xml</i></p> </td></tr> | ||
<tr valign="top" align="left"> | <tr valign="top" align="left"> | ||
Line 1,047: | Line 977: | ||
<td width="57%"> | <td width="57%"> | ||
− | <p>Specify a | + | <p>Specify a snapshot <i>uuid</i> to merge. If this option |
− | + | is not specified, the top delta will be used.</p></td></tr> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<tr valign="top" align="left"> | <tr valign="top" align="left"> | ||
<td width="11%"></td> | <td width="11%"></td> | ||
Line 1,071: | Line 990: | ||
snapshots have more than a single child, they will be | snapshots have more than a single child, they will be | ||
impossible to merge.</p></td></tr> | impossible to merge.</p></td></tr> | ||
− | + | </table> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | </table> | ||
==== snapshot-switch ==== | ==== snapshot-switch ==== | ||
Line 1,235: | Line 1,142: | ||
<p style="margin-top: 1em"><b>ploop copy</b></p></td> | <p style="margin-top: 1em"><b>ploop copy</b></p></td> | ||
<td width="2%"></td> | <td width="2%"></td> | ||
− | <td width=" | + | <td width="57%"> |
<p style="margin-top: 1em"><b>-s</b> <i>device</i> | <p style="margin-top: 1em"><b>-s</b> <i>device</i> | ||
− | [<b>-F </b><i>stop_command</i>] | + | [<b>-F </b><i>stop_command</i>] |
− | [<b>-d </b><i>file</i>] | + | [<b>-d </b><i>file</i>]</p> </td> |
− | + | <td width="15%"> | |
− | + | </td></tr> | |
</table> | </table> | ||
Line 1,247: | Line 1,154: | ||
in-kernel write tracker for the specified ploop | in-kernel write tracker for the specified ploop | ||
<i>device,</i> then sends all the data blocks from the top | <i>device,</i> then sends all the data blocks from the top | ||
− | delta image to | + | delta image to stdout (supposedly read by destination |
− | + | <b>ploop copy</b>) or a <i>file</i>. After that, it | |
− | supposedly read by destination <b>ploop copy</b> | + | iteratively gets the list of the modified data blocks from |
− | <i>file</i>. After that, it iteratively gets the list of the | + | the kernel and sends those blocks again. After a number of |
− | modified data blocks from the kernel and sends those blocks | + | iterations (or when the list is empty), it executes the |
− | again. After a number of iterations (or when the list is | + | <i>stop_command</i> (this could be <b>vzctl stop</b> or |
− | empty), it executes the <i>stop_command</i> (this could be | + | <b>vzctl chkpnt</b>) and does the last iteration of sending |
− | <b>vzctl stop</b> or <b>vzctl chkpnt</b>) and does the last | + | the modified data blocks. Finally, it checks that the data |
− | iteration of sending the modified data blocks. Finally, it | + | were not modified, error is returned otherwise.</p> |
− | checks that the data were not modified, error is returned | ||
− | otherwise | ||
− | |||
− | |||
− | |||
− | |||
− | |||
==== copy (receiving) ==== | ==== copy (receiving) ==== | ||
Line 1,274: | Line 1,174: | ||
<p style="margin-top: 1em"><b>ploop copy</b></p></td> | <p style="margin-top: 1em"><b>ploop copy</b></p></td> | ||
<td width="2%"></td> | <td width="2%"></td> | ||
− | <td width=" | + | <td width="10%"> |
− | <p style="margin-top: 1em"><b>-d</b> <i>file</i> | + | <p style="margin-top: 1em"><b>-d</b> <i>file</i></p></td> |
− | + | <td width="62%"> | |
− | |||
− | <td width=" | ||
</td></tr> | </td></tr> | ||
</table> | </table> | ||
− | <p style="margin-top: 1em">Reads the data | + | <p style="margin-top: 1em">Reads the data block (provided |
− | by the source <b>ploop copy</b>) from the | + | by the source <b>ploop copy</b>) from the <b>stdin</b> and |
− | |||
writes them to the <i>file</i>.</p> | writes them to the <i>file</i>.</p> | ||
− | |||
− | |||
− | |||
− | |||
=== Ballooning === | === Ballooning === | ||
Line 1,326: | Line 1,219: | ||
is hidden from the end user, so while a number of low-level | is hidden from the end user, so while a number of low-level | ||
commands exist for working with ploop ballooning, those are | commands exist for working with ploop ballooning, those are | ||
− | not needed and therefore are not documented here, except for | + | not needed and therefore are not documented here, except for |
− | a single command.</p> | + | a single command.</p> |
− | + | ||
− | ==== balloon discard ==== | + | ==== balloon discard ==== |
− | + | ||
− | <p style="margin-top: 1em">In a situation when a lot of | + | <p style="margin-top: 1em">In a situation when a lot of |
− | disk space were freed on an in-ploop filesystem, use | + | disk space were freed on an in-ploop filesystem, use |
− | <b>ploop balloon discard</b> to optimize the ploop image | + | <b>ploop balloon discard</b> to optimize the ploop image |
− | size.</p> | + | size.</p> |
− | + | ||
− | <table width="100%" border="0" rules="none" frame="void" | + | <table width="100%" border="0" rules="none" frame="void" |
− | cellspacing="0" cellpadding="0"> | + | cellspacing="0" cellpadding="0"> |
− | <tr valign="top" align="left"> | + | <tr valign="top" align="left"> |
− | <td width="11%"></td> | + | <td width="11%"></td> |
− | <td width="32%"> | + | <td width="32%"> |
− | + | ||
− | <p style="margin-top: 1em"><b>ploop balloon discard</b></p> </td> | + | <p style="margin-top: 1em"><b>ploop balloon discard</b></p> </td> |
− | <td width="2%"></td> | + | <td width="2%"></td> |
− | <td width=" | + | <td width="55%"> |
− | + | ||
− | <p style="margin-top: 1em">[<b>--automount</b>] | + | <p style="margin-top: 1em">[<b>--automount</b>] |
− | [<b>--to-free </b><i>size</i>] | + | [<b>--to-free </b><i>size</i>] |
− | [<b>--min-block </b><i>min_size</i | + | [<b>--min-block </b><i>min_size</i>] |
− | <i>DiskDescriptor.xml</i></p> | + | <i>DiskDescriptor.xml</i></p> </td></tr> |
− | |||
− | </td></tr> | ||
</table> | </table> | ||
Line 1,362: | Line 1,253: | ||
<b>--automount</b> option to automatically mount ploop for | <b>--automount</b> option to automatically mount ploop for | ||
the duration of the operation.</p> | the duration of the operation.</p> | ||
− | |||
− | |||
− | |||
− | |||
<p style="margin-top: 1em">Option <b>--to-free</b> can be | <p style="margin-top: 1em">Option <b>--to-free</b> can be | ||
Line 1,589: | Line 1,476: | ||
<p style="margin-left:22%;">Error from <b>fsck</b>(8).</p> | <p style="margin-left:22%;">Error from <b>fsck</b>(8).</p> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
== SEE ALSO == | == SEE ALSO == |