X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pveceph.1-synopsis.adoc;h=8252e805a9b6e3b56f953bdc3a13c311457a4b79;hp=472011778ca8d54ef5fc259890634d6d457cb66b;hb=7d6078845fa6a3bd308c7dc843273e56be33f315;hpb=4d47f12597815e9a1fc3f3c1b4020e0d5c106254 diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index 4720117..8252e80 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -1,86 +1,140 @@ *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 authentification. ++ +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. + +`--version` `` :: + +no description available + +*pveceph lspools* + +An alias for 'pveceph pool ls'. -*pveceph destroymgr* `` +*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. @@ -88,7 +142,23 @@ Destroy Ceph Manager. The ID of the manager -*pveceph destroymon* `` `[OPTIONS]` +*pveceph mon create* `[OPTIONS]` + +Create Ceph Monitor and Manager + +`--exclude-manager` `` ('default =' `0`):: + +When set, only a monitor will be created. + +`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: + +The ID for the monitor, when omitted the same as the nodename + +`--mon-address` `` :: + +Overwrites autodetected monitor IP address. Must be in the public network of ceph. + +*pveceph mon destroy* `` `[OPTIONS]` Destroy Ceph Monitor and Manager. @@ -100,83 +170,91 @@ Monitor ID When set, removes only the monitor, not the manager -*pveceph destroyosd* `` `[OPTIONS]` +*pveceph osd create* `` `[OPTIONS]` -Destroy OSD +Create OSD -``: `` :: +``: `` :: -OSD ID +Block device name. -`--cleanup` `` ('default =' `0`):: +`--bluestore` `` ('default =' `1`):: -If set, we remove partition table entries. +Use bluestore instead of filestore. This is the default. -*pveceph destroypool* `` `[OPTIONS]` +`--fstype` `` ('default =' `xfs`):: -Destroy pool +File system type (filestore only). -``: `` :: +`--journal_dev` `` :: -The name of the pool. It must be unique. +Block device name for journal (filestore) or block.db (bluestore). -`--force` `` ('default =' `0`):: +`--wal_dev` `` :: -If true, destroys pool even if in use +Block device name for block.wal (bluestore only). -`--remove_storages` `` ('default =' `0`):: +*pveceph osd destroy* `` `[OPTIONS]` -Remove all pveceph-managed storages configured for this pool +Destroy OSD -*pveceph help* `[OPTIONS]` +``: `` :: -Get help about specified command. +OSD ID -`--extra-args` `` :: +`--cleanup` `` ('default =' `0`):: -Shows help for a specific command +If set, we remove partition table entries. -`--verbose` `` :: +*pveceph pool create* `` `[OPTIONS]` -Verbose output format. +Create POOL -*pveceph init* `[OPTIONS]` +``: `` :: -Create initial ceph default configuration and setup symlinks. +The name of the pool. It must be unique. -`--disable_cephx` `` ('default =' `0`):: +`--add_storages` `` :: -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! +Configure VM and CT storage using the new pool. -`--min_size` ` (1 - 7)` ('default =' `2`):: +`--application` `` :: -Minimum number of available replicas per object to allow I/O +The application of the pool, 'rbd' by default. -`--network` `` :: +`--crush_rule` `` :: -Use specific network for all ceph related traffic +The rule to use for mapping object placement in the cluster. -`--pg_bits` ` (6 - 14)` ('default =' `6`):: +`--min_size` ` (1 - 7)` ('default =' `2`):: -Placement group bits, used to specify the default number of placement groups. -+ -NOTE: 'osd pool default pg num' does not work for default pools. +Minimum number of replicas per object + +`--pg_num` ` (8 - 32768)` ('default =' `128`):: + +Number of placement groups. `--size` ` (1 - 7)` ('default =' `3`):: -Targeted number of replicas per object +Number of replicas per object -*pveceph install* `[OPTIONS]` +*pveceph pool destroy* `` `[OPTIONS]` -Install ceph related packages. +Destroy pool -`--version` `` :: +``: `` :: -no description available +The name of the pool. It must be unique. -*pveceph lspools* +`--force` `` ('default =' `0`):: + +If true, destroys pool even if in use + +`--remove_storages` `` ('default =' `0`):: + +Remove all pveceph-managed storages configured for this pool + +*pveceph pool ls* List all pools. @@ -188,7 +266,7 @@ Destroy ceph related data and configuration files. Start ceph services. -``: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` :: +``: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`):: Ceph service name. @@ -200,7 +278,7 @@ Get ceph status. Stop ceph services. -``: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` :: +``: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`):: Ceph service name.