X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pveceph.1-synopsis.adoc;h=6d15c851392d0771a4e2bb42bb839958633447b2;hb=refs%2Fheads%2Fmaster;hp=37d81171f1f698e1334d70ffc623f36ca876c508;hpb=2489d6df4ac5e916ae18401310bfd1e69c993e55;p=pve-docs.git diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index 37d8117..12f4501 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -1,92 +1,164 @@ *pveceph* ` [ARGS] [OPTIONS]` -*pveceph createmgr* `[OPTIONS]` +*pveceph createmgr* -Create Ceph Manager +An alias for 'pveceph mgr create'. -`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: +*pveceph createmon* -The ID for the manager, when omitted the same as the nodename +An alias for 'pveceph mon create'. +*pveceph createosd* +An alias for 'pveceph osd create'. -*pveceph createmon* `[OPTIONS]` +*pveceph createpool* -Create Ceph Monitor and Manager +An alias for 'pveceph pool create'. -`--exclude-manager` `` ('default =' `0`):: +*pveceph destroymgr* -When set, only a monitor will be created. +An alias for 'pveceph mgr destroy'. -`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: +*pveceph destroymon* -The ID for the monitor, when omitted the same as the nodename +An alias for 'pveceph mon destroy'. +*pveceph destroyosd* +An alias for 'pveceph osd destroy'. +*pveceph destroypool* -*pveceph createosd* `` `[OPTIONS]` +An alias for 'pveceph pool destroy'. -Create OSD +*pveceph fs create* `[OPTIONS]` -``: `` :: +Create a Ceph filesystem -Block device name. +`--add-storage` `` ('default =' `0`):: -`--bluestore` `` ('default =' `0`):: +Configure the created CephFS as storage for this cluster. -Use bluestore instead of filestore. +`--name` `` ('default =' `cephfs`):: -`--fstype` `` ('default =' `xfs`):: +The ceph filesystem name. -File system type (filestore only). +`--pg_num` ` (8 - 32768)` ('default =' `128`):: -`--journal_dev` `` :: +Number of placement groups for the backing data pool. The metadata pool will use a quarter of this. -Block device name for journal (filestore) or block.db (bluestore). +*pveceph fs destroy* `` `[OPTIONS]` -`--wal_dev` `` :: +Destroy a Ceph filesystem + +``: `` :: -Block device name for block.wal (bluestore only). +The ceph filesystem name. +`--remove-pools` `` ('default =' `0`):: +Remove data and metadata pools configured for this fs. +`--remove-storages` `` ('default =' `0`):: -*pveceph createpool* `` `[OPTIONS]` +Remove all pveceph-managed storages configured for this fs. -Create POOL +*pveceph help* `[OPTIONS]` -``: `` :: +Get help about specified command. -The name of the pool. It must be unique. +`--extra-args` `` :: -`--add_storages` `` :: +Shows help for a specific command -Configure VM and CT storages using the new pool. +`--verbose` `` :: -`--application` `` :: +Verbose output format. -The application of the pool, 'rbd' by default. +*pveceph init* `[OPTIONS]` -`--crush_rule` `` :: +Create initial ceph default configuration and setup symlinks. -The rule to use for mapping object placement in the cluster. +`--cluster-network` `` :: + +Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it ++ +NOTE: Requires option(s): `network` + +`--disable_cephx` `` ('default =' `0`):: + +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` ` (1 - 7)` ('default =' `2`):: -Minimum number of replicas per object +Minimum number of available replicas per object to allow I/O -`--pg_num` ` (8 - 32768)` ('default =' `64`):: +`--network` `` :: -Number of placement groups. +Use specific network for all ceph related traffic + +`--pg_bits` ` (6 - 14)` ('default =' `6`):: + +Placement group bits, used to specify the default number of placement groups. ++ +Depreacted. This setting was deprecated in recent Ceph versions. `--size` ` (1 - 7)` ('default =' `3`):: -Number of replicas per object +Targeted number of replicas per object +*pveceph install* `[OPTIONS]` +Install ceph related packages. -*pveceph destroymgr* `` +`--allow-experimental` `` ('default =' `0`):: + +Allow experimental versions. Use with care! + +`--repository` `` ('default =' `enterprise`):: + +Ceph repository to use. + +`--version` `` ('default =' `quincy`):: + +Ceph version to install. + +*pveceph lspools* + +An alias for 'pveceph pool ls'. + +*pveceph mds create* `[OPTIONS]` + +Create Ceph Metadata Server (MDS) + +`--hotstandby` `` ('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`):: + +The ID for the mds, when omitted the same as the nodename + +*pveceph mds destroy* `` + +Destroy Ceph Metadata Server + +``: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: + +The name (ID) of the mds + +*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 mgr destroy* `` Destroy Ceph Manager. @@ -94,9 +166,19 @@ Destroy Ceph Manager. The ID of the manager +*pveceph mon create* `[OPTIONS]` +Create Ceph Monitor and Manager + +`--mon-address` `` :: + +Overwrites autodetected monitor IP address(es). Must be in the public network(s) 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 destroymon* `` `[OPTIONS]` +*pveceph mon destroy* `` Destroy Ceph Monitor and Manager. @@ -104,14 +186,48 @@ Destroy Ceph Monitor and Manager. Monitor ID -`--exclude-manager` `` ('default =' `0`):: +*pveceph osd create* `` `[OPTIONS]` + +Create OSD + +``: `` :: + +Block device name. + +`--crush-device-class` `` :: + +Set the device class of the OSD in crush. + +`--db_dev` `` :: + +Block device name for block.db. -When set, removes only the monitor, not the manager +`--db_dev_size` ` (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`):: +Size in GiB for block.db. ++ +NOTE: Requires option(s): `db_dev` + +`--encrypted` `` ('default =' `0`):: + +Enables encryption of the OSD. +`--osds-per-device` ` (1 - N)` :: + +OSD services per physical device. Only useful for fast NVMe devices" + ." to utilize their performance better. + +`--wal_dev` `` :: +Block device name for block.wal. -*pveceph destroyosd* `` `[OPTIONS]` +`--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]` Destroy OSD @@ -123,123 +239,181 @@ OSD ID If set, we remove partition table entries. +*pveceph osd details* `` `[OPTIONS]` `[FORMAT_OPTIONS]` +Get OSD details. +``: `` :: -*pveceph destroypool* `` `[OPTIONS]` +ID of the OSD -Destroy pool +`--verbose` `` ('default =' `0`):: + +Print verbose information, same as json-pretty output format. + +*pveceph pool create* `` `[OPTIONS]` + +Create Ceph pool ``: `` :: The name of the pool. It must be unique. -`--force` `` ('default =' `0`):: +`--add_storages` `` ('default =' `0; for erasure coded pools: 1`):: -If true, destroys pool even if in use +Configure VM and CT storage using the new pool. -`--remove_storages` `` ('default =' `0`):: +`--application` `` ('default =' `rbd`):: -Remove all pveceph-managed storages configured for this pool +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=]` :: -*pveceph help* `[]` `[OPTIONS]` +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. -Get help about specified command. +`--min_size` ` (1 - 7)` ('default =' `2`):: -``: `` :: +Minimum number of replicas per object -Command name +`--pg_autoscale_mode` `` ('default =' `warn`):: -`--verbose` `` :: +The automatic PG scaling mode of the pool. -Verbose output format. +`--pg_num` ` (1 - 32768)` ('default =' `128`):: +Number of placement groups. +`--pg_num_min` ` (-N - 32768)` :: +Minimal number of placement groups. -*pveceph init* `[OPTIONS]` +`--size` ` (1 - 7)` ('default =' `3`):: -Create initial ceph default configuration and setup symlinks. +Number of replicas per object -`--disable_cephx` `` ('default =' `0`):: +`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` :: -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! +The estimated target size of the pool for the PG autoscaler. -`--min_size` ` (1 - 7)` ('default =' `2`):: +`--target_size_ratio` `` :: -Minimum number of available replicas per object to allow I/O +The estimated target ratio of the pool for the PG autoscaler. -`--network` `` :: +*pveceph pool destroy* `` `[OPTIONS]` -Use specific network for all ceph related traffic +Destroy pool -`--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. +The name of the pool. It must be unique. -`--size` ` (1 - 7)` ('default =' `3`):: +`--force` `` ('default =' `0`):: -Targeted number of replicas per object +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`):: -*pveceph install* `[OPTIONS]` +Remove all pveceph-managed storages configured for this pool -Install ceph related packages. +*pveceph pool get* `` `[OPTIONS]` `[FORMAT_OPTIONS]` -`--version` `` :: +Show the current pool status. -no description available +``: `` :: +The name of the pool. It must be unique. +`--verbose` `` ('default =' `0`):: +If enabled, will display additional data(eg. statistics). -*pveceph lspools* +*pveceph pool ls* `[FORMAT_OPTIONS]` -List all pools. +List all pools and their settings (which are settable by the POST/PUT +endpoints). +*pveceph pool set* `` `[OPTIONS]` +Change POOL settings +``: `` :: -*pveceph purge* +The name of the pool. It must be unique. -Destroy ceph related data and configuration files. +`--application` `` :: +The application of the pool. +`--crush_rule` `` :: +The rule to use for mapping object placement in the cluster. -*pveceph start* `[]` +`--min_size` ` (1 - 7)` :: -Start ceph services. +Minimum number of replicas per object -``: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` :: +`--pg_autoscale_mode` `` :: -Ceph service name. +The automatic PG scaling mode of the pool. +`--pg_num` ` (1 - 32768)` :: +Number of placement groups. -*pveceph status* +`--pg_num_min` ` (-N - 32768)` :: -Get ceph status. +Minimal number of placement groups. +`--size` ` (1 - 7)` :: +Number of replicas per object -*pveceph stop* `[]` +`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` :: -Stop ceph services. +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. + +`--crash` `` :: + +Additionally purge Ceph crash logs, /var/lib/ceph/crash. + +`--logs` `` :: + +Additionally purge Ceph logs, /var/log/ceph. -``: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` :: +*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.