X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pveceph.1-synopsis.adoc;h=c0121c7431ee90a838a8fe970a193fa35d66b9c5;hb=f11fb629b7ecdcff4a3f7ec8287241bc290afa5b;hp=790abcd61d9f636e4a9efa4a5635f924bf6d7ae4;hpb=2c0dde619dc203c365be8b15284530099d159682;p=pve-docs.git diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index 790abcd..c0121c7 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -1,183 +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* -`` `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. -*pveceph destroymon* `` +`--cluster-network` `` :: -Destroy Ceph monitor. +Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it ++ +NOTE: Requires option(s): `network` -`` `integer` :: +`--disable_cephx` `` ('default =' `0`):: -Monitor ID +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` `` :: -*pveceph destroyosd* `` `[OPTIONS]` +Use specific network for all ceph related traffic -Destroy OSD +`--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. -`` `integer` :: +`--size` ` (1 - 7)` ('default =' `3`):: -OSD ID +Targeted number of replicas per object -`-cleanup` `boolean` (default=`0`):: +*pveceph install* `[OPTIONS]` -If set, we remove partition table entries. +Install ceph related packages. +`--version` `` ('default =' `nautilus`):: +Ceph version to install. +*pveceph lspools* -*pveceph destroypool* `` `[OPTIONS]` +An alias for 'pveceph pool ls'. -Destroy pool +*pveceph mds create* `[OPTIONS]` -`` `string` :: +Create Ceph Metadata Server (MDS) -The name of the pool. It must be unique. +`--hotstandby` `` ('default =' `0`):: -`-force` `boolean` (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. -If true, destroys pool even if in use +`--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 -*pveceph help* `[]` `[OPTIONS]` +``: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: -Get help about specified command. +The name (ID) of the mds -`` `string` :: +*pveceph mgr create* `[OPTIONS]` -Command name +Create Ceph Manager -`-verbose` `boolean` :: +`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: -Verbose output format. +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])?` :: -*pveceph init* `[OPTIONS]` +The ID of the manager -Create initial ceph default configuration and setup symlinks. +*pveceph mon create* `[OPTIONS]` -`-network` `string` :: +Create Ceph Monitor and Manager -Use specific network for all ceph related traffic +`--mon-address` `` :: -`-pg_bits` `integer (6 - 14)` (default=`6`):: +Overwrites autodetected monitor IP address. Must be in the public network of ceph. -Placement group bits, used to specify the default number of placement groups. +`--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. + +`--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: 'osd pool default pg num' does not work for default pools. +NOTE: Requires option(s): `db_dev` -`-size` `integer (1 - 3)` (default=`2`):: +`--encrypted` `` ('default =' `0`):: -Number of replicas per object +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`):: -*pveceph install* `[OPTIONS]` +Size in GiB for block.wal. ++ +NOTE: Requires option(s): `wal_dev` -Install ceph related packages. +*pveceph osd destroy* `` `[OPTIONS]` -`-version` `(hammer)` :: +Destroy OSD -no description available +``: `` :: +OSD ID +`--cleanup` `` ('default =' `0`):: +If set, we remove partition table entries. -*pveceph lspools* +*pveceph pool create* `` `[OPTIONS]` -List all pools. +Create POOL +``: `` :: +The name of the pool. It must be unique. +`--add_storages` `` :: -*pveceph purge* +Configure VM and CT storage using the new pool. -Destroy ceph related data and configuration files. +`--application` `` :: + +The application of the pool, 'rbd' by default. + +`--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 + +`--pg_num` ` (8 - 32768)` ('default =' `128`):: + +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. - -