minor fixup

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

diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc
index 0bc2fbe25c1cdcdfaf31a3b40d43df7b306b3e28..37d81171f1f698e1334d70ffc623f36ca876c508 100644 (file)
--- a/pveceph.1-synopsis.adoc
+++ b/pveceph.1-synopsis.adoc
@@ -1,8 +1,26 @@
 *pveceph* `<COMMAND> [ARGS] [OPTIONS]`
 
-*pveceph createmon*
+*pveceph createmgr* `[OPTIONS]`
 
-Create Ceph Monitor
+Create Ceph Manager
+
+`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
+
+The ID for the manager, when omitted the same as the nodename
+
+
+
+*pveceph createmon* `[OPTIONS]`
+
+Create Ceph Monitor and Manager
+
+`--exclude-manager` `<boolean>` ('default =' `0`)::
+
+When set, only a monitor will be created.
+
+`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
+
+The ID for the monitor, when omitted the same as the nodename
 
 
 
@@ -11,17 +29,25 @@ Create Ceph Monitor
 
 Create OSD
 
-`<dev>` `string` ::
+`<dev>`: `<string>` ::
 
 Block device name.
 
-`-fstype` `(btrfs | ext4 | xfs)` (default=`xfs`)::
+`--bluestore` `<boolean>` ('default =' `0`)::
+
+Use bluestore instead of filestore.
+
+`--fstype` `<btrfs | ext4 | xfs>` ('default =' `xfs`)::
+
+File system type (filestore only).
+
+`--journal_dev` `<string>` ::
 
-File system type.
+Block device name for journal (filestore) or block.db (bluestore).
 
-`-journal_dev` `string` ::
+`--wal_dev` `<string>` ::
 
-Block device name for journal.
+Block device name for block.wal (bluestore only).
 
 
 
@@ -30,36 +56,58 @@ Block device name for journal.
 
 Create POOL
 
-`<name>` `string` ::
+`<name>`: `<string>` ::
 
 The name of the pool. It must be unique.
 
-`-crush_ruleset` `integer (0 - 32768)` (default=`0`)::
+`--add_storages` `<boolean>` ::
+
+Configure VM and CT storages using the new pool.
+
+`--application` `<cephfs | rbd | rgw>` ::
+
+The application of the pool, 'rbd' by default.
+
+`--crush_rule` `<string>` ::
 
-The ruleset to use for mapping object placement in the cluster.
+The rule to use for mapping object placement in the cluster.
 
-`-min_size` `integer (1 - 3)` (default=`1`)::
+`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
 
 Minimum number of replicas per object
 
-`-pg_num` `integer (8 - 32768)` (default=`64`)::
+`--pg_num` `<integer> (8 - 32768)` ('default =' `64`)::
 
 Number of placement groups.
 
-`-size` `integer (1 - 3)` (default=`2`)::
+`--size` `<integer> (1 - 7)` ('default =' `3`)::
 
 Number of replicas per object
 
 
 
-*pveceph destroymon* `<monid>`
+*pveceph destroymgr* `<id>`
 
-Destroy Ceph monitor.
+Destroy Ceph Manager.
 
-`<monid>` `integer` ::
+`<id>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
+
+The ID of the manager
+
+
+
+*pveceph destroymon* `<monid>` `[OPTIONS]`
+
+Destroy Ceph Monitor and Manager.
+
+`<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
 
 Monitor ID
 
+`--exclude-manager` `<boolean>` ('default =' `0`)::
+
+When set, removes only the monitor, not the manager
+
 
 
 
@@ -67,25 +115,33 @@ Monitor ID
 
 Destroy OSD
 
-`<osdid>` `integer` ::
+`<osdid>`: `<integer>` ::
 
 OSD ID
 
-`-cleanup` `boolean` (default=`0`)::
+`--cleanup` `<boolean>` ('default =' `0`)::
 
 If set, we remove partition table entries.
 
 
 
 
-*pveceph destroypool* `<name>`
+*pveceph destroypool* `<name>` `[OPTIONS]`
 
 Destroy pool
 
-`<name>` `string` ::
+`<name>`: `<string>` ::
 
 The name of the pool. It must be unique.
 
+`--force` `<boolean>` ('default =' `0`)::
+
+If true, destroys pool even if in use
+
+`--remove_storages` `<boolean>` ('default =' `0`)::
+
+Remove all pveceph-managed storages configured for this pool
+
 
 
 
@@ -93,11 +149,11 @@ The name of the pool. It must be unique.
 
 Get help about specified command.
 
-`<cmd>` `string` ::
+`<cmd>`: `<string>` ::
 
 Command name
 
-`-verbose` `boolean` ::
+`--verbose` `<boolean>` ::
 
 Verbose output format.
 
@@ -108,19 +164,29 @@ Verbose output format.
 
 Create initial ceph default configuration and setup symlinks.
 
-`-network` `string` ::
+`--disable_cephx` `<boolean>` ('default =' `0`)::
+
+Disable cephx authentification.
++
+WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private!
+
+`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
+
+Minimum number of available replicas per object to allow I/O
+
+`--network` `<string>` ::
 
 Use specific network for all ceph related traffic
 
-`-pg_bits` `integer (6 - 14)` (default=`6`)::
+`--pg_bits` `<integer> (6 - 14)` ('default =' `6`)::
 
 Placement group bits, used to specify the default number of placement groups.
 +
 NOTE: 'osd pool default pg num' does not work for default pools.
 
-`-size` `integer (1 - 3)` (default=`2`)::
+`--size` `<integer> (1 - 7)` ('default =' `3`)::
 
-Number of replicas per object
+Targeted number of replicas per object
 
 
 
@@ -129,7 +195,7 @@ Number of replicas per object
 
 Install ceph related packages.
 
-`-version` `(hammer)` ::
+`--version` `<luminous>` ::
 
 no description available
 
@@ -154,7 +220,7 @@ Destroy ceph related data and configuration files.
 
 Start ceph services.
 
-`<service>` `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` ::
+`<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ::
 
 Ceph service name.
 
@@ -170,7 +236,7 @@ Get ceph status.
 
 Stop ceph services.
 
-`<service>` `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` ::
+`<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ::
 
 Ceph service name.