From: Dietmar Maurer Date: Sun, 10 Apr 2016 13:39:35 +0000 (+0200) Subject: add pveceph man page X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=commitdiff_plain;h=0840a66374ea6d49432f11addf1a32ddba3d6021;hp=ebd2a7fb21c36b69bc8c8b79fc1232b912b752bb add pveceph man page --- diff --git a/Makefile b/Makefile index e30f52b..d2fec10 100644 --- a/Makefile +++ b/Makefile @@ -16,6 +16,7 @@ COMMAND_LIST= \ pvecm \ qm \ qmrestore \ + pveceph \ pct \ pveam \ pvesm \ @@ -97,6 +98,7 @@ PVE_ADMIN_GUIDE_SOURCES= \ ${VZDUMP_MAN1_SOURCES} \ ${PVEAM_MAN1_SOURCES} \ ${PVESUBSCRIPTION_MAN1_SOURCES} \ + ${PVECEPH_MAN1_SOURCES} \ images/cluster-nwdiag.svg \ images/node-nwdiag.svg \ pve-bibliography.adoc \ diff --git a/index.adoc b/index.adoc index a73e932..d220ca0 100644 --- a/index.adoc +++ b/index.adoc @@ -28,6 +28,7 @@ Command Line Interface | qmrestore | link:qmrestore.1.html[qmrestore.1] | pct | link:pct.1.html[pct.1] | pveam | link:pveam.1.html[pveam.1] +| pveceph | link:pveceph.1.html[pveceph.1] | pvecm | link:pvecm.1.html[pvecm.1] | pveum | link:pveum.1.html[pveum.1] | pvesm | link:pvesm.1.html[pvesm.1] diff --git a/pve-admin-guide.adoc b/pve-admin-guide.adoc index 97845ef..5e21b50 100644 --- a/pve-admin-guide.adoc +++ b/pve-admin-guide.adoc @@ -54,6 +54,8 @@ Useful Command Line Tools ------------------------- :leveloffset: 2 +include::pveceph.adoc[] + include::pvesubscription.adoc[] :leveloffset: 0 @@ -83,6 +85,14 @@ include::pvesubscription.1-synopsis.adoc[] :leveloffset: 0 +*pveceph* - Manage CEPH Services on {pve} Nodes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:leveloffset: 1 +include::pveceph.1-synopsis.adoc[] + +:leveloffset: 0 + *qm* - Qemu/KVM Virtual Machine Manager ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/pve-doc-generator.mk b/pve-doc-generator.mk index 1e3928b..2e856e8 100644 --- a/pve-doc-generator.mk +++ b/pve-doc-generator.mk @@ -48,6 +48,11 @@ PVESUBSCRIPTION_MAN1_SOURCES= \ pvesubscription.1-synopsis.adoc \ ${PVE_COMMON_DOC_SOURCES} +PVECEPH_MAN1_SOURCES= \ + pveceph.adoc \ + pveceph.1-synopsis.adoc \ + ${PVE_COMMON_DOC_SOURCES} + PCT_MAN1_SOURCES= \ pct.adoc \ pct.1-synopsis.adoc \ @@ -167,6 +172,10 @@ pvesm.1: ${PVESM_MAN1_SOURCES} a2x ${A2X_MAN1_OPTIONS} pvesm.adoc test -n "$${NOVIEW}" || man -l $@ +pveceph.1: ${PVECEPH_MAN1_SOURCES} + a2x ${A2X_MAN1_OPTIONS} pveceph.adoc + test -n "$${NOVIEW}" || man -l $@ + pct.1: ${PCT_MAN1_SOURCES} a2x ${A2X_MAN1_OPTIONS} pct.adoc test -n "$${NOVIEW}" || man -l $@ diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc new file mode 100644 index 0000000..7bc02a8 --- /dev/null +++ b/pveceph.1-synopsis.adoc @@ -0,0 +1,178 @@ +*pveceph* ` [ARGS] [OPTIONS]` + +*pveceph createmon* + +Create Ceph Monitor + + + + +*pveceph createosd* `` `[OPTIONS]` + +Create OSD + +`` `string` :: + +Block device name. + +`-fstype` `(btrfs | ext4 | xfs)` (default=`xfs`):: + +File system type. + +`-journal_dev` `string` :: + +Block device name for journal. + + + + +*pveceph createpool* `` `[OPTIONS]` + +Create POOL + +`` `string` :: + +The name of the pool. It must be unique. + +`-crush_ruleset` `integer (0 - 32768)` (default=`0`):: + +The ruleset to use for mapping object placement in the cluster. + +`-min_size` `integer (1 - 3)` (default=`1`):: + +Minimum number of replicas per object + +`-pg_num` `integer (8 - 32768)` (default=`64`):: + +Number of placement groups. + +`-size` `integer (1 - 3)` (default=`2`):: + +Number of replicas per object + + + +*pveceph destroymon* `` + +Destroy Ceph monitor. + +`` `integer` :: + +Monitor ID + + + + +*pveceph destroyosd* `` `[OPTIONS]` + +Destroy OSD + +`` `integer` :: + +OSD ID + +`-cleanup` `boolean` (default=`0`):: + +If set, we remove partition table entries. + + + + +*pveceph destroypool* `` + +Destroy pool + +`` `string` :: + +The name of the pool. It must be unique. + + + + +*pveceph help* `[]` `[OPTIONS]` + +Get help about specified command. + +`` `string` :: + +Command name + +`-verbose` `boolean` :: + +Verbose output format. + + + + +*pveceph init* `[OPTIONS]` + +Create initial ceph default configuration and setup symlinks. + +`-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 deafult pools) + +`-size` `integer (1 - 3)` (default=`2`):: + +Number of replicas per object + + + + +*pveceph install* `[OPTIONS]` + +Install ceph related packages. + +`-version` `(hammer)` :: + +no description available + + + + +*pveceph lspools* + +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 service name. + + + +*pveceph status* + +Get ceph status. + + + +*pveceph stop* `[]` + +Stop ceph services. + +`` `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` :: + +Ceph service name. + + + + diff --git a/pveceph.adoc b/pveceph.adoc new file mode 100644 index 0000000..ab29e8a --- /dev/null +++ b/pveceph.adoc @@ -0,0 +1,31 @@ +ifdef::manvolnum[] +PVE({manvolnum}) +================ +include::attributes.txt[] + +NAME +---- + +pveceph - Manage CEPH Services on Proxmox VE Nodes + +SYNOPSYS +-------- + +include::pveceph.1-synopsis.adoc[] + +DESCRIPTION +----------- +endif::manvolnum[] + +ifndef::manvolnum[] +Manage CEPH Services on {pve} Nodes +=================================== +include::attributes.txt[] +endif::manvolnum[] + +Tool to manage http://ceph.com[CEPH] services on {pve} nodes. + + +ifdef::manvolnum[] +include::pve-copyright.adoc[] +endif::manvolnum[]