X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pveceph.1-synopsis.adoc;h=ddb8eec02937c8bbdd4cfe9c021fc9d928c79643;hp=a1ee3ee52c9bd1627ae14122ea9fac2f264eff89;hb=8119f671e13272db2d0fd015afb5a4705bc573d4;hpb=5d9c884c7b3f4980abbd4cbe91ea588a03266485 diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index a1ee3ee..ddb8eec 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -1,11 +1,28 @@ *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]` @@ -15,20 +32,21 @@ Create OSD Block device name. -`-bluestore` `` ('default =' `0`):: +`--bluestore` `` ('default =' `1`):: -Use bluestore instead of filestore. +Use bluestore instead of filestore. This is the default. -`-fstype` `` ('default =' `xfs`):: +`--fstype` `` ('default =' `xfs`):: File system type (filestore only). -`-journal_dev` `` :: - -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]` @@ -38,34 +56,49 @@ 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 ruleset to use for mapping object placement in the cluster. +The application of the pool, 'rbd' by default. -`-min_size` ` (1 - 7)` ('default =' `1`):: +`--crush_rule` `` :: + +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 - 7)` ('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 -``: `` :: +*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]` @@ -75,13 +108,10 @@ Destroy OSD OSD ID -`-cleanup` `` ('default =' `0`):: +`--cleanup` `` ('default =' `0`):: If set, we remove partition table entries. - - - *pveceph destroypool* `` `[OPTIONS]` Destroy pool @@ -90,108 +120,88 @@ 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 - -*pveceph help* `[]` `[OPTIONS]` +*pveceph help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command -`-verbose` `` :: +`--verbose` `` :: Verbose output format. - - - *pveceph init* `[OPTIONS]` Create initial ceph default configuration and setup symlinks. -`-disable_cephx` `` ('default =' `0`):: +`--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`):: +`--min_size` ` (1 - 7)` ('default =' `2`):: Minimum number of available replicas per object to allow I/O -`-network` `` :: +`--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 - 7)` ('default =' `3`):: +`--size` ` (1 - 7)` ('default =' `3`):: Targeted number of replicas per object - - - *pveceph install* `[OPTIONS]` Install ceph related packages. -`-version` `` :: +`--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. - -