source: ProjectBuilder/devel/pb-modules/etc/pb.conf.pod@ 1072

Last change on this file since 1072 was 1072, checked in by Bruno Cornec, 14 years ago

r3953@sge91-1-82-234-15-218: bruno | 2010-07-11 23:43:35 +0200

  • Fix partly #41 by externalizing the VM command in the new vmcmd option
File size: 24.6 KB
RevLine 
[962]1=pod
2
3=head1 NAME
4
5Documentation for pb configuration files
6
7=head1 DESCRIPTION
8
9pb helps you build various packages directly from your project sources.
10In order to work correctly, it relies on a certain number of configuration files. Most of these configuration parameters can be setup in all the configuration files, however, they generally make more sense in a specific one, which is indicated. There are mainly 4 configuration files, the one in the home directory of the user (used first), the one from the project (use in second), the one in the VM/VE hosting directory, and the one provided by the tool in /etc/pb or /usr/local/etc/pb (lastly).
11
12=head1 SYNOPSIS
13
14Those files have the same format, which is near from a a perl hash structure:
15keyword key = value1[,value2,...]
16
17The key could be also default, in which case it will be used as a default value if no more precise content is given for the key.
18
[986]19Each value is detailed below giving the nature of its use (Mandatory or Optional - only used for certain feature), the value of the key (could be the project, an OS name, default, ...), the value of the parameter field and its format, the default configuration file in which it should be defined (home $HOME/.pbrc, conf /etc/pb/pb.conf or /usr/local/etc/pb/pb.conf, VE vepath/.pbrc, VM vmpath/.pbrc, or project project.pb) and an example of use.
[985]20
[962]21=head1 OPTIONS
22
23=over 4
24
[989]25=item B<defpkgdir>
[962]26
[989]27 Nature: Mandatory
28 Key: project (as defined in the -p option or PBPROJ environment variable)
29 Value: coma separated list of packages built by default in this project. When not using any package name as a parameter to pb commands, this list will be used.
30 Conffile: project
31 Example: defpkgdir mondorescue = mondo,mindi NB: a default value is not really meaningful.
[962]32
[1066]33=item B<delivery>
34
35 Nature: Optional
36 Key: project (as defined in the -p option or PBPROJ environment variable)
37 Value: directory where to deliver packages once built for ftp/web access.
38 Conffile: project
39 Example: delivery mondorescue = prod
40
[962]41=item B<extpkgdir>
42
[989]43 Nature: Optional
44 Key: project (as defined in the -p option or PBPROJ environment variable)
45 Value: coma separated list of packages built in addition in this project. When using the all package name as a parameter to pb commands, this list will be used, in addition to the defpkgdir list.
46 Conffile: project
47 Example: extpkgdir mondorescue = mondo-doc,mindi-mindibusybox
[962]48
49=item B<filteredfiles>
50
[989]51 Nature: Optional
52 Key: package (as provided in defpkgdir or extpkgdir)
53 Value: coma separated list of files that will be filtered using the macro system from pb, during the creation of the compressed source tar files for this package. Their path is relative to the directory containing the package.
54 Conffile: project
55 Example: filteredfiles mindi = rootfs/sbin/init,mindi,install.sh,doc/mindi.8
[962]56
57=item B<namingtype>
58
[989]59 Nature: Optional
60 Key: package (as provided in defpkgdir or extpkgdir)
61 Value: perl, if packages are CPAN perl modules that need to be named respecting the distribution perl convention (perl-Name for rpm, libname-perl for deb)
62 Conffile: project
63 Example: namingtype ProjectBuilder = perl
[962]64
65=item B<osambiguous>
66
[989]67 Nature: Optional
68 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). In that case, should be an OS name.
69 Value: coma separated list of distributions which use the same file name in /etc for different distributions (ex: /etc/redhat-release for redhat, rhel, mandriva,...). Cf: B<osrelambfile>
70 Conffile: pb
71 Example: osambiguous debian = debian,ubuntu
[962]72
73=item B<oscodename>
74
[989]75 Nature: Optional
76 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). In that case, should be an os-ver.
77 Value: code name. Mostly useful for debian and ubuntu, due to debootstrap.
78 Conffile: pb
79 Example: oscodename debian-5.0 = lenny
[962]80
81=item B<osfamily>
82
[989]83 Nature: Mandatory
84 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). In that case, should be an os.
85 Value: OS family name (used to group similar distribution for handling)
86 Conffile: pb
87 Example: osfamily debian = du
[962]88
89=item B<osmindep>
90
[989]91 Nature: Optional
92 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). NB: a default value is highly interesting here.
93 Value: coma separated list of packages needed before setupvm|ve can be run. Install them with your distribution in VM or automatically in VE when possible.
94 Conffile: pb
95 Example: osmindep default = perl,sudo,wget,tar,make,gzip
[962]96
97=item B<osnover>
98
[989]99 Nature: Optional
100 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
101 Value: true|false. True means that this OS has no need to keep the version
102 Conffile: pb
103 Example: osnover gentoo = true
[962]104
105=item B<osperldep>
106
[989]107 Nature: Optional
108 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
109 Value: coma separated list of perl modules needed by pb and not provided in a package format for the relative OS, and that will be installed from CPAN in your VM/VE.
110 Conffile: pb
111 Example: osperldep rhel-5 = Module-Build,File-MimeInfo,File-BaseDir,Mail-Sendmail
[962]112
113=item B<osperlver>
114
[989]115 Nature: Mandatory (for each module mentioned in B<osperldep>)
116 Key: Perl Module (as defined in B<osperldep>)
117 Value: Version of the perl module that needs to be found on CPAN.
118 Conffile: pb
119 Example: Date-Manip = 5.54
[962]120
121=item B<ospkgdep>
122
[989]123 Nature: Optional
124 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
125 Value: coma separated list of packages that are needed by pb and should be installed automatically in the VM/VE during the setupvm|ve phasis by pb.
126 Conffile: pb
127 Example: ospkgdep rhel-5 = wget,make,ntp,patch,perl-DateManip
[962]128
129=item B<osrelambfile>
130
[989]131 Nature: Mandatory (per OS mentioned in B<osambiguous>)
132 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). Should be the OS name here.
133 Value: full path name of the ambiguous file describing that distribution, as well as some others. All the distributions mentioned here should also be mentioned with their ambiguous other distribution in the B<osambiguous> parameter.
134 Conffile: pb
135 Example: osrelambfile debian = /etc/debian_version
[962]136
137=item B<osrelexpr>
138
[989]139 Nature: Mandatory (per OS mentioned in B<osrelambfile> and B<osrelfile>)
140 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
141 Value: the perl regular expression used to parse the B<osrelambfile> in order to extract from it the version of the distribution (in parenthesis to allow its usage as $1 by perl)
142 Conffile: pb
[962]143osrelexpr rhel = Red Hat (?:Enterprise Linux|Linux Advanced Server) .*release ([0-9.]+).* \(
[989]144 Example:
[962]145
146=item B<osrelfile>
147
[989]148 Nature: Mandatory
149 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). Should be the OS name here.
150 Value: full path name of the file describing non-ambiguously that distribution. There should be a bijection between the file and the distribution name.
151 Conffile: pb
152 Example: osrelfile fedora = /etc/fedora-release
[962]153
154=item B<osremovedotinver>
155
[989]156 Nature: Optional
157 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
158 Value: true|false. If true, then no '.' (dot) character is kept in the version name of that OS.
159 Conffile: pb
160 Example: osremovedotinver redhat = true
[962]161
162=item B<ossuffix>
163
[989]164 Nature: Optional
165 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
166 Value: suffix that will be used in the name of the packages created. By default, concatenation of OS name and version.
167 Conffile: pb
168 Example: ossuffix mandriva = mdv
[962]169
170=item B<ostype>
171
[989]172 Nature: Mandatory
173 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). The family name is generaly used here.
174 Value: build type grouping packages family. This is used internaly by pb to make various handling depending on that build type.
175 Conffile: pb
176 Example: ostype rh = rpm, ostype md = rpm, ostype novell = rpm
[962]177
178=item B<osupd>
179
[989]180 Nature: Optional
181 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). The family name is generaly used here.
182 Value: OS command to lauch in order to automatically install packages on it.
183 Conffile: pb
184 Example: ostype rh = rpm, ostype md = rpm, ostype novell = rpm
[962]185
186=item B<pbconfurl>
187
[989]188 Nature: Mandatory
189 Key: project (as defined in the -p option or PBPROJ environment variable)
190 Value: B<pb URL> giving access to where the pb configuration dir is stored. Under that directory you have the same tree infrastructure as the upstream project, and under the pb packaging infra, including the project configuration file. Cf: man
191 Conffile: home|project
192 Example: pbconfurl fossology = svn+ssh://user@svn.project-builder.org/mondo/svn/pb/projects/fossology/pbconf, cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe/pbconf
[962]193
194=item B<pbdefdir>
195
[989]196 Nature: Optional
197 Key: project (as defined in the -p option or PBPROJ environment variable)
198 Value: local directory under which every pb related operation will take place. if not defined then /var/cache. A default value is highly interesting here. If you want to use VMs/VEs, then use $ENV{'HOME'} to make it portable to it.
199 Conffile: home
200 Example: pbdefdir default = $ENV{'HOME'}/local/pb/projects
[962]201
202=item B<pbml>
203
[989]204 Nature: Optional (Mandatory if using announce command)
205 Key: project (as defined in the -p option or PBPROJ environment variable)
206 Value: white space separated list of e-mail adresses used to send announces with the pb announce option.
207 Conffile: project
208 Example: pbml pb = pb-announce@project-builder.org pb-devel@project-builder.org
[962]209
210=item B<pbpackager>
211
[989]212 Nature: Mandatory
213 Key: project (as defined in the -p option or PBPROJ environment variable)
214 Value: Firstname Name and e-mail address of the person packaging the software.
215 Conffile: project
216 Example: pbpackager pb = Bruno Cornec <bruno@project-builder.org>
[962]217
218=item B<pbprojdir>
219
[989]220 Nature: Optional
221 Key: project (as defined in the -p option or PBPROJ environment variable)
222 Value: local directory under which the project is locally exported. NB: a default value is highly interesting here. By default pbdefdir/projectname
223 Conffile: home
224 Example: pbprojdir mondorescue = $ENV{'HOME'}/local/mondorescue
[962]225
226=item B<pbrepo>
227
[989]228 Nature: Mandatory
229 Key: project (as defined in the -p option or PBPROJ environment variable)
230 Value: URL of the server hosting the upstream tar file.
231 Conffile: project
232 Example: pbrepo mondorescue = ftp://ftp.mondorescue.org
[962]233
234=item B<pbsmtp>
235
[989]236 Nature: Optional (Mandatory if using the announce command)
237 Key: project (as defined in the -p option or PBPROJ environment variable)
238 Value: FQDN of the mail server to use to send announces. NB: a default value is highly interesting here.
239 Conffile: home
240 Example: pbsmtp mondorescue = localhost
[962]241
242=item B<pbsockscmd>
243
[989]244 Nature: Optional
245 Key: project (as defined in the -p option or PBPROJ environment variable)
246 Value: name of the command to use to socksify network calls. NB: a default value is highly interesting here.
247 Conffile: home
248 Example: pbsockscmd default = tsocks
[962]249
250=item B<pburl>
[985]251
[989]252 Nature: Optional
253 Key: project (as defined in the -p option or PBPROJ environment variable)
254 Value: B<pb URL> giving access to where the project is stored. Normaly provided by the project, but could be overloaded for specific authentication information in the home configuration file or when using a DVCS
255 Conffile: home|project
256 Example: pburl linuxcoe = cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe, pburl pb = svk:////local/pb
[985]257
[962]258=item B<pbwf>
[985]259
[989]260 Nature: Optional
261 Key: project (as defined in the -p option or PBPROJ environment variable)
262 Value: whatever. As soon as this is defined, then that project is known as not well formed (have a subdirectory in its tar file under which all sources are put named project-version). This should be reported upstream to the project. tar files generated by project-builder to not suffer from that. This is valid when packaging for tar files and not CMS.
263 Conffile: project
264 Example: pbwf afio = 1
[985]265
[962]266=item B<pkgtag>
[985]267
[989]268 Nature: Optional
269 Key: package (as provided in defpkgdir or extpkgdir)
270 Value: Tag that needs to be used in package name (on rpm: name-ver-tag.arch.rpm). Useful when different from the project version B<projtag> and when republishing a package due to package build modification (not code).
271 Conffile: project
272 Example: pkgtag mindi-busybox = 2
[985]273
[962]274=item B<pkgver>
[985]275
[989]276 Nature: Optional
277 Key: package (as provided in defpkgdir or extpkgdir)
278 Value: Version that needs to be used in package name (on rpm: name-ver-tag.arch.rpm). Useful when different from the project version B<projver>.
279 Conffile: project
280 Example: pkgver mindi-busybox = 1.7.3
[985]281
[962]282=item B<projtag>
[986]283
[989]284 Nature: Mandatory
285 Key: project (as defined in the -p option or PBPROJ environment variable)
286 Value: tag that will be used for all packages names (on rpm: name-ver-tag.arch.rpm) in the project. Each package can overwrite it using B<pkgtag>.
287 Conffile: project
288 Example: projtag mondorescue = 1
[986]289
[962]290=item B<projver>
[986]291
[989]292 Nature: Mandatory
293 Key: project (as defined in the -p option or PBPROJ environment variable)
294 Value: version that will be used for all packages names (on rpm: name-ver-tag.arch.rpm) in the project. Each package can overwrite it using B<pkgver>.
295 Conffile: project
296 Example: projver mondorescue = 2.2.9
[986]297
298=item B<rbsconf>
299
[989]300 Nature: Optional
301 Key: project (as defined in the -p option or PBPROJ environment variable)
302 Value: for mock it's the configuration directory. For rinse it's its configuration file. For rpmbootstrap it's not used yet.
303 Conffile: ve
304 Example: rbsconf default = /etc/mock, rbsconf default = /etc/pb/pb-rinse.conf
[986]305
306=item B<rbsb4pi>
307
[989]308 Nature: Optional
309 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). The family name is generaly used here.
310 Value: for mock it's not used. For rinse it's the script to call before doing installation (in order change the mirror location). For rpmbootstrap it's not used yet.
311 Conffile: ve
312 Example: rbsb4pi centos = /home/rinse/bin/before-post-install.sh
[986]313
[1027]314=item B<rbsopt>
315
316 Nature: Optional
317 Key: tool used for rpm based VE. Could be one of rpmbootstrap, rinse, mock, ...
318 Value: Additional option to pass to the command
319 Conffile: ve
320 Example: rbsopt rpmbootstrap = -k
321
[987]322=item B<rbspi>
323
[989]324 Nature: Optional
325 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). The family name is generaly used here.
326 Value: for mock it's not used. For rinse it's the script to call after doing installation for customization. For rpmbootstrap it's the script to call after doing installation for customization.
327 Conffile: ve
[1027]328 Example: rbspi centos = /home/rinse/bin/post-install.sh
[987]329
[962]330=item B<supfiles>
[986]331
332Not used yet.
333
[962]334=item B<testver>
[986]335
[989]336 Nature: Optional
337 Key: project (as defined in the -p option or PBPROJ environment variable)
338 Value: true (meaning this is a test version, whose tag will be generated automatically, based on 0+date in order to allow regular updates, and still be inferior to tag 1 of the official version, and delivered under the test subdirectory of the ftp server). By default false.
339 Conffile: project
340 Example: testver mondorescue = true
[986]341
[962]342=item B<vedebtype>
[986]343
[989]344 Nature: Mandatory
345 Key: project (as defined in the -p option or PBPROJ environment variable)
346 Value: debootstrap (no other tool to create deb distro based chroot)
347 Conffile: ve
348 Example: vedebtype default = debootstrap
[986]349
[962]350=item B<velist>
[986]351
[989]352 Nature: Mandatory
353 Key: project (as defined in the -p option or PBPROJ environment variable)
354 Value: list of coma separated OS (under the form of os-ver-arch).
355 Conffile: ve
356 Example: velist default = centos-4-i386,centos-5-i386,centos-4-x86_64,centos-5-x86_64,debian-5.0-i386,debian-5.0-x86_64,lsb-4.0.1-i386,lsb-4.0.1-x86_64
[986]357
[962]358=item B<velogin>
[986]359
[989]360 Nature: Mandatory
361 Key: project (as defined in the -p option or PBPROJ environment variable)
362 Value: account name to use in the VE to build packages.
363 Conffile: ve
364 Example: velogin default = pb
[986]365
[962]366=item B<ventp>
[986]367
[989]368 Nature: Optional
369 Key: project (as defined in the -p option or PBPROJ environment variable)
370 Value: NTP server to contact for time accuracy with B<ventpcmd> before building.
371 Conffile: ve
372 Example: ventp default = 1.pool.ntp.org
[986]373
[962]374=item B<ventpcmd>
[986]375
[989]376 Nature: Optional
377 Key: project (as defined in the -p option or PBPROJ environment variable)
378 Value: NTP command to use to perform time synchronization with the B<ventp> server.
379 Conffile: ve
380 Example: ventpcmd default = /usr/sbin/ntpdate
[986]381
[962]382=item B<vepath>
[986]383
[989]384 Nature: Mandatory
385 Key: project (as defined in the -p option or PBPROJ environment variable)
386 Value: path where to find VEs. Ve will be created and used under that path. For each VE os-ver-arch, it will create a subdirectory tree os/ver/arch below that point.
387 Conffile: ve
388 Example: vepath default = /home/rpmbootstrap
[986]389
[962]390=item B<verebuild>
[987]391
[989]392 Nature: Optional
393 Key: project (as defined in the -p option or PBPROJ environment variable)
394 Value: true|false. True means that the VE should be rebuild before usage.
395 Conffile: ve
396 Example: ventpcmd default = /usr/sbin/ntpdate
[987]397
[962]398=item B<verpmtype>
[987]399
[989]400 Nature: Mandatory
401 Key: project (as defined in the -p option or PBPROJ environment variable)
402 Value: rpmbootstrap|rinse|mock (different tools to create a chroot environment for RPM based distributions. rpmbootstrap comes with pb. the 2 others are separate projects).
403 Conffile: ve
404 Example: verpmtype default = rpmbootstrap
[987]405
[962]406=item B<vesnap>
[988]407
[989]408 Nature: Optional
409 Key: project (as defined in the -p option or PBPROJ environment variable)
410 Value: true|false. True means that the snapshot of the VE should be used before call to the VE. This snapshot consists of a compressed tar pf the VE. Which means that you will always start from a known state, resulting of a former snapshot operation on the VE. Also speeds up a lot the VM launch operation.
411 Conffile: ve
412 Example: vesnap default = true
[988]413
[962]414=item B<vetype>
[986]415
[989]416 Nature: Mandatory
417 Key: project (as defined in the -p option or PBPROJ environment variable)
418 Value: chroot|schroot. There are two different ways of launching a chroot activity in pb. For the moment only chroot has been tested.
419 Conffile: ve
420 Example: vertype default = chroot
[988]421
[1072]422=item B<vmcmd>
423
424 Nature: Mandatory
425 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). NB: a default value is highly interesting here.
426 Value: Command to call to launch the VM emulator. It can contain some options. Another way to pass options to the VM manager command launcher is by using the PBVMOPT environment variable, which comes in addition to the option vmopt.
427 Conffile: vm
428 Example: vmcmd default = /usr/bin/kvm
429
430
[962]431=item B<vmhost>
[988]432
[989]433 Nature: Mandatory
434 Key: project (as defined in the -p option or PBPROJ environment variable)
435 Value: hostname to connect to in order to reach the VM through ssh. Generally redirected from a port on localhost.
436 Conffile: vm
437 Example: vmhost default = localhost
[988]438
[962]439=item B<vmlist>
[986]440
[989]441 Nature: Mandatory
442 Key: project (as defined in the -p option or PBPROJ environment variable)
443 Value: list of coma separated OS (under the form of os-ver-arch).
444 Conffile: vm
445 Example: vmlist default = asianux-2-i386,asianux-3-i386,mandrake-10.1-i386,mandrake-10.2-i386,mandriva-2006.0-i386,mandriva-2007.0-i386,mandriva-2007.1-i386,mandriva-2008.0-i386,mandriva-2008.1-i386,mandriva-2009.0-i386,mandriva-2009.1-i386,mandriva-2010.0-i386,redhat-7.3-i386,redhat-9-i386,fedora-4-i386,fedora-5-i386,fedora-6-i386,fedora-7-i386,fedora-8-i386,fedora-9-i386,fedora-10-i386,fedora-11-i386,fedora-12-i386,rhel-2.1-i386,rhel-3-i386,rhel-4-i386,rhel-5-i386,suse-10.0-i386,suse-10.1-i386,suse-10.2-i386,opensuse-10.3-i386,opensuse-11.0-i386,opensuse-11.1-i386,opensuse-11.2-i386,sles-9-i386,sles-10-i386,sles-11-i386,gentoo-nover-i386,debian-3.1-i386,debian-4.0-i386,debian-5.0-i386,ubuntu-6.06-i386,ubuntu-7.04-i386,ubuntu-7.10-i386,ubuntu-8.04-i386,ubuntu-8.10-i386,ubuntu-9.04-i386,ubuntu-9.10-i386,solaris-10-i386,asianux-2-x86_64,asianux-3-x86_64,mandriva-2007.0-x86_64,mandriva-2007.1-x86_64,mandriva-2008.0-x86_64,mandriva-2008.1-x86_64,mandriva-2009.0-x86_64,mandriva-2009.1-x86_64,mandriva-2010.0-x86_64,fedora-6-x86_64,fedora-7-x86_64,fedora-8-x86_64,fedora-9-x86_64,fedora-10-x86_64,fedora-11-x86_64,fedora-12-x86_64,rhel-3-x86_64,rhel-4-x86_64,rhel-5-x86_64,suse-10.2-x86_64,opensuse-10.3-x86_64,opensuse-11.0-x86_64,opensuse-11.1-x86_64,opensuse-11.2-x86_64,sles-10-x86_64,sles-11-x86_64,gentoo-nover-x86_64,debian-4.0-x86_64,debian-5.0-x86_64,ubuntu-7.04-x86_64,ubuntu-7.10-x86_64,ubuntu-8.04-x86_64,ubuntu-8.10-x86_64,ubuntu-9.04-x86_64,ubuntu-9.10-x86_64,solaris-10-x86_64
[986]446
[962]447=item B<vmlogin>
[987]448
[989]449 Nature: Mandatory
450 Key: project (as defined in the -p option or PBPROJ environment variable)
451 Value: account name to use in the VM to build packages. Communication is done with ssh.
452 Conffile: vm
453 Example: vmlogin default = pb
[987]454
[962]455=item B<vmmonport>
[988]456
[989]457 Nature: Optional
458 Key: project (as defined in the -p option or PBPROJ environment variable)
459 Value: TCP port that is used to dialog with the monitor of the VM, to pass orders such as snapshot. Not really operational yet.
460 Conffile: vm
461 Example: vmmonport default = 4444
[988]462
[962]463=item B<vmntp>
[987]464
[989]465 Nature: Optional
466 Key: project (as defined in the -p option or PBPROJ environment variable)
467 Value: NTP server to contact for time accuracy with B<vmntpcmd> before building.
468 Conffile: vm
469 Example: vmntp default = 1.pool.ntp.org
[987]470
[962]471=item B<vmntpcmd>
[987]472
[989]473 Nature: Optional
474 Key: project (as defined in the -p option or PBPROJ environment variable)
475 Value: NTP command to use to perform time synchronization with the B<vmntp> server.
476 Conffile: vm
477 Example: vmntpcmd default = /usr/sbin/ntpdate,vmntpcmd opensuse-11.0-i386 = sntp -P no -r
[987]478
[962]479=item B<vmopt>
[988]480
[989]481 Nature: Optional
482 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). NB: a default value is highly interesting here.
483 Value: list of options to pass to the VM manager command launcher for that distribution. Another way to pass options to the VM manager command launcher is by using the PBVMOPT environment variable, which comes in addition to his option.
484 Conffile: vm
485 Example: vmopt default = -m 384 -daemonize,vmopt mandriva-2009.0-i386 = -m 256 -daemonize -no-kvm
[988]486
[962]487=item B<vmpath>
[987]488
[989]489 Nature: Mandatory
490 Key: project (as defined in the -p option or PBPROJ environment variable)
491 Value: path where to find VMs. They will be created and used under that path. For each VM os-ver-arch, it will create a os-ver-arch.qemu file below that point.
492 Conffile: vm
493 Example: vmpath default = /home/qemu
[987]494
[962]495=item B<vmport>
[988]496
[989]497 Nature: Mandatory
498 Key: project (as defined in the -p option or PBPROJ environment variable)
499 Value: port number to use to communicate with the VM using the SSH protocol. This localport is redirected to the port 22 of the VM.
500 Conffile: vm
501 Example: vmport pb = 2222,vmport mondorescue = 2223
[988]502
[962]503=item B<vmsize>
[988]504
[989]505 Nature: Mandatory
506 Key: project (as defined in the -p option or PBPROJ environment variable)
507 Value: Size of the VM to create when using the newvm command of pb.
508 Conffile: vm
509 Example: vmsize default = 7G
[988]510
[962]511=item B<vmsnap>
[988]512
[989]513 Nature: Optional
514 Key: project (as defined in the -p option or PBPROJ environment variable)
515 Value: true|false. True means that the snapshot of the VM called pb should be used. Which means that you will always start from a known state, resulting of a former snapshot operation on the VM. Also speeds up a lot the VM launch operation.
516 Conffile: vm
517 Example: vmsnap default = true
[988]518
[962]519=item B<vmtmout>
[988]520
[989]521 Nature: Optional
522 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). NB: a default value is highly interesting here.
523 Value: Time in seconds to way beofre interacting with the VM. This should corresponds to the time the VM takes to boot.
524 Conffile: vm
525 Example: vmtmout default = 180,vmtmout mandriva-2009.0-x86_64 = 500
[988]526
[962]527=item B<vmtype>
[988]528
[989]529 Nature: Mandatory
530 Key: project (as defined in the -p option or PBPROJ environment variable)
531 Value: qemu|kvm. For the moment, only QEMU or KVM are supported as virtualization technologies.
532 Conffile: vm
533 Example: vmrtype default = kvm
[988]534
[962]535=item B<webdir>
536
[989]537 Nature: Optional
538 Key: project (as defined in the -p option or PBPROJ environment variable)
539 Value: Target directory containing the web content in the project that should be delivered when using the web2ssh command of pb.
540 Conffile: project
541 Example: webdir mondorescue = website
[988]542
[962]543=item B<pb URL>
544=item B<pb directory desc>
[988]545=item B<pb environment variables>
[989]546
547=back
Note: See TracBrowser for help on using the repository browser.