X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pveceph.1-synopsis.adoc;h=c0121c7431ee90a838a8fe970a193fa35d66b9c5;hp=a1ee3ee52c9bd1627ae14122ea9fac2f264eff89;hb=a6c4e7fa9ae14cf2e34baa8febdc9b7ff672d389;hpb=5d9c884c7b3f4980abbd4cbe91ea588a03266485 diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index a1ee3ee..c0121c7 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -1,197 +1,285 @@ *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* -`-bluestore` `` ('default =' `0`):: +An alias for 'pveceph mon destroy'. -Use bluestore instead of filestore. +*pveceph destroyosd* -`-fstype` `` ('default =' `xfs`):: +An alias for 'pveceph osd destroy'. -File system type (filestore only). +*pveceph destroypool* -`-journal_dev` `` :: +An alias for 'pveceph pool destroy'. -Block device name for journal. +*pveceph fs create* `[OPTIONS]` +Create a Ceph filesystem +`--add-storage` `` ('default =' `0`):: +Configure the created CephFS as storage for this cluster. -*pveceph createpool* `` `[OPTIONS]` +`--name` `` ('default =' `cephfs`):: -Create POOL +The ceph filesystem name. -``: `` :: +`--pg_num` ` (8 - 32768)` ('default =' `128`):: -The name of the pool. It must be unique. +Number of placement groups for the backing data pool. The metadata pool will use a quarter of this. -`-crush_ruleset` ` (0 - 32768)` ('default =' `0`):: +*pveceph help* `[OPTIONS]` -The ruleset to use for mapping object placement in the cluster. +Get help about specified command. -`-min_size` ` (1 - 7)` ('default =' `1`):: +`--extra-args` `` :: -Minimum number of replicas per object +Shows help for a specific command -`-pg_num` ` (8 - 32768)` ('default =' `64`):: +`--verbose` `` :: -Number of placement groups. +Verbose output format. -`-size` ` (1 - 7)` ('default =' `2`):: +*pveceph init* `[OPTIONS]` -Number of replicas per object +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` -*pveceph destroymon* `` +`--disable_cephx` `` ('default =' `0`):: -Destroy Ceph monitor. +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`):: -Monitor ID +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`):: -*pveceph destroyosd* `` `[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 OSD +`--size` ` (1 - 7)` ('default =' `3`):: -``: `` :: +Targeted number of replicas per object -OSD ID +*pveceph install* `[OPTIONS]` -`-cleanup` `` ('default =' `0`):: +Install ceph related packages. -If set, we remove partition table entries. +`--version` `` ('default =' `nautilus`):: +Ceph version to install. +*pveceph lspools* +An alias for 'pveceph pool ls'. -*pveceph destroypool* `` `[OPTIONS]` +*pveceph mds create* `[OPTIONS]` -Destroy pool +Create Ceph Metadata Server (MDS) -``: `` :: +`--hotstandby` `` ('default =' `0`):: -The name of the pool. It must be unique. +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. -`-force` `` ('default =' `0`):: +`--name` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ('default =' `nodename`):: -If true, destroys pool even if in use +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 help* `[]` `[OPTIONS]` +The name (ID) of the mds -Get help about specified command. +*pveceph mgr create* `[OPTIONS]` -``: `` :: +Create Ceph Manager -Command name +`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: -`-verbose` `` :: +The ID for the manager, when omitted the same as the nodename -Verbose output format. +*pveceph mgr destroy* `` +Destroy Ceph Manager. +``: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: +The ID of the manager -*pveceph init* `[OPTIONS]` +*pveceph mon create* `[OPTIONS]` -Create initial ceph default configuration and setup symlinks. +Create Ceph Monitor and Manager -`-disable_cephx` `` ('default =' `0`):: +`--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 + +``: `` :: -Disable cephx authentification. +Block device name. + +`--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. + -WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private! +NOTE: Requires option(s): `db_dev` -`-min_size` ` (1 - 7)` ('default =' `2`):: +`--encrypted` `` ('default =' `0`):: -Minimum number of available replicas per object to allow I/O +Enables encryption of the OSD. -`-network` `` :: +`--wal_dev` `` :: -Use specific network for all ceph related traffic +Block device name for block.wal. -`-pg_bits` ` (6 - 14)` ('default =' `6`):: +`--wal_size` ` (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`):: -Placement group bits, used to specify the default number of placement groups. +Size in GiB for block.wal. + -NOTE: 'osd pool default pg num' does not work for default pools. +NOTE: Requires option(s): `wal_dev` -`-size` ` (1 - 7)` ('default =' `3`):: +*pveceph osd destroy* `` `[OPTIONS]` -Targeted number of replicas per object +Destroy OSD + +``: `` :: +OSD ID +`--cleanup` `` ('default =' `0`):: +If set, we remove partition table entries. -*pveceph install* `[OPTIONS]` +*pveceph pool create* `` `[OPTIONS]` -Install ceph related packages. +Create POOL -`-version` `` :: +``: `` :: -no description available +The name of the pool. It must be unique. +`--add_storages` `` :: +Configure VM and CT storage using the new pool. +`--application` `` :: -*pveceph lspools* +The application of the pool, 'rbd' by default. -List all pools. +`--crush_rule` `` :: +The rule to use for mapping object placement in the cluster. +`--min_size` ` (1 - 7)` ('default =' `2`):: +Minimum number of replicas per object -*pveceph purge* +`--pg_num` ` (8 - 32768)` ('default =' `128`):: -Destroy ceph related data and configuration files. +Number of placement groups. + +`--size` ` (1 - 7)` ('default =' `3`):: + +Number of replicas per object + +*pveceph pool destroy* `` `[OPTIONS]` + +Destroy pool + +``: `` :: + +The name of the pool. It must be unique. + +`--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. +*pveceph purge* + +Destroy ceph related data and configuration files. *pveceph start* `[]` Start ceph services. -``: `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` :: +``: `(ceph|mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`):: Ceph service name. - - *pveceph status* Get ceph status. - - *pveceph stop* `[]` Stop ceph services. -``: `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` :: +``: `(ceph|mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`):: Ceph service name. - -