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

Last change on this file since 1117 was 1117, checked in by bruno, 9 years ago

r4058@localhost: bruno | 2010-11-26 11:42:34 +0100

  • New Web site management with 4 targtes instead of only 2 (sbx2webssh, ...)
File size: 26.1 KB
Line 
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
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.
20
21=head1 OPTIONS
22
23=over 4
24
25=item B<defpkgdir>
26
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.
32
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
41=item B<extpkgdir>
42
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
48
49=item B<filteredfiles>
50
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
56
57=item B<namingtype>
58
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
64
65=item B<osambiguous>
66
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
72
73=item B<oschkcmd>
74
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).
77 Value: package checker tool.
78 Conffile: pb
79 Example: oschkcmd deb = /usr/bin/lintian
80
81=item B<oschkopt>
82
83 Nature: Optional
84 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
85 Value: package checker tool options.
86 Conffile: pb
87 Example: oschkcmd rpm = -i
88
89=item B<oscodename>
90
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). In that case, should be an os-ver.
93 Value: code name. Mostly useful for debian and ubuntu, due to debootstrap.
94 Conffile: pb
95 Example: oscodename debian-5.0 = lenny
96
97=item B<osfamily>
98
99 Nature: Mandatory
100 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.
101 Value: OS family name (used to group similar distribution for handling)
102 Conffile: pb
103 Example: osfamily debian = du
104
105=item B<osins>
106
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). The family name is generaly used here.
109 Value: OS command to lauch in order to automatically install packages on it.
110 Conffile: pb
111 Example: osins fedora = sudo yum -y install
112
113=item B<osmindep>
114
115 Nature: Optional
116 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.
117 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.
118 Conffile: pb
119 Example: osmindep default = perl,sudo,wget,tar,make,gzip
120
121=item B<osnover>
122
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: true|false. True means that this OS has no need to keep the version
126 Conffile: pb
127 Example: osnover gentoo = true
128
129=item B<osperldep>
130
131 Nature: Optional
132 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
133 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.
134 Conffile: pb
135 Example: osperldep rhel-5 = Module-Build,File-MimeInfo,File-BaseDir,Mail-Sendmail
136
137=item B<osperlver>
138
139 Nature: Mandatory (for each module mentioned in B<osperldep>)
140 Key: Perl Module (as defined in B<osperldep>)
141 Value: Version of the perl module that needs to be found on CPAN.
142 Conffile: pb
143 Example: Date-Manip = 5.54
144
145=item B<ospkgdep>
146
147 Nature: Optional
148 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
149 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.
150 Conffile: pb
151 Example: ospkgdep rhel-5 = wget,make,ntp,patch,perl-DateManip
152
153=item B<osrelambfile>
154
155 Nature: Mandatory (per OS mentioned in B<osambiguous>)
156 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.
157 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.
158 Conffile: pb
159 Example: osrelambfile debian = /etc/debian_version
160
161=item B<osrelexpr>
162
163 Nature: Mandatory (per OS mentioned in B<osrelambfile> and B<osrelfile>)
164 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
165 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)
166 Conffile: pb
167osrelexpr rhel = Red Hat (?:Enterprise Linux|Linux Advanced Server) .*release ([0-9.]+).* \(
168 Example:
169
170=item B<osrelfile>
171
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). Should be the OS name here.
174 Value: full path name of the file describing non-ambiguously that distribution. There should be a bijection between the file and the distribution name.
175 Conffile: pb
176 Example: osrelfile fedora = /etc/fedora-release
177
178=item B<osremovedotinver>
179
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).
182 Value: true|false. If true, then no '.' (dot) character is kept in the version name of that OS.
183 Conffile: pb
184 Example: osremovedotinver redhat = true
185
186=item B<ossuffix>
187
188 Nature: Optional
189 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
190 Value: suffix that will be used in the name of the packages created. By default, concatenation of OS name and version.
191 Conffile: pb
192 Example: ossuffix mandriva = mdv
193
194=item B<ostype>
195
196 Nature: Mandatory
197 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.
198 Value: build type grouping packages family. This is used internaly by pb to make various handling depending on that build type.
199 Conffile: pb
200 Example: ostype rh = rpm, ostype md = rpm, ostype novell = rpm
201
202=item B<osupd>
203
204 Nature: Optional
205 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.
206 Value: OS command to lauch in order to automatically update th VM|VE
207 Conffile: pb
208 Example: osupd fedora = sudo yum -y update
209
210=item B<pbconfurl>
211
212 Nature: Mandatory
213 Key: project (as defined in the -p option or PBPROJ environment variable)
214 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
215 Conffile: home|project
216 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
217
218=item B<pbdefdir>
219
220 Nature: Optional
221 Key: project (as defined in the -p option or PBPROJ environment variable)
222 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.
223 Conffile: home
224 Example: pbdefdir default = $ENV{'HOME'}/local/pb/projects
225
226=item B<pbinstalltype>
227
228 Nature: Mandatory
229 Key: project (as defined in the -p option or PBPROJ environment variable)
230 Value: file or pkg. Indicates how pb will be installed during the setupve|vm phase in the virtual environment|machine, using CPAN files or upstream packages. Only the dev team needs to use file as packages do not yet exist for it. Or when no repository exists to pull project-builder.org from.
231 Conffile: pb
232
233=item B<pbml>
234
235 Nature: Optional (Mandatory if using announce command)
236 Key: project (as defined in the -p option or PBPROJ environment variable)
237 Value: white space separated list of e-mail adresses used to send announces with the pb announce option.
238 Conffile: project
239 Example: pbml pb = pb-announce@project-builder.org pb-devel@project-builder.org
240
241=item B<pbpackager>
242
243 Nature: Mandatory
244 Key: project (as defined in the -p option or PBPROJ environment variable)
245 Value: Firstname Name and e-mail address of the person packaging the software.
246 Conffile: project
247 Example: pbpackager pb = Bruno Cornec <bruno@project-builder.org>
248
249=item B<pbpkg>
250
251 Nature: Optional (Mandatory if pbinstalltype is pkg)
252 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
253 Value: coma separated list of packages that have to be installed in order for pb to be operational in the VE|VM
254 Conffile: pb
255 Example: pbpkg rhel-5 = project-builder
256
257=item B<pbprojdir>
258
259 Nature: Optional
260 Key: project (as defined in the -p option or PBPROJ environment variable)
261 Value: local directory under which the project is locally exported. NB: a default value is highly interesting here. By default pbdefdir/projectname
262 Conffile: home
263 Example: pbprojdir mondorescue = $ENV{'HOME'}/local/mondorescue
264
265=item B<pbrepo>
266
267 Nature: Mandatory
268 Key: project (as defined in the -p option or PBPROJ environment variable)
269 Value: URL of the server hosting the upstream tar file.
270 Conffile: project
271 Example: pbrepo mondorescue = ftp://ftp.mondorescue.org
272
273=item B<pbsmtp>
274
275 Nature: Optional (Mandatory if using the announce command)
276 Key: project (as defined in the -p option or PBPROJ environment variable)
277 Value: FQDN of the mail server to use to send announces. NB: a default value is highly interesting here.
278 Conffile: home
279 Example: pbsmtp mondorescue = localhost
280
281=item B<pbsockscmd>
282
283 Nature: Optional
284 Key: project (as defined in the -p option or PBPROJ environment variable)
285 Value: name of the command to use to socksify network calls. NB: a default value is highly interesting here.
286 Conffile: home
287 Example: pbsockscmd default = tsocks
288
289=item B<pburl>
290
291 Nature: Optional
292 Key: project (as defined in the -p option or PBPROJ environment variable)
293 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
294 Conffile: home|project
295 Example: pburl linuxcoe = cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe, pburl pb = svk:////local/pb
296
297=item B<pbwf>
298
299 Nature: Optional
300 Key: project (as defined in the -p option or PBPROJ environment variable)
301 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.
302 Conffile: project
303 Example: pbwf afio = 1
304
305=item B<pkgtag>
306
307 Nature: Optional
308 Key: package (as provided in defpkgdir or extpkgdir)
309 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).
310 Conffile: project
311 Example: pkgtag mindi-busybox = 2
312
313=item B<pkgver>
314
315 Nature: Optional
316 Key: package (as provided in defpkgdir or extpkgdir)
317 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>.
318 Conffile: project
319 Example: pkgver mindi-busybox = 1.7.3
320
321=item B<projtag>
322
323 Nature: Mandatory
324 Key: project (as defined in the -p option or PBPROJ environment variable)
325 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>.
326 Conffile: project
327 Example: projtag mondorescue = 1
328
329=item B<projver>
330
331 Nature: Mandatory
332 Key: project (as defined in the -p option or PBPROJ environment variable)
333 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>.
334 Conffile: project
335 Example: projver mondorescue = 2.2.9
336
337=item B<rbsconf>
338
339 Nature: Optional
340 Key: project (as defined in the -p option or PBPROJ environment variable)
341 Value: for mock it's the configuration directory. For rinse it's its configuration file. For rpmbootstrap it's not used yet.
342 Conffile: ve
343 Example: rbsconf default = /etc/mock, rbsconf default = /etc/pb/pb-rinse.conf
344
345=item B<rbsb4pi>
346
347 Nature: Optional
348 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.
349 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.
350 Conffile: ve
351 Example: rbsb4pi centos = /home/rinse/bin/before-post-install.sh
352
353=item B<rbsopt>
354
355 Nature: Optional
356 Key: tool used for rpm based VE. Could be one of rpmbootstrap, rinse, mock, ...
357 Value: Additional option to pass to the command
358 Conffile: ve
359 Example: rbsopt rpmbootstrap = -k
360
361=item B<rbspi>
362
363 Nature: Optional
364 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.
365 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.
366 Conffile: ve
367 Example: rbspi centos = /home/rinse/bin/post-install.sh
368
369=item B<supfiles>
370
371Not used yet.
372
373=item B<testver>
374
375 Nature: Optional
376 Key: project (as defined in the -p option or PBPROJ environment variable)
377 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.
378 Conffile: project
379 Example: testver mondorescue = true
380
381=item B<vedebtype>
382
383 Nature: Mandatory
384 Key: project (as defined in the -p option or PBPROJ environment variable)
385 Value: debootstrap (no other tool to create deb distro based chroot)
386 Conffile: ve
387 Example: vedebtype default = debootstrap
388
389=item B<velist>
390
391 Nature: Mandatory
392 Key: project (as defined in the -p option or PBPROJ environment variable)
393 Value: list of coma separated OS (under the form of os-ver-arch).
394 Conffile: ve
395 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
396
397=item B<velogin>
398
399 Nature: Mandatory
400 Key: project (as defined in the -p option or PBPROJ environment variable)
401 Value: account name to use in the VE to build packages.
402 Conffile: ve
403 Example: velogin default = pb
404
405=item B<ventp>
406
407 Nature: Optional
408 Key: project (as defined in the -p option or PBPROJ environment variable)
409 Value: NTP server to contact for time accuracy with B<ventpcmd> before building.
410 Conffile: ve
411 Example: ventp default = 1.pool.ntp.org
412
413=item B<ventpcmd>
414
415 Nature: Optional
416 Key: project (as defined in the -p option or PBPROJ environment variable)
417 Value: NTP command to use to perform time synchronization with the B<ventp> server.
418 Conffile: ve
419 Example: ventpcmd default = /usr/sbin/ntpdate
420
421=item B<vepath>
422
423 Nature: Mandatory
424 Key: project (as defined in the -p option or PBPROJ environment variable)
425 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.
426 Conffile: ve
427 Example: vepath default = /home/rpmbootstrap
428
429=item B<verebuild>
430
431 Nature: Optional
432 Key: project (as defined in the -p option or PBPROJ environment variable)
433 Value: true|false. True means that the VE should be rebuild before usage.
434 Conffile: ve
435 Example: ventpcmd default = /usr/sbin/ntpdate
436
437=item B<verpmtype>
438
439 Nature: Mandatory
440 Key: project (as defined in the -p option or PBPROJ environment variable)
441 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).
442 Conffile: ve
443 Example: verpmtype default = rpmbootstrap
444
445=item B<vesnap>
446
447 Nature: Optional
448 Key: project (as defined in the -p option or PBPROJ environment variable)
449 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.
450 Conffile: ve
451 Example: vesnap default = true
452
453=item B<vetype>
454
455 Nature: Mandatory
456 Key: project (as defined in the -p option or PBPROJ environment variable)
457 Value: chroot|schroot. There are two different ways of launching a chroot activity in pb. For the moment only chroot has been tested.
458 Conffile: ve
459 Example: vertype default = chroot
460
461=item B<vmcmd>
462
463 Nature: Mandatory
464 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.
465 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.
466 Conffile: vm
467 Example: vmcmd default = /usr/bin/kvm
468
469
470=item B<vmhost>
471
472 Nature: Mandatory
473 Key: project (as defined in the -p option or PBPROJ environment variable)
474 Value: hostname to connect to in order to reach the VM through ssh. Generally redirected from a port on localhost.
475 Conffile: vm
476 Example: vmhost default = localhost
477
478=item B<vmlist>
479
480 Nature: Mandatory
481 Key: project (as defined in the -p option or PBPROJ environment variable)
482 Value: list of coma separated OS (under the form of os-ver-arch).
483 Conffile: vm
484 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
485
486=item B<vmlogin>
487
488 Nature: Mandatory
489 Key: project (as defined in the -p option or PBPROJ environment variable)
490 Value: account name to use in the VM to build packages. Communication is done with ssh.
491 Conffile: vm
492 Example: vmlogin default = pb
493
494=item B<vmmonport>
495
496 Nature: Optional
497 Key: project (as defined in the -p option or PBPROJ environment variable)
498 Value: TCP port that is used to dialog with the monitor of the VM, to pass orders such as snapshot. Not really operational yet.
499 Conffile: vm
500 Example: vmmonport default = 4444
501
502=item B<vmntp>
503
504 Nature: Optional
505 Key: project (as defined in the -p option or PBPROJ environment variable)
506 Value: NTP server to contact for time accuracy with B<vmntpcmd> before building.
507 Conffile: vm
508 Example: vmntp default = 1.pool.ntp.org
509
510=item B<vmntpcmd>
511
512 Nature: Optional
513 Key: project (as defined in the -p option or PBPROJ environment variable)
514 Value: NTP command to use to perform time synchronization with the B<vmntp> server.
515 Conffile: vm
516 Example: vmntpcmd default = /usr/sbin/ntpdate,vmntpcmd opensuse-11.0-i386 = sntp -P no -r
517
518=item B<vmopt>
519
520 Nature: Optional
521 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.
522 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.
523 Conffile: vm
524 Example: vmopt default = -m 384 -daemonize,vmopt mandriva-2009.0-i386 = -m 256 -daemonize -no-kvm
525
526=item B<vmpath>
527
528 Nature: Mandatory
529 Key: project (as defined in the -p option or PBPROJ environment variable)
530 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.
531 Conffile: vm
532 Example: vmpath default = /home/qemu
533
534=item B<vmport>
535
536 Nature: Mandatory
537 Key: project (as defined in the -p option or PBPROJ environment variable)
538 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.
539 Conffile: vm
540 Example: vmport pb = 2222,vmport mondorescue = 2223
541
542=item B<vmsize>
543
544 Nature: Mandatory
545 Key: project (as defined in the -p option or PBPROJ environment variable)
546 Value: Size of the VM to create when using the newvm command of pb.
547 Conffile: vm
548 Example: vmsize default = 7G
549
550=item B<vmsnap>
551
552 Nature: Optional
553 Key: project (as defined in the -p option or PBPROJ environment variable)
554 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.
555 Conffile: vm
556 Example: vmsnap default = true
557
558=item B<vmtmout>
559
560 Nature: Optional
561 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.
562 Value: Time in seconds to way beofre interacting with the VM. This should corresponds to the time the VM takes to boot.
563 Conffile: vm
564 Example: vmtmout default = 180,vmtmout mandriva-2009.0-x86_64 = 500
565
566=item B<vmtype>
567
568 Nature: Mandatory
569 Key: project (as defined in the -p option or PBPROJ environment variable)
570 Value: qemu|kvm. For the moment, only QEMU or KVM are supported as virtualization technologies.
571 Conffile: vm
572 Example: vmrtype default = kvm
573
574=item B<webdir>
575
576 Nature: Optional
577 Key: project (as defined in the -p option or PBPROJ environment variable)
578 Value: Target directory containing the web content in the project that should be delivered when using the sbx|cms2webssh|pkg command of pb.
579 Conffile: project
580 Example: webdir mondorescue = website
581
582=back
583
584=head1 OTHER PARAMETERS
585=item B<pb_URL>
586=item B<pb_directory_desc>
587=item B<pb_environment_variables>
Note: See TracBrowser for help on using the repository browser.