From c016ebb7bcc5cd488197c1f9f55633520466497e Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Wed, 23 Mar 2016 07:32:27 +0100 Subject: [PATCH] add datacenter.cfg.5 --- Makefile | 30 +++++++++++++++++----- datacenter.cfg.5-opts.adoc | 39 +++++++++++++++++++++++++++++ datacenter.cfg.adoc | 51 ++++++++++++++++++++++++++++++++++++++ index.adoc | 1 + pve-admin-guide.adoc | 10 ++++++++ 5 files changed, 125 insertions(+), 6 deletions(-) create mode 100644 datacenter.cfg.5-opts.adoc create mode 100644 datacenter.cfg.adoc diff --git a/Makefile b/Makefile index 719ac07..fb2ca10 100644 --- a/Makefile +++ b/Makefile @@ -17,6 +17,8 @@ SYSADMIN_SOURCES= \ sysadmin.adoc PVE_ADMIN_GUIDE_SOURCES= \ + datacenter.cfg.adoc \ + datacenter.cfg.5-opts.adoc \ ${SYSADMIN_SOURCES} \ pve-admin-guide.adoc \ pve-intro.adoc \ @@ -38,6 +40,7 @@ PVE_ADMIN_GUIDE_SOURCES= \ ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)" ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG} -a "revnumber=${RELEASE}" +ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG} -a "revnumber=${RELEASE}" ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG} -a "revnumber=${RELEASE}" BROWSER?=xdg-open @@ -51,7 +54,7 @@ BROWSER?=xdg-open %.1: %.adoc %.1-synopsis.adoc docinfo.xml a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${RELEASE}" -f manpage $*.adoc - test -z "$${NOVIEW}" && man -l $@ + test -z "$${NOVIEW}" && man -l $@ %.1.html: %.adoc %.1-synopsis.adoc docinfo.xml asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc @@ -64,23 +67,35 @@ BROWSER?=xdg-open %.8: %.adoc %.8-synopsis.adoc docinfo.xml a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${RELEASE}" -f manpage $*.adoc - test -z "$${NOVIEW}" && man -l $@ + test -z "$${NOVIEW}" && man -l $@ %.8.html: %.adoc %.8-synopsis.adoc docinfo.xml asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc test -z "$${NOVIEW}" && $(BROWSER) $@ & +datacenter.cfg.5-opts.adoc: + ./gen-datacenter-cfg-opts-adoc.pl >$@.tmp + mv $@.tmp $@ + +%.5: %.adoc %.5-opts.adoc docinfo.xml + a2x -a docinfo1 -a "manvolnum=5" -a "manversion=Release ${RELEASE}" -f manpage $*.adoc + test -z "$${NOVIEW}" && man -l $@ + +%.5.html: %.adoc %.5-opts.adoc docinfo.xml + asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc + test -z "$${NOVIEW}" && $(BROWSER) $@ & + all: pve-admin-guide.html index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} $(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub - $(MAKE) NOVIEW=1 qm.1.html pct.1.html pveam.1.html pvesm.1.html pveum.1.html vzdump.1.html pve-firewall.8.html ha-manager.1.html - asciidoc -a "date=$(shell date)" -a "revnumber=${RELEASE}" index.adoc + $(MAKE) NOVIEW=1 qm.1.html pct.1.html pveam.1.html pvesm.1.html pveum.1.html vzdump.1.html pve-firewall.8.html ha-manager.1.html datacenter.cfg.5.html + asciidoc -a "date=$(shell date)" -a "revnumber=${RELEASE}" index.adoc $(BROWSER) index.html & pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES} - asciidoc -a "revnumber=${RELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc + asciidoc -a "revnumber=${RELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc test -z "$${NOVIEW}" && $(BROWSER) $@ & pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml @@ -92,6 +107,9 @@ pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES} a2x -f epub pve-admin-guide.adoc test -z "$${NOVIEW}" && $(BROWSER) $@ & +update: clean + rm -f *.5-opts.adoc .1-synopsis.adoc .8-synopsis.adoc + make all clean: - rm -rf *~ *.html *.pdf *.epub *.1 *.8 + rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8 diff --git a/datacenter.cfg.5-opts.adoc b/datacenter.cfg.5-opts.adoc new file mode 100644 index 0000000..2ef3011 --- /dev/null +++ b/datacenter.cfg.5-opts.adoc @@ -0,0 +1,39 @@ +`console:` `(applet | html5 | vv)` :: + +Select the default Console viewer. You can either use the builtin java +applet (VNC), an external virt-viewer comtatible application (SPICE), or an +HTML5 based viewer (noVNC). + +`email_from:` `string` :: + +Specify email address to send notification from (default is root@$hostname) + +`fencing:` `(both | hardware | watchdog)` (default=`watchdog`):: + +Set the fencing mode of the HA cluster. Hardware mode needs a valid +configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two +modes are used. NOTE: 'hardware' and 'both' are EXPERIMENTAL & WIP + +`http_proxy:` `http://.*` :: + +Specify external http proxy which is used for downloads (example: +'http://username:password@host:port/') + +`keyboard:` `(da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr)` :: + +Default keybord layout for vnc server. + +`language:` `(de | en)` :: + +Default GUI language. + +`max_workers:` `integer (1 - N)` :: + +Defines how many workers (per node) are maximal started on actions like +'stopall VMs' or task from the ha-manager. + +`migration_unsecure:` `boolean` :: + +Migration is secure using SSH tunnel by default. For secure private +networks you can disable it to speed up migration. + diff --git a/datacenter.cfg.adoc b/datacenter.cfg.adoc new file mode 100644 index 0000000..8028376 --- /dev/null +++ b/datacenter.cfg.adoc @@ -0,0 +1,51 @@ +ifdef::manvolnum[] +PVE({manvolnum}) +================ +include::attributes.txt[] + +NAME +---- + +datacenter.cfg - Proxmox VE Datacenter Configuration + + +SYNOPSYS +-------- + +'/etc/pve/datacenter.cfg' + + +DESCRIPTION +----------- +endif::manvolnum[] + +ifndef::manvolnum[] +Datacenter Configuration +======================== +include::attributes.txt[] +endif::manvolnum[] + +The file '/etc/pve/datacenter.cfg' is a configuration file for +{pve}. It contains cluster wide default values used by all nodes. + +File Format +----------- + +The file uses a simple colon separated key/value format. Each line has +the following format: + + OPTION: value + +Blank lines in the file are ignored, and lines starting with a '#' +character are treated as comments and are also ignored. + + +Options +------- + +include::datacenter.cfg.5-opts.adoc[] + + +ifdef::manvolnum[] +include::pve-copyright.adoc[] +endif::manvolnum[] diff --git a/index.adoc b/index.adoc index 8a2484b..8d5c06e 100644 --- a/index.adoc +++ b/index.adoc @@ -29,6 +29,7 @@ include::attributes.txt[] | vzdump | link:vzdump.1.html[vzdump.1] | ha-manager | link:ha-manager.1.html[ha-manager.1] | pve-firewall | link:pve-firewall.8.html[pve-firewall.8] +| '/etc/pve/datacenter.cfg' | link:datacenter.cfg.5.html[datacenter.cfg.5] |=========================================================== diff --git a/pve-admin-guide.adoc b/pve-admin-guide.adoc index bd30eb4..b956295 100644 --- a/pve-admin-guide.adoc +++ b/pve-admin-guide.adoc @@ -103,6 +103,16 @@ include::ha-manager.1-synopsis.adoc[] :leveloffset: 0 +[appendix] +Configuration Files +------------------- + +:leveloffset: 2 +include::test.adoc[] + +:leveloffset: 0 + + include::pve-bibliography.adoc[] :leveloffset: 1 -- 2.39.2