X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pveceph.1-synopsis.adoc;h=37d81171f1f698e1334d70ffc623f36ca876c508;hp=7cd041c606615cd2559863c56749081abd819f83;hb=266cb17b871843ba94f074b6f2175adae75506e0;hpb=52e44c5018d7fd18ae192ab4456542702c6e9979 diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index 7cd041c..37d8117 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -1,8 +1,26 @@ *pveceph* ` [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` `` ('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 @@ -15,13 +33,21 @@ Create OSD Block device name. -`-fstype` `` ('default =' `xfs`):: +`--bluestore` `` ('default =' `0`):: + +Use bluestore instead of filestore. + +`--fstype` `` ('default =' `xfs`):: + +File system type (filestore only). -File system type. +`--journal_dev` `` :: -`-journal_dev` `` :: +Block device name for journal (filestore) or block.db (bluestore). -Block device name for journal. +`--wal_dev` `` :: + +Block device name for block.wal (bluestore only). @@ -34,32 +60,54 @@ Create POOL The name of the pool. It must be unique. -`-crush_ruleset` ` (0 - 32768)` ('default =' `0`):: +`--add_storages` `` :: + +Configure VM and CT storages using the new pool. + +`--application` `` :: + +The application of the pool, 'rbd' by default. -The ruleset to use for mapping object placement in the cluster. +`--crush_rule` `` :: -`-min_size` ` (1 - 3)` ('default =' `1`):: +The rule to use for mapping object placement in the cluster. + +`--min_size` ` (1 - 7)` ('default =' `2`):: Minimum number of replicas per object -`-pg_num` ` (8 - 32768)` ('default =' `64`):: +`--pg_num` ` (8 - 32768)` ('default =' `64`):: Number of placement groups. -`-size` ` (1 - 3)` ('default =' `2`):: +`--size` ` (1 - 7)` ('default =' `3`):: Number of replicas per object -*pveceph destroymon* `` +*pveceph destroymgr* `` + +Destroy Ceph Manager. + +``: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: + +The ID of the manager + -Destroy Ceph monitor. -``: `` :: +*pveceph destroymon* `` `[OPTIONS]` + +Destroy Ceph Monitor and Manager. + +``: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: Monitor ID +`--exclude-manager` `` ('default =' `0`):: + +When set, removes only the monitor, not the manager + @@ -71,7 +119,7 @@ Destroy OSD OSD ID -`-cleanup` `` ('default =' `0`):: +`--cleanup` `` ('default =' `0`):: If set, we remove partition table entries. @@ -86,10 +134,14 @@ Destroy pool The name of the pool. It must be unique. -`-force` `` ('default =' `0`):: +`--force` `` ('default =' `0`):: If true, destroys pool even if in use +`--remove_storages` `` ('default =' `0`):: + +Remove all pveceph-managed storages configured for this pool + @@ -101,7 +153,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -112,19 +164,29 @@ Verbose output format. Create initial ceph default configuration and setup symlinks. -`-network` `` :: +`--disable_cephx` `` ('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` ` (1 - 7)` ('default =' `2`):: + +Minimum number of available replicas per object to allow I/O + +`--network` `` :: Use specific network for all ceph related traffic -`-pg_bits` ` (6 - 14)` ('default =' `6`):: +`--pg_bits` ` (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` ` (1 - 3)` ('default =' `2`):: +`--size` ` (1 - 7)` ('default =' `3`):: -Number of replicas per object +Targeted number of replicas per object @@ -133,7 +195,7 @@ Number of replicas per object Install ceph related packages. -`-version` `` :: +`--version` `` :: no description available @@ -158,7 +220,7 @@ Destroy ceph related data and configuration files. Start ceph services. -``: `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` :: +``: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` :: Ceph service name. @@ -174,7 +236,7 @@ Get ceph status. Stop ceph services. -``: `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` :: +``: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` :: Ceph service name.