tyler
/
proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
proxmox-backup/docs/prune-simulator/documentation.html

103 lines
4.6 KiB
HTML
Raw Permalink Normal View History

create prune simulator A stand-alone ExtJS app that allows experimenting with different backup schedules and prune parameters. The HTML for the documentation was taken from the PBS docs and adapted to the context of the simulator. For performance reasons, the week table does not use subcomponents, but raw HTML. Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-03 14:28:41 +00:00
<!DOCTYPE html>
<html>
<head>
<style>
prune sim: align documentation style with sphinx/alabaster ones Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-08 13:02:27 +00:00
/* similar to sphinx alabaster theme ones */
prune sim: improve documentation layout Better line height, some margin on the edges, and max width to avoid very long lines on wide displays. Avoid to much contrast by using black on white, use a very dark grey instead. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-07 12:28:49 +00:00
body {
prune sim: align documentation style with sphinx/alabaster ones Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-08 13:02:27 +00:00
max-width: 90ch;
margin-left: 2ch;
margin-right: 2ch;
line-height: 1.4em;
/* avoid the very high contrast of black on white, tone it down a bit */
color: #3E4349;
hyphens: auto;
text-align: left;
font-family: 'Open Sans', sans-serif;
font-size: 17px;
prune sim: improve documentation layout Better line height, some margin on the edges, and max width to avoid very long lines on wide displays. Avoid to much contrast by using black on white, use a very dark grey instead. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-07 12:28:49 +00:00
}
h1, h2, h3 {
prune sim: align documentation style with sphinx/alabaster ones Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-08 13:02:27 +00:00
font-family: Lato, sans-serif;
font-size: 150%;
line-height:1.2
prune sim: improve documentation layout Better line height, some margin on the edges, and max width to avoid very long lines on wide displays. Avoid to much contrast by using black on white, use a very dark grey instead. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-07 12:28:49 +00:00
}
create prune simulator A stand-alone ExtJS app that allows experimenting with different backup schedules and prune parameters. The HTML for the documentation was taken from the PBS docs and adapted to the context of the simulator. For performance reasons, the week table does not use subcomponents, but raw HTML. Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-03 14:28:41 +00:00
tt, code {
prune sim: align documentation style with sphinx/alabaster ones Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-08 13:02:27 +00:00
background-color: #ecf0f3;
color: #222;
create prune simulator A stand-alone ExtJS app that allows experimenting with different backup schedules and prune parameters. The HTML for the documentation was taken from the PBS docs and adapted to the context of the simulator. For performance reasons, the week table does not use subcomponents, but raw HTML. Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-03 14:28:41 +00:00
}
pre, tt, code {
prune sim: align documentation style with sphinx/alabaster ones Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-08 13:02:27 +00:00
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
font-size: 0.9em;
create prune simulator A stand-alone ExtJS app that allows experimenting with different backup schedules and prune parameters. The HTML for the documentation was taken from the PBS docs and adapted to the context of the simulator. For performance reasons, the week table does not use subcomponents, but raw HTML. Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-03 14:28:41 +00:00
}
div.note {
prune sim: align documentation style with sphinx/alabaster ones Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-08 13:02:27 +00:00
background-color: #EEE;
border: 1px solid #CCC;
margin: 10px 0;
padding: 0px 20px;
}
p.note-title {
font-weight: bolder;
padding: 0;
margin: 10px 0 0 0;
}
div.note > p.last {
margin: 5px 0 10px 0;
create prune simulator A stand-alone ExtJS app that allows experimenting with different backup schedules and prune parameters. The HTML for the documentation was taken from the PBS docs and adapted to the context of the simulator. For performance reasons, the week table does not use subcomponents, but raw HTML. Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-03 14:28:41 +00:00
}
</style>
</head>
<body>
<p>A simulator to experiment with different backup schedules and prune
options.</p>
<h3>Schedule</h3>
<p>Select weekdays with the combobox and input hour and minute
specification separated by a colon, i.e. <code>HOUR:MINUTE</code>. Each of
<code>HOUR</code> and <code>MINUTE</code> can be either a single value or
one of the following:</p>
<ul class="simple">
<li>a comma-separated list: e.g., <code>01,02,03</code></li>
<li>a range: e.g., <code>01..10</code></li>
<li>a repetition: e.g, <code>05/10</code> (means starting at <code>5</code> every <code>10</code>)</li>
<li>a combination of the above: e.g., <code>01,05..10,12/02</code></li>
<li>a <code>*</code> for every possible value</li>
</ul>
<h3>Pruning</h3>
<p>Prune lets you systematically delete older backups, retaining backups for
the last given number of time intervals. The following retention options are
available:</p>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">keep-last</span> <span class="pre">&lt;N&gt;</span></code></dt>
<dd>Keep the last <code class="docutils literal notranslate"><span class="pre">&lt;N&gt;</span></code> backup snapshots.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">keep-hourly</span> <span class="pre">&lt;N&gt;</span></code></dt>
<dd>Keep backups for the last <code class="docutils literal notranslate"><span class="pre">&lt;N&gt;</span></code> hours. If there is more than one
backup for a single hour, only the latest is kept.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">keep-daily</span> <span class="pre">&lt;N&gt;</span></code></dt>
<dd>Keep backups for the last <code class="docutils literal notranslate"><span class="pre">&lt;N&gt;</span></code> days. If there is more than one
backup for a single day, only the latest is kept.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">keep-weekly</span> <span class="pre">&lt;N&gt;</span></code></dt>
<dd>Keep backups for the last <code class="docutils literal notranslate"><span class="pre">&lt;N&gt;</span></code> weeks. If there is more than one
backup for a single week, only the latest is kept.
<div class="last admonition note">
prune sim: align documentation style with sphinx/alabaster ones Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-08 13:02:27 +00:00
<p class="note-title">Note:</p>
<p class="last">Weeks start on Monday and end on Sunday. The software
create prune simulator A stand-alone ExtJS app that allows experimenting with different backup schedules and prune parameters. The HTML for the documentation was taken from the PBS docs and adapted to the context of the simulator. For performance reasons, the week table does not use subcomponents, but raw HTML. Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-03 14:28:41 +00:00
uses the <a class="reference external" href="https://en.wikipedia.org/wiki/ISO_week_date">ISO week date</a> system and handles weeks at
the end of the year correctly.</p>
</div>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">keep-monthly</span> <span class="pre">&lt;N&gt;</span></code></dt>
<dd>Keep backups for the last <code class="docutils literal notranslate"><span class="pre">&lt;N&gt;</span></code> months. If there is more than one
backup for a single month, only the latest is kept.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">keep-yearly</span> <span class="pre">&lt;N&gt;</span></code></dt>
<dd>Keep backups for the last <code class="docutils literal notranslate"><span class="pre">&lt;N&gt;</span></code> years. If there is more than one
backup for a single year, only the latest is kept.</dd>
</dl>
<p>The retention options are processed in the order given above. Each option
only covers backups within its time period. The next option does not take care
of already covered backups. It will only consider older backups.</p>
<p>For example, in a week covered by <code>keep-weekly</code>, one backup is
kept while all others are removed; <code>keep-monthly</code> then does not
consider backups from that week anymore, even if part of the week is part of
an earlier month.</p>
</body>
</html>