X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pveceph.1-synopsis.adoc;h=7a2699f1054d72e45187810559ad8ac71bfbaa02;hb=907dcea1d0a253fb8e5ec1f3621d45ba84a8c817;hp=3579c6fb2ee97f072cb791ecb529a5d2e73c726e;hpb=04ce4dfa6d97e119eebc5906873362fa5d0c33e5;p=pve-docs.git diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index 3579c6f..7a2699f 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -1,180 +1,401 @@ *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 fs destroy* `` `[OPTIONS]` -Minimum number of replicas per object +Destroy a Ceph filesystem -`-pg_num` `integer (8 - 32768)` (default=`64`):: +``: `` :: -Number of placement groups. +The ceph filesystem name. -`-size` `integer (1 - 3)` (default=`2`):: +`--remove-pools` `` ('default =' `0`):: -Number of replicas per object +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. + +`--extra-args` `` :: + +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. -*pveceph destroymon* `` +`--monid` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: -Destroy Ceph monitor. +The ID for the monitor, when omitted the same as the nodename -`` `integer` :: +*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_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 destroyosd* `` `[OPTIONS]` +*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 Ceph pool +``: `` :: -*pveceph destroypool* `` +The name of the pool. It must be unique. -Destroy pool +`--add_storages` `` ('default =' `0; for erasure coded pools: 1`):: -`` `string` :: +Configure VM and CT storage using the new pool. -The name of the pool. It must be unique. +`--application` `` ('default =' `rbd`):: +The application of the pool. +`--crush_rule` `` :: +The rule to use for mapping object placement in the cluster. -*pveceph help* `[]` `[OPTIONS]` +`--erasure-coding` `k= ,m= [,device-class=] [,failure-domain=] [,profile=]` :: -Get help about specified command. +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. -`` `string` :: +`--min_size` ` (1 - 7)` ('default =' `2`):: -Command name +Minimum number of replicas per object -`-verbose` `boolean` :: +`--pg_autoscale_mode` `` ('default =' `warn`):: -Verbose output format. +The automatic PG scaling mode of the pool. +`--pg_num` ` (1 - 32768)` ('default =' `128`):: +Number of placement groups. +`--pg_num_min` ` (-N - 32768)` :: -*pveceph init* `[OPTIONS]` +Minimal number of placement groups. -Create initial ceph default configuration and setup symlinks. +`--size` ` (1 - 7)` ('default =' `3`):: -`-network` `string` :: +Number of replicas per object -Use specific network for all ceph related traffic +`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` :: -`-pg_bits` `integer (6 - 14)` (default=`6`):: +The estimated target size of the pool for the PG autoscaler. -Placement group bits, used to specify the default number of placement -groups. -+ -NOTE: 'osd pool default pg num' does not work for default pools. +`--target_size_ratio` `` :: -`-size` `integer (1 - 3)` (default=`2`):: +The estimated target ratio of the pool for the PG autoscaler. -Number of replicas per object +*pveceph pool destroy* `` `[OPTIONS]` +Destroy pool +``: `` :: +The name of the pool. It must be unique. -*pveceph install* `[OPTIONS]` +`--force` `` ('default =' `0`):: -Install ceph related packages. +If true, destroys pool even if in use -`-version` `(hammer)` :: +`--remove_ecprofile` `` ('default =' `1`):: -no description available +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 get* `` `[OPTIONS]` `[FORMAT_OPTIONS]` -*pveceph lspools* +List pool settings. + +``: `` :: + +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. +*pveceph pool set* `` `[OPTIONS]` + +Change POOL settings +``: `` :: +The name of the pool. It must be unique. -*pveceph purge* +`--application` `` :: -Destroy ceph related data and configuration files. +The application of the pool. +`--crush_rule` `` :: +The rule to use for mapping object placement in the cluster. +`--min_size` ` (1 - 7)` :: -*pveceph start* `[]` +Minimum number of replicas per object -Start ceph services. +`--pg_autoscale_mode` `` :: -`` `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` :: +The automatic PG scaling mode of the pool. -Ceph service name. +`--pg_num` ` (1 - 32768)` :: +Number of placement groups. +`--pg_num_min` ` (-N - 32768)` :: -*pveceph status* +Minimal number of placement groups. -Get ceph status. +`--size` ` (1 - 7)` :: +Number of replicas per object +`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` :: -*pveceph stop* `[]` +The estimated target size of the pool for the PG autoscaler. -Stop ceph services. +`--target_size_ratio` `` :: -`` `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` :: +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. + +*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.