btrfs: document df weirdness and how to better get usage

[pve-docs.git] / pveceph.1-synopsis.adoc

diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc
index 817c489be8bd750a23f1fd9d8c20eb7d3d343357..9514e3e62b73f90686bd6391a8d46a6cfde91eb5 100644 (file)
--- a/pveceph.1-synopsis.adoc
+++ b/pveceph.1-synopsis.adoc
@@ -102,7 +102,11 @@ Install ceph related packages.
 
 Allow experimental versions. Use with care!
 
-`--version` `<luminous | nautilus | octopus>` ('default =' `nautilus`)::
+`--test-repository` `<boolean>` ('default =' `0`)::
+
+Use the test, not the main repository. Use with care!
+
+`--version` `<octopus | pacific>` ('default =' `pacific`)::
 
 Ceph version to install.
 
@@ -152,7 +156,7 @@ Create Ceph Monitor and Manager
 
 `--mon-address` `<string>` ::
 
-Overwrites autodetected monitor IP address. Must be in the public network of ceph.
+Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph.
 
 `--monid` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
 
@@ -174,11 +178,15 @@ Create OSD
 
 Block device name.
 
+`--crush-device-class` `<string>` ::
+
+Set the device class of the OSD in crush.
+
 `--db_dev` `<string>` ::
 
 Block device name for block.db.
 
-`--db_size` `<number> (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`)::
+`--db_dev_size` `<number> (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`)::
 
 Size in GiB for block.db.
 +
@@ -192,7 +200,7 @@ Enables encryption of the OSD.
 
 Block device name for block.wal.
 
-`--wal_size` `<number> (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`)::
+`--wal_dev_size` `<number> (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`)::
 
 Size in GiB for block.wal.
 +
@@ -222,9 +230,9 @@ The name of the pool. It must be unique.
 
 Configure VM and CT storage using the new pool.
 
-`--application` `<cephfs | rbd | rgw>` ::
+`--application` `<cephfs | rbd | rgw>` ('default =' `rbd`)::
 
-The application of the pool, 'rbd' by default.
+The application of the pool.
 
 `--crush_rule` `<string>` ::
 
@@ -234,14 +242,30 @@ The rule to use for mapping object placement in the cluster.
 
 Minimum number of replicas per object
 
-`--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
+`--pg_autoscale_mode` `<off | on | warn>` ('default =' `warn`)::
+
+The automatic PG scaling mode of the pool.
+
+`--pg_num` `<integer> (1 - 32768)` ('default =' `128`)::
 
 Number of placement groups.
 
+`--pg_num_min` `<integer> (-N - 32768)` ::
+
+Minimal number of placement groups.
+
 `--size` `<integer> (1 - 7)` ('default =' `3`)::
 
 Number of replicas per object
 
+`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::
+
+The estimated target size of the pool for the PG autoscaler.
+
+`--target_size_ratio` `<number>` ::
+
+The estimated target ratio of the pool for the PG autoscaler.
+
 *pveceph pool destroy* `<name>` `[OPTIONS]`
 
 Destroy pool
@@ -258,10 +282,66 @@ If true, destroys pool even if in use
 
 Remove all pveceph-managed storages configured for this pool
 
+*pveceph pool get* `<name>` `[OPTIONS]` `[FORMAT_OPTIONS]`
+
+List pool settings.
+
+`<name>`: `<string>` ::
+
+The name of the pool. It must be unique.
+
+`--verbose` `<boolean>` ('default =' `0`)::
+
+If enabled, will display additional data(eg. statistics).
+
 *pveceph pool ls* `[FORMAT_OPTIONS]`
 
 List all pools.
 
+*pveceph pool set* `<name>` `[OPTIONS]`
+
+Change POOL settings
+
+`<name>`: `<string>` ::
+
+The name of the pool. It must be unique.
+
+`--application` `<cephfs | rbd | rgw>` ::
+
+The application of the pool.
+
+`--crush_rule` `<string>` ::
+
+The rule to use for mapping object placement in the cluster.
+
+`--min_size` `<integer> (1 - 7)` ::
+
+Minimum number of replicas per object
+
+`--pg_autoscale_mode` `<off | on | warn>` ::
+
+The automatic PG scaling mode of the pool.
+
+`--pg_num` `<integer> (1 - 32768)` ::
+
+Number of placement groups.
+
+`--pg_num_min` `<integer> (-N - 32768)` ::
+
+Minimal number of placement groups.
+
+`--size` `<integer> (1 - 7)` ::
+
+Number of replicas per object
+
+`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::
+
+The estimated target size of the pool for the PG autoscaler.
+
+`--target_size_ratio` `<number>` ::
+
+The estimated target ratio of the pool for the PG autoscaler.
+
 *pveceph purge* `[OPTIONS]`
 
 Destroy ceph related data and configuration files.
@@ -284,7 +364,7 @@ Ceph service name.
 
 *pveceph status*
 
-Get ceph status.
+Get Ceph Status.
 
 *pveceph stop* `[OPTIONS]`