Proxmox/pve-docs
5
0
Fork 0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-01-07 17:17:48 +03:00
Code Releases Activity
024d3706c0
pve-docs/pveceph.1-synopsis.adoc
Thomas Lamprecht d26563851c update static and schema information 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-04-26 17:48:36 +02:00

374 lines
7.6 KiB
Plaintext
Raw Blame History

*pveceph* `<COMMAND> [ARGS] [OPTIONS]`
*pveceph createmgr*
An alias for 'pveceph mgr create'.
*pveceph createmon*
An alias for 'pveceph mon create'.
*pveceph createosd*
An alias for 'pveceph osd create'.
*pveceph createpool*
An alias for 'pveceph pool create'.
*pveceph destroymgr*
An alias for 'pveceph mgr destroy'.
*pveceph destroymon*
An alias for 'pveceph mon destroy'.
*pveceph destroyosd*
An alias for 'pveceph osd destroy'.
*pveceph destroypool*
An alias for 'pveceph pool destroy'.
*pveceph fs create* `[OPTIONS]`
Create a Ceph filesystem
`--add-storage` `<boolean>` ('default =' `0`)::
Configure the created CephFS as storage for this cluster.
`--name` `<string>` ('default =' `cephfs`)::
The ceph filesystem name.
`--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.
*pveceph help* `[OPTIONS]`
Get help about specified command.
`--extra-args` `<array>` ::
Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
*pveceph init* `[OPTIONS]`
Create initial ceph default configuration and setup symlinks.
`--cluster-network` `<string>` ::
Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it
+
NOTE: Requires option(s): `network`
`--disable_cephx` `<boolean>` ('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` `<integer> (1 - 7)` ('default =' `2`)::
Minimum number of available replicas per object to allow I/O
`--network` `<string>` ::
Use specific network for all ceph related traffic
`--pg_bits` `<integer> (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` `<integer> (1 - 7)` ('default =' `3`)::
Targeted number of replicas per object
*pveceph install* `[OPTIONS]`
Install ceph related packages.
`--allow-experimental` `<boolean>` ('default =' `0`)::
Allow experimental versions. Use with care!
`--version` `<luminous | nautilus | octopus>` ('default =' `nautilus`)::
Ceph version to install.
*pveceph lspools*
An alias for 'pveceph pool ls'.
*pveceph mds create* `[OPTIONS]`
Create Ceph Metadata Server (MDS)
`--hotstandby` `<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.
`--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* `<name>`
Destroy Ceph Metadata Server
`<name>`: `[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* `<id>`
Destroy Ceph Manager.
`<id>`: `[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` `<string>` ::
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* `<monid>`
Destroy Ceph Monitor and Manager.
`<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
Monitor ID
*pveceph osd create* `<dev>` `[OPTIONS]`
Create OSD
`<dev>`: `<string>` ::
Block device name.
`--crush-device-class` `<string>` ::
Set the device class of the OSD in crush.
`--db_dev` `<string>` ::
Block device name for block.db.
`--db_size` `<number> (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` `<boolean>` ('default =' `0`)::
Enables encryption of the OSD.
`--wal_dev` `<string>` ::
Block device name for block.wal.
`--wal_size` `<number> (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* `<osdid>` `[OPTIONS]`
Destroy OSD
`<osdid>`: `<integer>` ::
OSD ID
`--cleanup` `<boolean>` ('default =' `0`)::
If set, we remove partition table entries.
*pveceph pool create* `<name>` `[OPTIONS]`
Create POOL
`<name>`: `<string>` ::
The name of the pool. It must be unique.
`--add_storages` `<boolean>` ::
Configure VM and CT storage using the new pool.
`--application` `<cephfs | rbd | rgw>` ('default =' `rbd`)::
The application of the pool.
`--crush_rule` `<string>` ::
The rule to use for mapping object placement in the cluster.
`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
Minimum number of replicas per object
`--pg_autoscale_mode` `<off | on | warn>` ('default =' `warn`)::
The automatic PG scaling mode of the pool.
`--pg_num` `<integer> (1 - 32768)` ('default =' `128`)::
Number of placement groups.
`--pg_num_min` `<integer> (-N - 32768)` ::
Minimal number of placement groups.
`--size` `<integer> (1 - 7)` ('default =' `3`)::
Number of replicas per object
`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::
The estimated target size of the pool for the PG autoscaler.
`--target_size_ratio` `<number>` ::
The estimated target ratio of the pool for the PG autoscaler.
*pveceph pool destroy* `<name>` `[OPTIONS]`
Destroy pool
`<name>`: `<string>` ::
The name of the pool. It must be unique.
`--force` `<boolean>` ('default =' `0`)::
If true, destroys pool even if in use
`--remove_storages` `<boolean>` ('default =' `0`)::
Remove all pveceph-managed storages configured for this pool
*pveceph pool get* `<name>` `[OPTIONS]` `[FORMAT_OPTIONS]`
List pool settings.
`<name>`: `<string>` ::
The name of the pool. It must be unique.
`--verbose` `<boolean>` ('default =' `0`)::
If enabled, will display additional data(eg. statistics).
*pveceph pool ls* `[FORMAT_OPTIONS]`
List all pools.
*pveceph pool set* `<name>` `[OPTIONS]`
Change POOL settings
`<name>`: `<string>` ::
The name of the pool. It must be unique.
`--application` `<cephfs | rbd | rgw>` ::
The application of the pool.
`--crush_rule` `<string>` ::
The rule to use for mapping object placement in the cluster.
`--min_size` `<integer> (1 - 7)` ::
Minimum number of replicas per object
`--pg_autoscale_mode` `<off | on | warn>` ::
The automatic PG scaling mode of the pool.
`--pg_num` `<integer> (1 - 32768)` ::
Number of placement groups.
`--pg_num_min` `<integer> (-N - 32768)` ::
Minimal number of placement groups.
`--size` `<integer> (1 - 7)` ::
Number of replicas per object
`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::
The estimated target size of the pool for the PG autoscaler.
`--target_size_ratio` `<number>` ::
The estimated target ratio of the pool for the PG autoscaler.
*pveceph purge* `[OPTIONS]`
Destroy ceph related data and configuration files.
`--crash` `<boolean>` ::
Additionally purge Ceph crash logs, /var/lib/ceph/crash.
`--logs` `<boolean>` ::
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.
View Git Blame Copy Permalink