X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pveceph.1-synopsis.adoc;h=6490cedb7502821fdd91411a951f7c31134b9850;hp=8252e805a9b6e3b56f953bdc3a13c311457a4b79;hb=HEAD;hpb=e2d681b3686090218b5217114ccdde49300c902c diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index 8252e80..12f4501 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -48,6 +48,22 @@ The ceph filesystem name. Number of placement groups for the backing data pool. The metadata pool will use a quarter of this. +*pveceph fs destroy* `` `[OPTIONS]` + +Destroy a Ceph filesystem + +``: `` :: + +The ceph filesystem name. + +`--remove-pools` `` ('default =' `0`):: + +Remove data and metadata pools configured for this fs. + +`--remove-storages` `` ('default =' `0`):: + +Remove all pveceph-managed storages configured for this fs. + *pveceph help* `[OPTIONS]` Get help about specified command. @@ -72,7 +88,7 @@ NOTE: Requires option(s): `network` `--disable_cephx` `` ('default =' `0`):: -Disable cephx authentification. +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! @@ -88,7 +104,7 @@ Use specific network for all ceph related traffic Placement group bits, used to specify the default number of placement groups. + -NOTE: 'osd pool default pg num' does not work for default pools. +Depreacted. This setting was deprecated in recent Ceph versions. `--size` ` (1 - 7)` ('default =' `3`):: @@ -98,9 +114,17 @@ Targeted number of replicas per object Install ceph related packages. -`--version` `` :: +`--allow-experimental` `` ('default =' `0`):: + +Allow experimental versions. Use with care! + +`--repository` `` ('default =' `enterprise`):: -no description available +Ceph repository to use. + +`--version` `` ('default =' `quincy`):: + +Ceph version to install. *pveceph lspools* @@ -146,19 +170,15 @@ The ID of the manager Create Ceph Monitor and Manager -`--exclude-manager` `` ('default =' `0`):: +`--mon-address` `` :: -When set, only a monitor will be created. +Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph. -`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: +`--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 -`--mon-address` `` :: - -Overwrites autodetected monitor IP address. Must be in the public network of ceph. - -*pveceph mon destroy* `` `[OPTIONS]` +*pveceph mon destroy* `` Destroy Ceph Monitor and Manager. @@ -166,10 +186,6 @@ Destroy Ceph Monitor and Manager. Monitor ID -`--exclude-manager` `` ('default =' `0`):: - -When set, removes only the monitor, not the manager - *pveceph osd create* `` `[OPTIONS]` Create OSD @@ -178,21 +194,38 @@ Create OSD Block device name. -`--bluestore` `` ('default =' `1`):: +`--crush-device-class` `` :: + +Set the device class of the OSD in crush. + +`--db_dev` `` :: -Use bluestore instead of filestore. This is the default. +Block device name for block.db. -`--fstype` `` ('default =' `xfs`):: +`--db_dev_size` ` (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`):: -File system type (filestore only). +Size in GiB for block.db. ++ +NOTE: Requires option(s): `db_dev` + +`--encrypted` `` ('default =' `0`):: + +Enables encryption of the OSD. -`--journal_dev` `` :: +`--osds-per-device` ` (1 - N)` :: -Block device name for journal (filestore) or block.db (bluestore). +OSD services per physical device. Only useful for fast NVMe devices" + ." to utilize their performance better. `--wal_dev` `` :: -Block device name for block.wal (bluestore only). +Block device name for block.wal. + +`--wal_dev_size` ` (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`):: + +Size in GiB for block.wal. ++ +NOTE: Requires option(s): `wal_dev` *pveceph osd destroy* `` `[OPTIONS]` @@ -206,38 +239,70 @@ OSD ID If set, we remove partition table entries. +*pveceph osd details* `` `[OPTIONS]` `[FORMAT_OPTIONS]` + +Get OSD details. + +``: `` :: + +ID of the OSD + +`--verbose` `` ('default =' `0`):: + +Print verbose information, same as json-pretty output format. + *pveceph pool create* `` `[OPTIONS]` -Create POOL +Create Ceph pool ``: `` :: The name of the pool. It must be unique. -`--add_storages` `` :: +`--add_storages` `` ('default =' `0; for erasure coded pools: 1`):: Configure VM and CT storage using the new pool. -`--application` `` :: +`--application` `` ('default =' `rbd`):: -The application of the pool, 'rbd' by default. +The application of the pool. `--crush_rule` `` :: The rule to use for mapping object placement in the cluster. +`--erasure-coding` `k= ,m= [,device-class=] [,failure-domain=] [,profile=]` :: + +Create an erasure coded pool for RBD with an accompaning replicated pool for metadata storage. With EC, the common ceph options 'size', 'min_size' and 'crush_rule' parameters will be applied to the metadata pool. + `--min_size` ` (1 - 7)` ('default =' `2`):: Minimum number of replicas per object -`--pg_num` ` (8 - 32768)` ('default =' `128`):: +`--pg_autoscale_mode` `` ('default =' `warn`):: + +The automatic PG scaling mode of the pool. + +`--pg_num` ` (1 - 32768)` ('default =' `128`):: Number of placement groups. +`--pg_num_min` ` (-N - 32768)` :: + +Minimal number of placement groups. + `--size` ` (1 - 7)` ('default =' `3`):: Number of replicas per object +`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` :: + +The estimated target size of the pool for the PG autoscaler. + +`--target_size_ratio` `` :: + +The estimated target ratio of the pool for the PG autoscaler. + *pveceph pool destroy* `` `[OPTIONS]` Destroy pool @@ -250,35 +315,104 @@ The name of the pool. It must be unique. If true, destroys pool even if in use +`--remove_ecprofile` `` ('default =' `1`):: + +Remove the erasure code profile. Defaults to true, if applicable. + `--remove_storages` `` ('default =' `0`):: Remove all pveceph-managed storages configured for this pool -*pveceph pool ls* +*pveceph pool get* `` `[OPTIONS]` `[FORMAT_OPTIONS]` + +Show the current pool status. + +``: `` :: + +The name of the pool. It must be unique. + +`--verbose` `` ('default =' `0`):: + +If enabled, will display additional data(eg. statistics). + +*pveceph pool ls* `[FORMAT_OPTIONS]` + +List all pools and their settings (which are settable by the POST/PUT +endpoints). -List all pools. +*pveceph pool set* `` `[OPTIONS]` -*pveceph purge* +Change POOL settings + +``: `` :: + +The name of the pool. It must be unique. + +`--application` `` :: + +The application of the pool. + +`--crush_rule` `` :: + +The rule to use for mapping object placement in the cluster. + +`--min_size` ` (1 - 7)` :: + +Minimum number of replicas per object + +`--pg_autoscale_mode` `` :: + +The automatic PG scaling mode of the pool. + +`--pg_num` ` (1 - 32768)` :: + +Number of placement groups. + +`--pg_num_min` ` (-N - 32768)` :: + +Minimal number of placement groups. + +`--size` ` (1 - 7)` :: + +Number of replicas per object + +`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` :: + +The estimated target size of the pool for the PG autoscaler. + +`--target_size_ratio` `` :: + +The estimated target ratio of the pool for the PG autoscaler. + +*pveceph purge* `[OPTIONS]` Destroy ceph related data and configuration files. -*pveceph start* `[]` +`--crash` `` :: + +Additionally purge Ceph crash logs, /var/lib/ceph/crash. + +`--logs` `` :: + +Additionally purge Ceph logs, /var/log/ceph. + +*pveceph start* `[OPTIONS]` Start ceph services. -``: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`):: +`--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. +Get Ceph Status. -*pveceph stop* `[]` +*pveceph stop* `[OPTIONS]` Stop ceph services. -``: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`):: +`--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`):: Ceph service name.