X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pveceph.1-synopsis.adoc;h=ddb8eec02937c8bbdd4cfe9c021fc9d928c79643;hp=790abcd61d9f636e4a9efa4a5635f924bf6d7ae4;hb=924c0ec94676ba1106a5deda1bd73827dc06e6b0;hpb=2c0dde619dc203c365be8b15284530099d159682 diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index 790abcd..ddb8eec 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -1,183 +1,207 @@ *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 + +`--mon-address` `` :: + +Overwrites autodetected monitor IP address. Must be in the public network of ceph. *pveceph createosd* `` `[OPTIONS]` Create OSD -`` `string` :: +``: `` :: Block device name. -`-fstype` `(btrfs | ext4 | xfs)` (default=`xfs`):: +`--bluestore` `` ('default =' `1`):: + +Use bluestore instead of filestore. This is the default. -File system type. +`--fstype` `` ('default =' `xfs`):: -`-journal_dev` `string` :: +File system type (filestore only). -Block device name for journal. +`--journal_dev` `` :: +Block device name for journal (filestore) or block.db (bluestore). +`--wal_dev` `` :: +Block device name for block.wal (bluestore only). *pveceph createpool* `` `[OPTIONS]` Create POOL -`` `string` :: +``: `` :: The name of the pool. It must be unique. -`-crush_ruleset` `integer (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` `integer (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` `integer (8 - 32768)` (default=`64`):: +`--pg_num` ` (8 - 32768)` ('default =' `64`):: Number of placement groups. -`-size` `integer (1 - 3)` (default=`2`):: +`--size` ` (1 - 7)` ('default =' `3`):: Number of replicas per object +*pveceph destroymgr* `` +Destroy Ceph Manager. -*pveceph destroymon* `` +``: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: -Destroy Ceph monitor. +The ID of the manager -`` `integer` :: +*pveceph destroymon* `` `[OPTIONS]` -Monitor ID +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 *pveceph destroyosd* `` `[OPTIONS]` Destroy OSD -`` `integer` :: +``: `` :: OSD ID -`-cleanup` `boolean` (default=`0`):: +`--cleanup` `` ('default =' `0`):: If set, we remove partition table entries. - - - *pveceph destroypool* `` `[OPTIONS]` Destroy pool -`` `string` :: +``: `` :: The name of the pool. It must be unique. -`-force` `boolean` (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 - -*pveceph help* `[]` `[OPTIONS]` +*pveceph help* `[OPTIONS]` Get help about specified command. -`` `string` :: +`--extra-args` `` :: -Command name +Shows help for a specific command -`-verbose` `boolean` :: +`--verbose` `` :: Verbose output format. +*pveceph init* `[OPTIONS]` +Create initial ceph default configuration and setup symlinks. +`--disable_cephx` `` ('default =' `0`):: -*pveceph init* `[OPTIONS]` +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! -Create initial ceph default configuration and setup symlinks. +`--min_size` ` (1 - 7)` ('default =' `2`):: + +Minimum number of available replicas per object to allow I/O -`-network` `string` :: +`--network` `` :: Use specific network for all ceph related traffic -`-pg_bits` `integer (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` `integer (1 - 3)` (default=`2`):: - -Number of replicas per object - - +`--size` ` (1 - 7)` ('default =' `3`):: +Targeted number of replicas per object *pveceph install* `[OPTIONS]` Install ceph related packages. -`-version` `(hammer)` :: +`--version` `` :: no description available - - - *pveceph lspools* List all pools. - - - *pveceph purge* Destroy ceph related data and configuration files. - - - *pveceph start* `[]` 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. - - *pveceph status* Get ceph status. - - *pveceph stop* `[]` 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. - -