X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pveceph.1-synopsis.adoc;h=817c489be8bd750a23f1fd9d8c20eb7d3d343357;hp=790abcd61d9f636e4a9efa4a5635f924bf6d7ae4;hb=b84c51fae3c3dab3fd5ab91198cdea22f688c648;hpb=2c0dde619dc203c365be8b15284530099d159682

diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc
index 790abcd..817c489 100644
--- a/pveceph.1-synopsis.adoc
+++ b/pveceph.1-synopsis.adoc
@@ -1,183 +1,297 @@
 *pveceph* `<COMMAND> [ARGS] [OPTIONS]`
 
+*pveceph createmgr*
+
+An alias for 'pveceph mgr create'.
+
 *pveceph createmon*
 
-Create Ceph Monitor
+An alias for 'pveceph mon create'.
 
+*pveceph createosd*
 
+An alias for 'pveceph osd create'.
 
+*pveceph createpool*
 
-*pveceph createosd* `<dev>` `[OPTIONS]`
+An alias for 'pveceph pool create'.
 
-Create OSD
+*pveceph destroymgr*
 
-`<dev>` `string` ::
+An alias for 'pveceph mgr destroy'.
 
-Block device name.
+*pveceph destroymon*
 
-`-fstype` `(btrfs | ext4 | xfs)` (default=`xfs`)::
+An alias for 'pveceph mon destroy'.
 
-File system type.
+*pveceph destroyosd*
 
-`-journal_dev` `string` ::
+An alias for 'pveceph osd destroy'.
 
-Block device name for journal.
+*pveceph destroypool*
 
+An alias for 'pveceph pool destroy'.
 
+*pveceph fs create* `[OPTIONS]`
 
+Create a Ceph filesystem
 
-*pveceph createpool* `<name>` `[OPTIONS]`
+`--add-storage` `<boolean>` ('default =' `0`)::
 
-Create POOL
+Configure the created CephFS as storage for this cluster.
 
-`<name>` `string` ::
+`--name` `<string>` ('default =' `cephfs`)::
 
-The name of the pool. It must be unique.
+The ceph filesystem name.
 
-`-crush_ruleset` `integer (0 - 32768)` (default=`0`)::
+`--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
 
-The ruleset to use for mapping object placement in the cluster.
+Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.
 
-`-min_size` `integer (1 - 3)` (default=`1`)::
+*pveceph help* `[OPTIONS]`
 
-Minimum number of replicas per object
+Get help about specified command.
 
-`-pg_num` `integer (8 - 32768)` (default=`64`)::
+`--extra-args` `<array>` ::
 
-Number of placement groups.
+Shows help for a specific command
 
-`-size` `integer (1 - 3)` (default=`2`)::
+`--verbose` `<boolean>` ::
 
-Number of replicas per object
+Verbose output format.
 
+*pveceph init* `[OPTIONS]`
 
+Create initial ceph default configuration and setup symlinks.
 
-*pveceph destroymon* `<monid>`
+`--cluster-network` `<string>` ::
 
-Destroy Ceph monitor.
+Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it
++
+NOTE: Requires option(s): `network`
 
-`<monid>` `integer` ::
+`--disable_cephx` `<boolean>` ('default =' `0`)::
 
-Monitor ID
+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!
 
+`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
 
+Minimum number of available replicas per object to allow I/O
 
+`--network` `<string>` ::
 
-*pveceph destroyosd* `<osdid>` `[OPTIONS]`
+Use specific network for all ceph related traffic
 
-Destroy OSD
+`--pg_bits` `<integer> (6 - 14)` ('default =' `6`)::
 
-`<osdid>` `integer` ::
+Placement group bits, used to specify the default number of placement groups.
++
+NOTE: 'osd pool default pg num' does not work for default pools.
 
-OSD ID
+`--size` `<integer> (1 - 7)` ('default =' `3`)::
 
-`-cleanup` `boolean` (default=`0`)::
+Targeted number of replicas per object
 
-If set, we remove partition table entries.
+*pveceph install* `[OPTIONS]`
 
+Install ceph related packages.
 
+`--allow-experimental` `<boolean>` ('default =' `0`)::
 
+Allow experimental versions. Use with care!
 
-*pveceph destroypool* `<name>` `[OPTIONS]`
+`--version` `<luminous | nautilus | octopus>` ('default =' `nautilus`)::
 
-Destroy pool
+Ceph version to install.
 
-`<name>` `string` ::
+*pveceph lspools*
 
-The name of the pool. It must be unique.
+An alias for 'pveceph pool ls'.
 
-`-force` `boolean` (default=`0`)::
+*pveceph mds create* `[OPTIONS]`
 
-If true, destroys pool even if in use
+Create Ceph Metadata Server (MDS)
 
+`--hotstandby` `<boolean>` ('default =' `0`)::
 
+Determines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources.
 
+`--name` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ('default =' `nodename`)::
 
