fix 3372: fix typos, and impove pve-gui docs

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

diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc
index 8252e805a9b6e3b56f953bdc3a13c311457a4b79..b5eaa87b404922503214cdf9cee34de1d7096e2b 100644 (file)
--- a/pveceph.1-synopsis.adoc
+++ b/pveceph.1-synopsis.adoc
@@ -72,7 +72,7 @@ NOTE: Requires option(s): `network`
 
 `--disable_cephx` `<boolean>` ('default =' `0`)::
 
-Disable cephx authentification.
+Disable cephx authentication.
 +
 WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private!
 
@@ -98,9 +98,13 @@ Targeted number of replicas per object
 
 Install ceph related packages.
 
-`--version` `<luminous>` ::
+`--allow-experimental` `<boolean>` ('default =' `0`)::
 
-no description available
+Allow experimental versions. Use with care!
+
+`--version` `<luminous | nautilus | octopus>` ('default =' `nautilus`)::
+
+Ceph version to install.
 
 *pveceph lspools*
 
@@ -146,19 +150,15 @@ The ID of the manager
 
 Create Ceph Monitor and Manager
 
-`--exclude-manager` `<boolean>` ('default =' `0`)::
+`--mon-address` `<string>` ::
 
-When set, only a monitor will be created.
+Overwrites autodetected monitor IP address. Must be in the public network of ceph.
 
-`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
+`--monid` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
 
 The ID for the monitor, when omitted the same as the nodename
 
-`--mon-address` `<string>` ::
-
-Overwrites autodetected monitor IP address. Must be in the public network of ceph.
-
-*pveceph mon destroy* `<monid>` `[OPTIONS]`
+*pveceph mon destroy* `<monid>`
 
 Destroy Ceph Monitor and Manager.
 
@@ -166,10 +166,6 @@ Destroy Ceph Monitor and Manager.
 
 Monitor ID
 
-`--exclude-manager` `<boolean>` ('default =' `0`)::
-
-When set, removes only the monitor, not the manager
-
 *pveceph osd create* `<dev>` `[OPTIONS]`
 
 Create OSD
@@ -178,21 +174,33 @@ Create OSD
 
 Block device name.
 
-`--bluestore` `<boolean>` ('default =' `1`)::
+`--crush-device-class` `<string>` ::
+
+Set the device class of the OSD in crush.
 
-Use bluestore instead of filestore. This is the default.
+`--db_dev` `<string>` ::
 
-`--fstype` `<ext4 | xfs>` ('default =' `xfs`)::
+Block device name for block.db.
 
-File system type (filestore only).
+`--db_size` `<number> (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`)::
 
-`--journal_dev` `<string>` ::
+Size in GiB for block.db.
++
+NOTE: Requires option(s): `db_dev`
+
+`--encrypted` `<boolean>` ('default =' `0`)::
 
-Block device name for journal (filestore) or block.db (bluestore).
+Enables encryption of the OSD.
 
 `--wal_dev` `<string>` ::
 
-Block device name for block.wal (bluestore only).
+Block device name for block.wal.
+
+`--wal_size` `<number> (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`)::
+
+Size in GiB for block.wal.
++
+NOTE: Requires option(s): `wal_dev`
 
 *pveceph osd destroy* `<osdid>` `[OPTIONS]`
 
@@ -218,9 +226,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>` ::
 
@@ -230,6 +238,10 @@ The rule to use for mapping object placement in the cluster.
 
 Minimum number of replicas per object
 
+`--pg_autoscale_mode` `<off | on | warn>` ('default =' `warn`)::
+
+The automatic PG scaling mode of the pool.
+
 `--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
 
 Number of placement groups.
@@ -254,19 +266,59 @@ If true, destroys pool even if in use
 
 Remove all pveceph-managed storages configured for this pool
 
-*pveceph pool ls*
+*pveceph pool ls* `[FORMAT_OPTIONS]`
 
 List all pools.
 
-*pveceph purge*
+*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> (8 - 32768)` ::
+
+Number of placement groups.
+
+`--size` `<integer> (1 - 7)` ::
+
+Number of replicas per object
+
+*pveceph purge* `[OPTIONS]`
 
 Destroy ceph related data and configuration files.
 
-*pveceph start* `[<service>]`
+`--crash` `<boolean>` ::
+
+Additionally purge Ceph crash logs, /var/lib/ceph/crash.
+
+`--logs` `<boolean>` ::
+
+Additionally purge Ceph logs, /var/log/ceph.
+
+*pveceph start* `[OPTIONS]`
 
 Start ceph services.
 
-`<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`)::
+`--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`)::
 
 Ceph service name.
 
@@ -274,11 +326,11 @@ Ceph service name.
 
 Get ceph status.
 
-*pveceph stop* `[<service>]`
+*pveceph stop* `[OPTIONS]`
 
 Stop ceph services.
 
-`<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`)::
+`--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`)::
 
 Ceph service name.