X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pveceph.1-synopsis.adoc;h=7a2699f1054d72e45187810559ad8ac71bfbaa02;hb=447596fd16c159593439f61e817450bc9aaf5ef2;hp=0859989880d30699721936eace427cc41d1a66ea;hpb=013dc89ffce47b8c55412c016a508205768b4fd6;p=pve-docs.git diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index 0859989..7a2699f 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -1,69 +1,228 @@ *pveceph* ` [ARGS] [OPTIONS]` +*pveceph createmgr* + +An alias for 'pveceph mgr create'. + *pveceph createmon* -Create Ceph Monitor +An alias for 'pveceph mon create'. +*pveceph createosd* +An alias for 'pveceph osd create'. +*pveceph createpool* -*pveceph createosd* `` `[OPTIONS]` +An alias for 'pveceph pool create'. -Create OSD +*pveceph destroymgr* -``: `` :: +An alias for 'pveceph mgr destroy'. -Block device name. +*pveceph destroymon* + +An alias for 'pveceph mon destroy'. + +*pveceph destroyosd* + +An alias for 'pveceph osd destroy'. + +*pveceph destroypool* + +An alias for 'pveceph pool destroy'. -`-fstype` `` ('default =' `xfs`):: +*pveceph fs create* `[OPTIONS]` -File system type. +Create a Ceph filesystem -`-journal_dev` `` :: +`--add-storage` `` ('default =' `0`):: -Block device name for journal. +Configure the created CephFS as storage for this cluster. +`--name` `` ('default =' `cephfs`):: +The ceph filesystem name. +`--pg_num` ` (8 - 32768)` ('default =' `128`):: -*pveceph createpool* `` `[OPTIONS]` +Number of placement groups for the backing data pool. The metadata pool will use a quarter of this. -Create POOL +*pveceph fs destroy* `` `[OPTIONS]` + +Destroy a Ceph filesystem ``: `` :: -The name of the pool. It must be unique. +The ceph filesystem name. -`-crush_ruleset` ` (0 - 32768)` ('default =' `0`):: +`--remove-pools` `` ('default =' `0`):: -The ruleset to use for mapping object placement in the cluster. +Remove data and metadata pools configured for this fs. -`-min_size` ` (1 - 3)` ('default =' `1`):: +`--remove-storages` `` ('default =' `0`):: -Minimum number of replicas per object +Remove all pveceph-managed storages configured for this fs. -`-pg_num` ` (8 - 32768)` ('default =' `64`):: +*pveceph help* `[OPTIONS]` -Number of placement groups. +Get help about specified command. -`-size` ` (1 - 3)` ('default =' `2`):: +`--extra-args` `` :: -Number of replicas per object +Shows help for a specific command + +`--verbose` `` :: + +Verbose output format. + +*pveceph init* `[OPTIONS]` + +Create initial ceph default configuration and setup symlinks. + +`--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 available replicas per object to allow I/O + +`--network` `` :: + +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. ++ +NOTE: 'osd pool default pg num' does not work for default pools. + +`--size` ` (1 - 7)` ('default =' `3`):: + +Targeted number of replicas per object + +*pveceph install* `[OPTIONS]` + +Install ceph related packages. + +`--allow-experimental` `` ('default =' `0`):: + +Allow experimental versions. Use with care! + +`--test-repository` `` ('default =' `0`):: + +Use the test, not the main repository. Use with care! + +`--version` `` ('default =' `pacific`):: + +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. + +``: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: + +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* `` +*pveceph mon destroy* `` -Destroy Ceph monitor. +Destroy Ceph Monitor and Manager. -``: `` :: +``: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: Monitor ID +*pveceph osd create* `` `[OPTIONS]` +Create OSD + +``: `` :: + +Block device name. +`--crush-device-class` `` :: -*pveceph destroyosd* `` `[OPTIONS]` +Set the device class of the OSD in crush. + +`--db_dev` `` :: + +Block device name for block.db. + +`--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. + +`--wal_dev` `` :: + +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]` Destroy OSD @@ -71,14 +230,63 @@ Destroy OSD OSD ID -`-cleanup` `` ('default =' `0`):: +`--cleanup` `` ('default =' `0`):: If set, we remove partition table entries. +*pveceph pool create* `` `[OPTIONS]` + +Create Ceph pool +``: `` :: + +The name of the pool. It must be unique. + +`--add_storages` `` ('default =' `0; for erasure coded pools: 1`):: + +Configure VM and CT storage using the new pool. + +`--application` `` ('default =' `rbd`):: + +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_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)` :: -*pveceph destroypool* `` `[OPTIONS]` +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 @@ -86,98 +294,108 @@ 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_ecprofile` `` ('default =' `1`):: +Remove the erasure code profile. Defaults to true, if applicable. +`--remove_storages` `` ('default =' `0`):: -*pveceph help* `[]` `[OPTIONS]` +Remove all pveceph-managed storages configured for this pool -Get help about specified command. +*pveceph pool get* `` `[OPTIONS]` `[FORMAT_OPTIONS]` -``: `` :: +List pool settings. -Command name +``: `` :: -`-verbose` `` :: +The name of the pool. It must be unique. -Verbose output format. +`--verbose` `` ('default =' `0`):: +If enabled, will display additional data(eg. statistics). +*pveceph pool ls* `[FORMAT_OPTIONS]` +List all pools. -*pveceph init* `[OPTIONS]` +*pveceph pool set* `` `[OPTIONS]` -Create initial ceph default configuration and setup symlinks. +Change POOL settings -`-network` `` :: +``: `` :: -Use specific network for all ceph related traffic +The name of the pool. It must be unique. -`-pg_bits` ` (6 - 14)` ('default =' `6`):: +`--application` `` :: -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 application of the pool. -`-size` ` (1 - 3)` ('default =' `2`):: +`--crush_rule` `` :: -Number of replicas per object +The rule to use for mapping object placement in the cluster. +`--min_size` ` (1 - 7)` :: +Minimum number of replicas per object +`--pg_autoscale_mode` `` :: -*pveceph install* `[OPTIONS]` +The automatic PG scaling mode of the pool. -Install ceph related packages. - -`-version` `` :: +`--pg_num` ` (1 - 32768)` :: -no description available +Number of placement groups. +`--pg_num_min` ` (-N - 32768)` :: +Minimal number of placement groups. +`--size` ` (1 - 7)` :: -*pveceph lspools* +Number of replicas per object -List all pools. +`--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* +*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. -*pveceph start* `[]` +*pveceph start* `[OPTIONS]` Start ceph services. -``: `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` :: +`--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)\.[A-Za-z0-9]{1,32}` :: +`--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`):: Ceph service name. - -