From 71e16346e55b258d45fa3bad349c1447f6811644 Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Wed, 23 Mar 2016 10:51:03 +0100 Subject: [PATCH] add pct.conf man page --- Makefile | 8 ++- gen-pct-conf-opts-adoc.pl | 10 ++++ index.adoc | 1 + pct.conf.5-opts.adoc | 112 ++++++++++++++++++++++++++++++++++++++ pct.conf.adoc | 66 ++++++++++++++++++++++ pve-admin-guide.adoc | 2 + 6 files changed, 198 insertions(+), 1 deletion(-) create mode 100755 gen-pct-conf-opts-adoc.pl create mode 100644 pct.conf.5-opts.adoc create mode 100644 pct.conf.adoc diff --git a/Makefile b/Makefile index 9e3b064..6a02c4b 100644 --- a/Makefile +++ b/Makefile @@ -21,6 +21,8 @@ PVE_ADMIN_GUIDE_SOURCES= \ datacenter.cfg.5-opts.adoc \ vm.conf.adoc \ vm.conf.5-opts.adoc \ + pct.conf.adoc \ + pct.conf.5-opts.adoc \ ${SYSADMIN_SOURCES} \ pve-admin-guide.adoc \ pve-intro.adoc \ @@ -85,6 +87,10 @@ vm.conf.5-opts.adoc: ./gen-vm-conf-opts-adoc.pl >$@.tmp mv $@.tmp $@ +pct.conf.5-opts.adoc: + ./gen-pct-conf-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 $@ @@ -95,7 +101,7 @@ vm.conf.5-opts.adoc: 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 datacenter.cfg.5.html vm.conf.5.html + $(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 vm.conf.5.html pct.conf.5.html asciidoc -a "date=$(shell date)" -a "revnumber=${RELEASE}" index.adoc $(BROWSER) index.html & diff --git a/gen-pct-conf-opts-adoc.pl b/gen-pct-conf-opts-adoc.pl new file mode 100755 index 0000000..2191d37 --- /dev/null +++ b/gen-pct-conf-opts-adoc.pl @@ -0,0 +1,10 @@ +#!/usr/bin/perl + +use strict; +use warnings; +use PVE::RESTHandler; +use PVE::LXC::Config; + +my $prop = PVE::LXC::Config->json_config_properties(); + +print PVE::RESTHandler::dump_properties($prop); diff --git a/index.adoc b/index.adoc index 00ef8f2..d3b5d25 100644 --- a/index.adoc +++ b/index.adoc @@ -31,6 +31,7 @@ include::attributes.txt[] | pve-firewall | link:pve-firewall.8.html[pve-firewall.8] | '/etc/pve/datacenter.cfg' | link:datacenter.cfg.5.html[datacenter.cfg.5] | '/etc/pve/qemu-server/.conf' | link:vm.conf.5.html[vm.conf.5] +| '/etc/pve/lxc/.conf' | link:pct.conf.5.html[pct.conf.5] |=========================================================== diff --git a/pct.conf.5-opts.adoc b/pct.conf.5-opts.adoc new file mode 100644 index 0000000..437bb42 --- /dev/null +++ b/pct.conf.5-opts.adoc @@ -0,0 +1,112 @@ +`arch`: `(amd64 | i386)` (default=`amd64`):: + +OS architecture type. + +`cmode`: `(console | shell | tty)` (default=`tty`):: + +Console mode. By default, the console command tries to open a connection to +one of the available tty devices. By setting cmode to 'console' it tries to +attach to /dev/console instead. If you set cmode to 'shell', it simply +invokes a shell inside the container (no login). + +`console`: `boolean` (default=`1`):: + +Attach a console device (/dev/console) to the container. + +`cpulimit`: `number (0 - 128)` (default=`0`):: + +Limit of CPU usage. ++ +NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' +indicates no CPU limit. + +`cpuunits`: `integer (0 - 500000)` (default=`1024`):: + +CPU weight for a VM. Argument is used in the kernel fair scheduler. The +larger the number is, the more CPU time this VM gets. Number is relative to +the weights of all the other running VMs. ++ +NOTE: You can disable fair-scheduler configuration by setting this to 0. + +`description`: `string` :: + +Container description. Only used on the configuration web interface. + +`hostname`: `string` :: + +Set a host name for the container. + +`lock`: `(backup | migrate | rollback | snapshot)` :: + +Lock/unlock the VM. + +`memory`: `integer (16 - N)` (default=`512`):: + +Amount of RAM for the VM in MB. + +`mp[n]`: `mp=, [volume=] [,acl=] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=] [,size=]` :: + +Use volume as container mount point (experimental feature). + +`nameserver`: `string` :: + +Sets DNS server IP address for a container. Create will automatically use +the setting from the host if you neither set searchdomain nor nameserver. + +`net[n]`: `name= [,bridge=>] [,firewall=<[1|0]>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=]` :: + +Specifies network interfaces for the container. + +`onboot`: `boolean` (default=`0`):: + +Specifies whether a VM will be started during system bootup. + +`ostype`: `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` :: + +OS type. This is used to setup configuration inside the container, and +corresponds to lxc setup scripts in +/usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used +to skip and OS specific setup. + +`protection`: `boolean` (default=`0`):: + +Sets the protection flag of the container. This will prevent the CT or CT's +disk remove/update operation. + +`rootfs`: `[volume=] [,acl=] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=] [,size=]` :: + +Use volume as container root. + +`searchdomain`: `string` :: + +Sets DNS search domains for a container. Create will automatically use the +setting from the host if you neither set searchdomain nor nameserver. + +`startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: + +Startup and shutdown behavior. Order is a non-negative number defining the +general startup order. Shutdown in done with reverse ordering. Additionally +you can set the 'up' or 'down' delay in seconds, which specifies a delay to +wait before the next VM is started or stopped. + +`swap`: `integer (0 - N)` (default=`512`):: + +Amount of SWAP for the VM in MB. + +`template`: `boolean` (default=`0`):: + +Enable/disable Template. + +`tty`: `integer (0 - 6)` (default=`2`):: + +Specify the number of tty available to the container + +`unprivileged`: `boolean` (default=`0`):: + +Makes the container run as unprivileged user. (Should not be modified +manually.) + +`unused[n]`: `string` :: + +Reference to unused volumes. + diff --git a/pct.conf.adoc b/pct.conf.adoc new file mode 100644 index 0000000..4b76793 --- /dev/null +++ b/pct.conf.adoc @@ -0,0 +1,66 @@ +ifdef::manvolnum[] +PVE({manvolnum}) +================ +include::attributes.txt[] + +NAME +---- + +pct.conf - Proxmox VE Container Configuration + + +SYNOPSYS +-------- + +'/etc/pve/lxc/.conf' + + +DESCRIPTION +----------- +endif::manvolnum[] + +ifndef::manvolnum[] +Container Configuration +======================= +include::attributes.txt[] +endif::manvolnum[] + +The '/etc/pve/lxc/.conf' files stores container configuration, +where "CTID" is the numeric ID of the given container. Note that IDs <= +100 are reserved for internal purposes. + + +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. + +One can use the 'pct' command to generate and modify those files. + +It is also possible to add low-level lxc style configuration directly, for +example: + + lxc.init_cmd: /sbin/my_own_init + +or + + lxc.init_cmd = /sbin/my_own_init + +Those settings are directly passed to the lxc low-level tools. + + +Options +------- + +include::pct.conf.5-opts.adoc[] + + +ifdef::manvolnum[] +include::pve-copyright.adoc[] +endif::manvolnum[] diff --git a/pve-admin-guide.adoc b/pve-admin-guide.adoc index 08f09cd..d75b19f 100644 --- a/pve-admin-guide.adoc +++ b/pve-admin-guide.adoc @@ -112,6 +112,8 @@ include::datacenter.cfg.adoc[] include::vm.conf.adoc[] +include::pct.conf.adoc[] + :leveloffset: 0 -- 2.39.2