X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pveceph.1-synopsis.adoc;h=817c489be8bd750a23f1fd9d8c20eb7d3d343357;hb=ac70d7d134ce81431aa875c336bd547094326d9b;hp=472011778ca8d54ef5fc259890634d6d457cb66b;hpb=4d47f12597815e9a1fc3f3c1b4020e0d5c106254;p=pve-docs.git diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index 4720117..817c489 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -1,86 +1,144 @@ *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 createmon* `[OPTIONS]` +*pveceph createosd* -Create Ceph Monitor and Manager +An alias for 'pveceph osd create'. -`--exclude-manager` `` ('default =' `0`):: +*pveceph createpool* -When set, only a monitor will be created. +An alias for 'pveceph pool create'. -`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: +*pveceph destroymgr* -The ID for the monitor, when omitted the same as the nodename +An alias for 'pveceph mgr destroy'. -`--mon-address` `` :: +*pveceph destroymon* -Overwrites autodetected monitor IP address. Must be in the public network of ceph. +An alias for 'pveceph mon destroy'. -*pveceph createosd* `` `[OPTIONS]` +*pveceph destroyosd* -Create OSD +An alias for 'pveceph osd destroy'. -``: `` :: +*pveceph destroypool* -Block device name. +An alias for 'pveceph pool destroy'. -`--bluestore` `` ('default =' `1`):: +*pveceph fs create* `[OPTIONS]` -Use bluestore instead of filestore. This is the default. +Create a Ceph filesystem -`--fstype` `` ('default =' `xfs`):: +`--add-storage` `` ('default =' `0`):: -File system type (filestore only). +Configure the created CephFS as storage for this cluster. -`--journal_dev` `` :: +`--name` `` ('default =' `cephfs`):: -Block device name for journal (filestore) or block.db (bluestore). +The ceph filesystem name. -`--wal_dev` `` :: +`--pg_num` ` (8 - 32768)` ('default =' `128`):: -Block device name for block.wal (bluestore only). +Number of placement groups for the backing data pool. The metadata pool will use a quarter of this. -*pveceph createpool* `` `[OPTIONS]` +*pveceph help* `[OPTIONS]` -Create POOL +Get help about specified command. -``: `` :: +`--extra-args` `` :: -The name of the pool. It must be unique. +Shows help for a specific command -`--add_storages` `` :: +`--verbose` `` :: -Configure VM and CT storages using the new pool. +Verbose output format. -`--application` `` :: +*pveceph init* `[OPTIONS]` -The application of the pool, 'rbd' by default. +Create initial ceph default configuration and setup symlinks. -`--crush_rule` `` :: +`--cluster-network` `` :: -The rule to use for mapping object placement in the cluster. +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. ++ +NOTE: 'osd pool default pg num' does not work for default pools. `--size` ` (1 - 7)` ('default =' `3`):: -Number of replicas per object +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]` -*pveceph destroymgr* `` +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. @@ -88,7 +146,19 @@ Destroy Ceph Manager. The ID of the manager -*pveceph destroymon* `` `[OPTIONS]` +*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. @@ -96,11 +166,39 @@ Destroy Ceph Monitor and Manager. Monitor ID -`--exclude-manager` `` ('default =' `0`):: +*pveceph osd create* `` `[OPTIONS]` + +Create OSD + +``: `` :: + +Block device name. + +`--db_dev` `` :: + +Block device name for block.db. -When set, removes only the monitor, not the manager +`--db_size` ` (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`):: -*pveceph destroyosd* `` `[OPTIONS]` +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_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 @@ -112,83 +210,75 @@ OSD ID If set, we remove partition table entries. -*pveceph destroypool* `` `[OPTIONS]` +*pveceph pool create* `` `[OPTIONS]` -Destroy pool +Create POOL ``: `` :: The name of the pool. It must be unique. -`--force` `` ('default =' `0`):: - -If true, destroys pool even if in use +`--add_storages` `` :: -`--remove_storages` `` ('default =' `0`):: +Configure VM and CT storage using the new pool. -Remove all pveceph-managed storages configured for this pool - -*pveceph help* `[OPTIONS]` +`--application` `` :: -Get help about specified command. +The application of the pool, 'rbd' by default. -`--extra-args` `` :: +`--crush_rule` `` :: -Shows help for a specific command +The rule to use for mapping object placement in the cluster. -`--verbose` `` :: +`--min_size` ` (1 - 7)` ('default =' `2`):: -Verbose output format. +Minimum number of replicas per object -*pveceph init* `[OPTIONS]` +`--pg_num` ` (8 - 32768)` ('default =' `128`):: -Create initial ceph default configuration and setup symlinks. +Number of placement groups. -`--disable_cephx` `` ('default =' `0`):: +`--size` ` (1 - 7)` ('default =' `3`):: -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! +Number of replicas per object -`--min_size` ` (1 - 7)` ('default =' `2`):: +*pveceph pool destroy* `` `[OPTIONS]` -Minimum number of available replicas per object to allow I/O +Destroy pool -`--network` `` :: +``: `` :: -Use specific network for all ceph related traffic +The name of the pool. It must be unique. -`--pg_bits` ` (6 - 14)` ('default =' `6`):: +`--force` `` ('default =' `0`):: -Placement group bits, used to specify the default number of placement groups. -+ -NOTE: 'osd pool default pg num' does not work for default pools. +If true, destroys pool even if in use -`--size` ` (1 - 7)` ('default =' `3`):: +`--remove_storages` `` ('default =' `0`):: -Targeted number of replicas per object +Remove all pveceph-managed storages configured for this pool -*pveceph install* `[OPTIONS]` +*pveceph pool ls* `[FORMAT_OPTIONS]` -Install ceph related packages. +List all pools. -`--version` `` :: +*pveceph purge* `[OPTIONS]` -no description available +Destroy ceph related data and configuration files. -*pveceph lspools* +`--crash` `` :: -List all pools. +Additionally purge Ceph crash logs, /var/lib/ceph/crash. -*pveceph purge* +`--logs` `` :: -Destroy ceph related data and configuration files. +Additionally purge Ceph logs, /var/log/ceph. -*pveceph start* `[]` +*pveceph start* `[OPTIONS]` Start ceph services. -``: `(mon|mds|osd|mgr)\.[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. @@ -196,11 +286,11 @@ Ceph service name. Get ceph status. -*pveceph stop* `[]` +*pveceph stop* `[OPTIONS]` Stop ceph services. -``: `(mon|mds|osd|mgr)\.[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.