X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pveceph.1-synopsis.adoc;h=9d545577ad3d3451e415a64fba5dc2b2a1329d60;hb=684db7e318f31946b370828dbec42bd88f6367b3;hp=790abcd61d9f636e4a9efa4a5635f924bf6d7ae4;hpb=2c0dde619dc203c365be8b15284530099d159682;p=pve-docs.git diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index 790abcd..9d54557 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -1,183 +1,373 @@ *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* -`` `string` :: +An alias for 'pveceph mgr destroy'. -Block device name. +*pveceph destroymon* -`-fstype` `(btrfs | ext4 | xfs)` (default=`xfs`):: +An alias for 'pveceph mon destroy'. -File system type. +*pveceph destroyosd* -`-journal_dev` `string` :: +An alias for 'pveceph osd destroy'. -Block device name for journal. +*pveceph destroypool* +An alias for 'pveceph pool destroy'. +*pveceph fs create* `[OPTIONS]` +Create a Ceph filesystem -*pveceph createpool* `` `[OPTIONS]` +`--add-storage` `` ('default =' `0`):: -Create POOL +Configure the created CephFS as storage for this cluster. -`` `string` :: +`--name` `` ('default =' `cephfs`):: -The name of the pool. It must be unique. +The ceph filesystem name. -`-crush_ruleset` `integer (0 - 32768)` (default=`0`):: +`--pg_num` ` (8 - 32768)` ('default =' `128`):: -The ruleset to use for mapping object placement in the cluster. +Number of placement groups for the backing data pool. The metadata pool will use a quarter of this. -`-min_size` `integer (1 - 3)` (default=`1`):: +*pveceph help* `[OPTIONS]` -Minimum number of replicas per object +Get help about specified command. -`-pg_num` `integer (8 - 32768)` (default=`64`):: +`--extra-args` `` :: -Number of placement groups. +Shows help for a specific command -`-size` `integer (1 - 3)` (default=`2`):: +`--verbose` `` :: -Number of replicas per object +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! + +`--version` `` ('default =' `nautilus`):: + +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])?` :: -*pveceph destroymon* `` +The name (ID) of the mds -Destroy Ceph monitor. +*pveceph mgr create* `[OPTIONS]` -`` `integer` :: +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. Must be in the public network 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 mon destroy* `` + +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` `` :: + +Set the device class of the OSD in crush. +`--db_dev` `` :: + +Block device name for block.db. + +`--db_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`):: -*pveceph destroyosd* `` `[OPTIONS]` +Enables encryption of the OSD. + +`--wal_dev` `` :: + +Block device name for block.wal. + +`--wal_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 -`` `integer` :: +``: `` :: OSD ID -`-cleanup` `boolean` (default=`0`):: +`--cleanup` `` ('default =' `0`):: If set, we remove partition table entries. +*pveceph pool create* `` `[OPTIONS]` +Create POOL +``: `` :: -*pveceph destroypool* `` `[OPTIONS]` - -Destroy pool +The name of the pool. It must be unique. -`` `string` :: +`--add_storages` `` :: -The name of the pool. It must be unique. +Configure VM and CT storage using the new pool. -`-force` `boolean` (default=`0`):: +`--application` `` ('default =' `rbd`):: -If true, destroys pool even if in use +The application of the pool. +`--crush_rule` `` :: +The rule to use for mapping object placement in the cluster. +`--min_size` ` (1 - 7)` ('default =' `2`):: -*pveceph help* `[]` `[OPTIONS]` +Minimum number of replicas per object -Get help about specified command. +`--pg_autoscale_mode` `` ('default =' `warn`):: -`` `string` :: +The automatic PG scaling mode of the pool. -Command name +`--pg_num` ` (1 - 32768)` ('default =' `128`):: -`-verbose` `boolean` :: +Number of placement groups. -Verbose output format. +`--pg_num_min` ` (-N - 32768)` :: +Minimal number of placement groups. +`--size` ` (1 - 7)` ('default =' `3`):: +Number of replicas per object -*pveceph init* `[OPTIONS]` +`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` :: -Create initial ceph default configuration and setup symlinks. +The estimated target size of the pool for the PG autoscaler. -`-network` `string` :: +`--target_size_ratio` `` :: -Use specific network for all ceph related traffic +The estimated target ratio of the pool for the PG autoscaler. -`-pg_bits` `integer (6 - 14)` (default=`6`):: +*pveceph pool destroy* `` `[OPTIONS]` -Placement group bits, used to specify the default number of placement groups. -+ -NOTE: 'osd pool default pg num' does not work for default pools. +Destroy pool -`-size` `integer (1 - 3)` (default=`2`):: +``: `` :: -Number of replicas per object +The name of the pool. It must be unique. +`--force` `` ('default =' `0`):: +If true, destroys pool even if in use +`--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` `(hammer)` :: +List pool settings. -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. +*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)\.[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. -`` `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` :: +*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* `[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.