-*pveceph help* `[<cmd>]` `[OPTIONS]`
+The ID for the mds, when omitted the same as the nodename
 
-Get help about specified command.
+*pveceph mds destroy* `<name>`
 
-`<cmd>` `string` ::
+Destroy Ceph Metadata Server
 
-Command name
+`<name>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
 
-`-verbose` `boolean` ::
+The name (ID) of the mds
 
-Verbose output format.
+*pveceph mgr create* `[OPTIONS]`
 
+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 init* `[OPTIONS]`
+*pveceph mgr destroy* `<id>`
 
-Create initial ceph default configuration and setup symlinks.
+Destroy Ceph Manager.
 
-`-network` `string` ::
+`<id>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
 
-Use specific network for all ceph related traffic
+The ID of the manager
 
-`-pg_bits` `integer (6 - 14)` (default=`6`)::
+*pveceph mon create* `[OPTIONS]`
 
-Placement group bits, used to specify the default number of placement groups.
+Create Ceph Monitor and Manager
+
+`--mon-address` `<string>` ::
+
+Overwrites autodetected monitor IP address. Must be in the public network of ceph.
+
+`--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
+
+*pveceph mon destroy* `<monid>`
+
+Destroy Ceph Monitor and Manager.
+
+`<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
+
+Monitor ID
+
+*pveceph osd create* `<dev>` `[OPTIONS]`
+
+Create OSD
+
+`<dev>`: `<string>` ::
+
+Block device name.
+
+`--db_dev` `<string>` ::
+
+Block device name for block.db.
+
+`--db_size` `<number> (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`)::
+
+Size in GiB for block.db.
 +
-NOTE: 'osd pool default pg num' does not work for default pools.
+NOTE: Requires option(s): `db_dev`
 
-`-size` `integer (1 - 3)` (default=`2`)::
+`--encrypted` `<boolean>` ('default =' `0`)::
 
-Number of replicas per object
+Enables encryption of the OSD.
 
+`--wal_dev` `<string>` ::
 
+Block device name for block.wal.
 
+`--wal_size` `<number> (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`)::
 
-*pveceph install* `[OPTIONS]`
+Size in GiB for block.wal.
++
+NOTE: Requires option(s): `wal_dev`
 
-Install ceph related packages.
+*pveceph osd destroy* `<osdid>` `[OPTIONS]`
 
-`-version` `(hammer)` ::
+Destroy OSD
 
-no description available
+`<osdid>`: `<integer>` ::
 
+OSD ID
 
+`--cleanup` `<boolean>` ('default =' `0`)::
 
+If set, we remove partition table entries.
 
-*pveceph lspools*
+*pveceph pool create* `<name>` `[OPTIONS]`
 
-List all pools.
+Create POOL
 
+`<name>`: `<string>` ::
 
+The name of the pool. It must be unique.
 
+`--add_storages` `<boolean>` ::
 
-*pveceph purge*
+Configure VM and CT storage using the new pool.
 
-Destroy ceph related data and configuration files.
+`--application` `<cephfs | rbd | rgw>` ::
 
+The application of the pool, 'rbd' by default.
 
+`--crush_rule` `<string>` ::
 
+The rule to use for mapping object placement in the cluster.
 
-*pveceph start* `[<service>]`
+`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
 
-Start ceph services.
+Minimum number of replicas per object
 
-`<service>` `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` ::
+`--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
 
-Ceph service name.
+Number of placement groups.
 
+`--size` `<integer> (1 - 7)` ('default =' `3`)::
 
+Number of replicas per object
 
-*pveceph status*
+*pveceph pool destroy* `<name>` `[OPTIONS]`
 
-Get ceph status.
+Destroy pool
+
+`<name>`: `<string>` ::
 
+The name of the pool. It must be unique.
+
+`--force` `<boolean>` ('default =' `0`)::
 
+If true, destroys pool even if in use
 
-*pveceph stop* `[<service>]`
+`--remove_storages` `<boolean>` ('default =' `0`)::
 
-Stop ceph services.
+Remove all pveceph-managed storages configured for this pool
+
+*pveceph pool ls* `[FORMAT_OPTIONS]`
+
+List all pools.
+
+*pveceph purge* `[OPTIONS]`
+
+Destroy ceph related data and configuration files.
+
+`--crash` `<boolean>` ::
+
+Additionally purge Ceph crash logs, /var/lib/ceph/crash.
+
+`--logs` `<boolean>` ::
 
-`<service>` `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` ::
+Additionally purge Ceph logs, /var/log/ceph.
+
+*pveceph start* `[OPTIONS]`
+
+Start ceph services.
+
+`--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`)::
 
 Ceph service name.
 
+*pveceph status*
+
+Get ceph status.
+
+*pveceph stop* `[OPTIONS]`
+
+Stop ceph services.
+
+`--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`)::
 
+Ceph service name.