]> git.proxmox.com Git - proxmox-backup.git/commitdiff
datastore: description of new datastore view
authorDylan Whyte <d.whyte@proxmox.com>
Fri, 6 Nov 2020 14:46:26 +0000 (15:46 +0100)
committerDietmar Maurer <dietmar@proxmox.com>
Fri, 6 Nov 2020 15:28:16 +0000 (16:28 +0100)
- Add screenshots from new datastore view
- Add description of comment field in create datastore window
- Add description of each tab in the datastore panel
- Update instructions to add datastore from GUI

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
docs/gui.rst
docs/images/screenshots/pbs-gui-datastore-content.png [new file with mode: 0644]
docs/images/screenshots/pbs-gui-datastore-summary.png [new file with mode: 0644]
docs/storage.rst

index 23aab68ad3ceac57adbcf38c2052555465f82b7f..eef2ec293acfa6ceacc0d365f5bdd9f5a171e496 100644 (file)
@@ -116,16 +116,21 @@ The administration menu item also contains a disk management subsection:
 Datastore
 ^^^^^^^^^
 
-.. image:: images/screenshots/pbs-gui-datastore.png
-  :width: 250
+.. image:: images/screenshots/pbs-gui-datastore-summary.png
   :align: right
   :alt: Datastore Configuration
 
-The Datastore section provides an interface for creating and managing
-datastores. It contains a subsection for each datastore on the system, in
-which you can use the top panel to view:
+The Datastore section contains interfaces for creating and managing
+datastores. It contains a button to create a new datastore on the server, as
+well as a subsection for each datastore on the system, in which you can use the
+top panel to view:
 
+* **Summary**: Access a range of datastore usage statistics
 * **Content**: Information on the datastore's backup groups and their respective
   contents
-* **Statistics**: Usage statistics for the datastore
-* **Permissions**: View and manage permissions for the datastore
+* **Prune & GC**: Schedule :ref:`pruning <backup-pruning>` and :ref:`garbage
+  collection <garbage-collection>` operations, and run garbage collection
+  manually
+* **Sync Jobs**: Create, manage and run :ref:`syncjobs` from remote servers
+* **Verify Jobs**: Create, manage and run :ref:`verification` jobs on the
+  datastore
diff --git a/docs/images/screenshots/pbs-gui-datastore-content.png b/docs/images/screenshots/pbs-gui-datastore-content.png
new file mode 100644 (file)
index 0000000..162f977
Binary files /dev/null and b/docs/images/screenshots/pbs-gui-datastore-content.png differ
diff --git a/docs/images/screenshots/pbs-gui-datastore-summary.png b/docs/images/screenshots/pbs-gui-datastore-summary.png
new file mode 100644 (file)
index 0000000..ea41229
Binary files /dev/null and b/docs/images/screenshots/pbs-gui-datastore-summary.png differ
index 8541237b423c265b946cac39b33c8c4a4ed71ef6..f191ff990b415048fb6d9cb5f1c9aa461eefecb1 100644 (file)
@@ -107,7 +107,7 @@ is stored in the file ``/etc/proxmox-backup/datastore.cfg``.
 Datastore Configuration
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-.. image:: images/screenshots/pbs-gui-datastore.png
+.. image:: images/screenshots/pbs-gui-datastore-content.png
   :align: right
   :alt: Datastore Overview
 
@@ -127,8 +127,9 @@ Creating a Datastore
   :align: right
   :alt: Create a datastore
 
-You can create a new datastore from the web GUI, by navigating to **Datastore** in
-the menu tree and clicking **Create**. Here:
+You can create a new datastore from the web interface, by clicking **Add
+Datastore** in the side menu, under the **Datastore** section. In the setup
+window:
 
 * *Name* refers to the name of the datastore
 * *Backing Path* is the path to the directory upon which you want to create the
@@ -136,7 +137,9 @@ the menu tree and clicking **Create**. Here:
 * *GC Schedule* refers to the time and intervals at which garbage collection
   runs
 * *Prune Schedule* refers to the frequency at which pruning takes place
-* *Prune Options* set the amount of backups which you would like to keep (see :ref:`backup-pruning`).
+* *Prune Options* set the amount of backups which you would like to keep (see
+  :ref:`backup-pruning`).
+* *Comment* can be used to add some contextual information to the datastore.
 
 Alternatively you can create a new datastore from the command line. The
 following command creates a new datastore called ``store1`` on :file:`/backup/disk1/store1`