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

Last change on this file since 1217 was 1217, checked in by bruno, 9 years ago
  • *tmout param is optional and now handled and documented as such
File size: 34.0 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<oscmd>
90
91 Nature: Mandatory
92 Key: tool (pb or rpmbootstrap)
93 Value: come separated list of commands that are mandatory on the underlying system
94 Conffile: pb
95 Example: oscmd pb = tar,ls
96
97=item B<oscmdopt>
98
99 Nature: Mandatory
100 Key: tool (pb or rpmbootstrap)
101 Value: come separated list of commands that are optional on the underlying system
102 Conffile: pb
103 Example: oscmd pb = svn2cl,svn,cvs
104
105=item B<oscodename>
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). In that case, should be an os-ver.
109 Value: code name. Mostly useful for debian and ubuntu, due to debootstrap.
110 Conffile: pb
111 Example: oscodename debian-5.0 = lenny
112
113=item B<osfamily>
114
115 Nature: Mandatory
116 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.
117 Value: OS family name (used to group similar distribution for handling)
118 Conffile: pb
119 Example: osfamily debian = du
120
121=item B<osins>
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). The family name is generaly used here.
125 Value: OS command to lauch in order to automatically install packages on it.
126 Conffile: pb
127 Example: osins fedora = sudo yum -y install
128
129=item B<osmindep>
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). NB: a default value is highly interesting here.
133 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.
134 Conffile: pb
135 Example: osmindep default = perl,sudo,wget,tar,make,gzip
136
137=item B<osnover>
138
139 Nature: Optional
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: true|false. True means that this OS has no need to keep the version
142 Conffile: pb
143 Example: osnover gentoo = true
144
145=item B<ospathcmd-*>
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: Full path name of the command mentioned after the '-' for the relative OS
150 Conffile: pb
151 Example: ospathcmd-halt solaris = /usr/sbin/halt, ospathcmd-halt default = /sbin/halt
152
153=item B<osperldep>
154
155 Nature: Optional
156 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
157 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.
158 Conffile: pb
159 Example: osperldep rhel-5 = Module-Build,File-MimeInfo,File-BaseDir,Mail-Sendmail
160
161=item B<osperlver>
162
163 Nature: Mandatory (for each module mentioned in B<osperldep>)
164 Key: Perl Module (as defined in B<osperldep>)
165 Value: Version of the perl module that needs to be found on CPAN.
166 Conffile: pb
167 Example: Date-Manip = 5.54
168
169=item B<ospkg>
170
171 Nature: Optional (Mandatory if pbinstalltype is pkg)
172 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
173 Value: coma separated list of packages that have to be installed in order for pb to be operational in the VE|VM
174 Conffile: pb
175 Example: ospkg rhel-5 = project-builder
176
177=item B<ospkgdep>
178
179 Nature: Optional
180 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
181 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.
182 Conffile: pb
183 Example: ospkgdep rhel-5 = wget,make,ntp,patch,perl-DateManip
184
185=item B<osrelambfile>
186
187 Nature: Mandatory (per OS mentioned in B<osambiguous>)
188 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.
189 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.
190 Conffile: pb
191 Example: osrelambfile debian = /etc/debian_version
192
193=item B<osrelexpr>
194
195 Nature: Mandatory (per OS mentioned in B<osrelambfile> and B<osrelfile>)
196 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
197 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)
198 Conffile: pb
199osrelexpr rhel = Red Hat (?:Enterprise Linux|Linux Advanced Server) .*release ([0-9.]+).* \(
200 Example:
201
202=item B<osrelfile>
203
204 Nature: Mandatory
205 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.
206 Value: full path name of the file describing non-ambiguously that distribution. There should be a bijection between the file and the distribution name.
207 Conffile: pb
208 Example: osrelfile fedora = /etc/fedora-release
209
210=item B<osremovedotinver>
211
212 Nature: Optional
213 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
214 Value: true|false. If true, then no '.' (dot) character is kept in the version name of that OS.
215 Conffile: pb
216 Example: osremovedotinver redhat = true
217
218=item B<osrepo>
219
220 Nature: Optional (Mandatory if pbinstalltype is pkg)
221 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
222 Value: coma separated list of packages or repo file to be added to the VE|VM to support package installation of pb
223 Conffile: pb
224 Example: osrepo rpm = ftp://ftp.project-builder.org/$ddir/$dver/pb.repo
225
226=item B<ossuffix>
227
228 Nature: Optional
229 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
230 Value: suffix that will be used in the name of the packages created. By default, concatenation of OS name and version.
231 Conffile: pb
232 Example: ossuffix mandriva = mdv
233
234=item B<ostype>
235
236 Nature: Mandatory
237 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.
238 Value: build type grouping packages family. This is used internaly by pb to make various handling depending on that build type.
239 Conffile: pb
240 Example: ostype rh = rpm, ostype md = rpm, ostype novell = rpm
241
242=item B<osupd>
243
244 Nature: Optional
245 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.
246 Value: OS command to lauch in order to automatically update th VM|VE
247 Conffile: pb
248 Example: osupd fedora = sudo yum -y update
249
250=item B<pbconfurl>
251
252 Nature: Mandatory
253 Key: project (as defined in the -p option or PBPROJ environment variable)
254 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
255 Conffile: home|project
256 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
257
258=item B<pbdefdir>
259
260 Nature: Optional
261 Key: project (as defined in the -p option or PBPROJ environment variable)
262 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.
263 Conffile: home
264 Example: pbdefdir default = $ENV{'HOME'}/local/pb/projects
265
266=item B<pbinstalltype>
267
268 Nature: Mandatory
269 Key: project (as defined in the -p option or PBPROJ environment variable)
270 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.
271 Conffile: pb
272
273=item B<pbml>
274
275 Nature: Optional (Mandatory if using announce command)
276 Key: project (as defined in the -p option or PBPROJ environment variable)
277 Value: white space separated list of e-mail adresses used to send announces with the pb announce option.
278 Conffile: project
279 Example: pbml pb = pb-announce@project-builder.org pb-devel@project-builder.org
280
281=item B<pbpackager>
282
283 Nature: Mandatory
284 Key: project (as defined in the -p option or PBPROJ environment variable)
285 Value: Firstname Name and e-mail address of the person packaging the software.
286 Conffile: project
287 Example: pbpackager pb = Bruno Cornec <bruno@project-builder.org>
288
289=item B<pbparallel>
290
291 Nature: Optional
292 Key: tool (pb or rpmbootstrap)
293 Value: number of processes to execute in parallel. By default use the number of cores.
294 Conffile: pb
295 Example: pbparallel pb = 12
296
297=item B<pbprojdir>
298
299 Nature: Optional
300 Key: project (as defined in the -p option or PBPROJ environment variable)
301 Value: local directory under which the project is locally exported. NB: a default value is highly interesting here. By default pbdefdir/projectname
302 Conffile: home
303 Example: pbprojdir mondorescue = $ENV{'HOME'}/local/mondorescue
304
305=item B<pbrepo>
306
307 Nature: Mandatory
308 Key: project (as defined in the -p option or PBPROJ environment variable)
309 Value: URL of the server hosting the upstream tar file.
310 Conffile: project
311 Example: pbrepo mondorescue = ftp://ftp.mondorescue.org
312
313=item B<pbsmtp>
314
315 Nature: Optional (Mandatory if using the announce command)
316 Key: project (as defined in the -p option or PBPROJ environment variable)
317 Value: FQDN of the mail server to use to send announces. NB: a default value is highly interesting here.
318 Conffile: home
319 Example: pbsmtp mondorescue = localhost
320
321=item B<pbsockscmd>
322
323 Nature: Optional
324 Key: project (as defined in the -p option or PBPROJ environment variable)
325 Value: name of the command to use to socksify network calls. NB: a default value is highly interesting here.
326 Conffile: home
327 Example: pbsockscmd default = tsocks
328
329=item B<pburl>
330
331 Nature: Optional
332 Key: project (as defined in the -p option or PBPROJ environment variable)
333 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
334 Conffile: home|project
335 Example: pburl linuxcoe = cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe, pburl pb = svk:////local/pb
336
337=item B<pbwf>
338
339 Nature: Optional
340 Key: project (as defined in the -p option or PBPROJ environment variable)
341 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.
342 Conffile: project
343 Example: pbwf afio = 1
344
345=item B<pkgtag>
346
347 Nature: Optional
348 Key: package (as provided in defpkgdir or extpkgdir)
349 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).
350 Conffile: project
351 Example: pkgtag mindi-busybox = 2
352
353=item B<pkgver>
354
355 Nature: Optional
356 Key: package (as provided in defpkgdir or extpkgdir)
357 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>.
358 Conffile: project
359 Example: pkgver mindi-busybox = 1.7.3
360
361=item B<projtag>
362
363 Nature: Mandatory
364 Key: project (as defined in the -p option or PBPROJ environment variable)
365 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>.
366 Conffile: project
367 Example: projtag mondorescue = 1
368
369=item B<projver>
370
371 Nature: Mandatory
372 Key: project (as defined in the -p option or PBPROJ environment variable)
373 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>.
374 Conffile: project
375 Example: projver mondorescue = 2.2.9
376
377=item B<rbsconf>
378
379 Nature: Optional
380 Key: project (as defined in the -p option or PBPROJ environment variable)
381 Value: for mock it's the configuration directory. For rinse it's its configuration file. For rpmbootstrap it's not used yet.
382 Conffile: ve
383 Example: rbsconf default = /etc/mock, rbsconf default = /etc/pb/pb-rinse.conf
384
385=item B<rbsb4pi>
386
387 Nature: Optional
388 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.
389 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.
390 Conffile: ve
391 Example: rbsb4pi centos = /home/rinse/bin/before-post-install.sh
392
393=item B<rbsopt>
394
395 Nature: Optional
396 Key: tool used for rpm based VE. Could be one of rpmbootstrap, rinse, mock, ...
397 Value: Additional option to pass to the command
398 Conffile: ve
399 Example: rbsopt rpmbootstrap = -k
400
401=item B<rbspi>
402
403 Nature: Optional
404 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.
405 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.
406 Conffile: ve
407 Example: rbspi centos = /home/rinse/bin/post-install.sh
408
409=item B<rmhost>
410
411 Nature: Mandatory
412 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.
413 Value: IP address or name of the Remote Machine running the OS mentioned in the key, accessed through ssh.
414 Conffile: rm
415 Example: rmhost default = localhost - rmhost hpux-11.3-ia64 = 10.10.10.10 - rmhost mandriva-2010.2-x86_64 = machine1.domain.name
416
417=item B<rmlist>
418
419 Nature: Mandatory
420 Key: project (as defined in the -p option or PBPROJ environment variable)
421 Value: list of coma separated OS (under the form of os-ver-arch). The corresponding machines running these distributions are given in the rmpool parameter.
422 Conffile: rm
423 Example: rmlist default = mandriva-2010.2-i386,fedora-14-i386,rhel-6-i386,rhel-5-i386,pensuse-11.3-i386,sles-11-i386,gentoo-nover-i386,debian-5.0-i386,ubuntu-10.10-i386,solaris-10-i386,mandriva-2010.2-x86_64,fedora-14-x86_64,rhel-6-x86_64,rhel-5-x86_64,opensuse-11.3-x86_64,sles-11-x86_64,gentoo-nover-x86_64,debian-5.0-x86_64,ubuntu-10.10-x86_64,solaris-10-x86_64,hp-ux-11.3-ia64,rhel-5-ia64
424
425=item B<rmlogin>
426
427 Nature: Mandatory
428 Key: project (as defined in the -p option or PBPROJ environment variable)
429 Value: account name to use on the Remote Machine to build packages. Communication is done with ssh.
430 Conffile: rm
431 Example: rmlogin default = pb
432
433=item B<rmmonport>
434
435 Nature: Optional
436 Key: project (as defined in the -p option or PBPROJ environment variable)
437 Value: TCP port that is used to dialog with the monitor of the Remote Machine, to pass orders.
438 Conffile: rm
439 Example: rmmonport default = 4444
440
441=item B<rmntp>
442
443 Nature: Optional
444 Key: project (as defined in the -p option or PBPROJ environment variable)
445 Value: NTP server to contact for time accuracy with B<rmntpcmd> before building.
446 Conffile: rm
447 Example: rmntp default = 1.pool.ntp.org
448
449=item B<rmntpcmd>
450
451 Nature: Mandatory
452 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
453 Value: NTP command to use to perform time synchronization with the B<rmntp> server. Use full path name, as this command will be used in the sudoers file to allow its launch by root.
454 Conffile: rm
455 Example: rmntpcmd default = /usr/sbin/ntpdate,rmntpcmd opensuse-10.1-i386 = /usr/sbin/sntp -P no -r
456
457=item B<rmpath>
458
459 Nature: Mandatory
460 Key: project (as defined in the -p option or PBPROJ environment variable)
461 Value: path where to find configuration file for Remote Machines management.
462 Conffile: rm
463 Example: rmpath default = /home/remote
464
465=item B<rmport>
466
467 Nature: Mandatory
468 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
469 Value: port number to use to communicate with the RM using the SSH protocol. This localport is redirected to the port 22 of the RM.
470 Conffile: rm
471 Example: rmport pb = 2222,rmport mondorescue = 2223
472
473=item B<rmtmout>
474
475 Nature: Optional
476 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.
477 Value: Time in seconds to wait before interacting with the RM. This may correspond to the time the RM takes to boot.
478 Conffile: rm
479 Example: rmtmout default = 10
480
481=item B<rmtype>
482
483 Nature: Mandatory
484 Key: project (as defined in the -p option or PBPROJ environment variable)
485 Value: ssh. For the moment, only ssh is supported as a communication means with RM.
486 Conffile: rm
487 Example: rmrtype default = ssh
488
489=item B<sshdir>
490
491 Nature: Mandatory
492 Key: project (as defined in the -p option or PBPROJ environment variable)
493 Value: dirname into which packages are uploaded on the B<sshhost> machine.
494 Conffile: project
495 Example: sshdir mondorescue = /pub/mondorescue
496
497=item B<sshhost>
498
499 Nature: Mandatory
500 Key: project (as defined in the -p option or PBPROJ environment variable)
501 Value: hostname to connect to in order to deliver packages to the repository server.
502 Conffile: project
503 Example: sshhost mondorescue = ftp.mondorescue.org
504
505=item B<sshlogin>
506
507 Nature: Mandatory
508 Key: project (as defined in the -p option or PBPROJ environment variable)
509 Value: login to use when connecting to the repository server B<sshhost> for package delivery.
510 Conffile: project
511 Example: sshlogin mondorescue = mylogin
512
513=item B<sshport>
514
515 Nature: Mandatory
516 Key: project (as defined in the -p option or PBPROJ environment variable)
517 Value: port to use when connecting to the repository server B<sshhost> for package delivery.
518 Conffile: project
519 Example: sshport mondorescue = 22
520
521=item B<supfiles>
522
523Not used yet.
524
525=item B<testver>
526
527 Nature: Optional
528 Key: project (as defined in the -p option or PBPROJ environment variable)
529 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.
530 Conffile: project
531 Example: testver mondorescue = true
532
533=item B<vedebtype>
534
535 Nature: Mandatory
536 Key: project (as defined in the -p option or PBPROJ environment variable)
537 Value: debootstrap (no other tool to create deb distro based chroot)
538 Conffile: ve
539 Example: vedebtype default = debootstrap
540
541=item B<velist>
542
543 Nature: Mandatory
544 Key: project (as defined in the -p option or PBPROJ environment variable)
545 Value: list of coma separated OS (under the form of os-ver-arch).
546 Conffile: ve
547 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
548
549=item B<velogin>
550
551 Nature: Mandatory
552 Key: project (as defined in the -p option or PBPROJ environment variable)
553 Value: account name to use in the VE to build packages.
554 Conffile: ve
555 Example: velogin default = pb
556
557=item B<ventp>
558
559 Nature: Optional
560 Key: project (as defined in the -p option or PBPROJ environment variable)
561 Value: NTP server to contact for time accuracy with B<ventpcmd> before building.
562 Conffile: ve
563 Example: ventp default = 1.pool.ntp.org
564
565=item B<ventpcmd>
566
567 Nature: Mandatory
568 Key: project (as defined in the -p option or PBPROJ environment variable)
569 Value: NTP command to use to perform time synchronization with the B<ventp> server. Use full path name, as this command will be used in the sudoers file to allow its launch by root.
570 Conffile: ve
571 Example: ventpcmd default = /usr/sbin/ntpdate
572
573=item B<vepath>
574
575 Nature: Mandatory
576 Key: project (as defined in the -p option or PBPROJ environment variable)
577 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.
578 Conffile: ve
579 Example: vepath default = /home/rpmbootstrap
580
581=item B<verebuild>
582
583 Nature: Optional
584 Key: project (as defined in the -p option or PBPROJ environment variable)
585 Value: true|false. True means that the VE should be rebuild before usage.
586 Conffile: ve
587 Example: verebuild default = true
588
589=item B<verpmtype>
590
591 Nature: Mandatory
592 Key: project (as defined in the -p option or PBPROJ environment variable)
593 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).
594 Conffile: ve
595 Example: verpmtype default = rpmbootstrap
596
597=item B<vesnap>
598
599 Nature: Optional
600 Key: project (as defined in the -p option or PBPROJ environment variable)
601 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.
602 Conffile: ve
603 Example: vesnap default = true
604
605=item B<vetype>
606
607 Nature: Mandatory
608 Key: project (as defined in the -p option or PBPROJ environment variable)
609 Value: chroot|schroot. There are two different ways of launching a chroot activity in pb. For the moment only chroot has been tested.
610 Conffile: ve
611 Example: vertype default = chroot
612
613=item B<vmbuildtm>
614
615 Nature: Optional
616 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). Default value is set to vmtmout
617 Value: Time in seconds to wait before killing the VM if SSH port already used. This should corresponds to the time to send files, build the project and get packages in the VM.
618 Conffile: project
619 Example: vmbuildtm default = 600,vmbuildtm mandriva-2009.0-x86_64 = 1200
620
621=item B<vmcmd>
622
623 Nature: Mandatory
624 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.
625 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.
626 Conffile: vm
627 Example: vmcmd default = /usr/bin/kvm
628
629=item B<vmhost>
630
631 Nature: Mandatory
632 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
633 Value: hostname to connect to in order to reach the VM through ssh. Generally redirected from a port on localhost.
634 Conffile: vm
635 Example: vmhost default = localhost
636
637=item B<vmlist>
638
639 Nature: Mandatory
640 Key: project (as defined in the -p option or PBPROJ environment variable)
641 Value: list of coma separated OS (under the form of os-ver-arch).
642 Conffile: vm
643 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
644
645=item B<vmlogin>
646
647 Nature: Mandatory
648 Key: project (as defined in the -p option or PBPROJ environment variable)
649 Value: account name to use in the VM to build packages. Communication is done with ssh.
650 Conffile: vm
651 Example: vmlogin default = pb
652
653=item B<vmmem>
654
655 Nature: Optional
656 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
657 Value: Memory size in MB to allocate to the VM.
658 Conffile: vm
659 Example: vmmem default = 512
660
661=item B<vmmonport>
662
663 Nature: Optional
664 Key: project (as defined in the -p option or PBPROJ environment variable)
665 Value: TCP port that is used to dialog with the monitor of the VM, to pass orders such as snapshot. Not really operational yet.
666 Conffile: vm
667 Example: vmmonport default = 4444
668
669=item B<vmntp>
670
671 Nature: Optional
672 Key: project (as defined in the -p option or PBPROJ environment variable)
673 Value: NTP server to contact for time accuracy with B<vmntpcmd> before building.
674 Conffile: vm
675 Example: vmntp default = 1.pool.ntp.org
676
677=item B<vmntpcmd>
678
679 Nature: Mandatory
680 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
681 Value: NTP command to use to perform time synchronization with the B<vmntp> server. Use full path name, as this command will be used in the sudoers file to allow its launch by root.
682 Conffile: vm
683 Example: vmntpcmd default = /usr/sbin/ntpdate,vmntpcmd opensuse-11.0-i386 = /usr/sbin/sntp -P no -r
684
685=item B<vmopt>
686
687 Nature: Optional
688 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.
689 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.
690 Conffile: vm
691 Example: vmopt default = -m 384 -daemonize,vmopt mandriva-2009.0-i386 = -m 256 -daemonize -no-kvm
692
693=item B<vmpath>
694
695 Nature: Mandatory
696 Key: project (as defined in the -p option or PBPROJ environment variable)
697 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.
698 Conffile: vm
699 Example: vmpath default = /home/qemu
700
701=item B<vmport>
702
703 Nature: Mandatory
704 Key: project (as defined in the -p option or PBPROJ environment variable)
705 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.
706 Conffile: vm
707 Example: vmport pb = 2222,vmport mondorescue = 2223
708
709=item B<vmsize>
710
711 Nature: Mandatory
712 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
713 Value: Size of the VM to create when using the newvm command of pb.
714 Conffile: vm
715 Example: vmsize default = 7G
716
717=item B<vmsnap>
718
719 Nature: Optional
720 Key: project (as defined in the -p option or PBPROJ environment variable)
721 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.
722 Conffile: vm
723 Example: vmsnap default = true
724
725=item B<vmtmout>
726
727 Nature: Optional
728 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.
729 Value: Time in seconds to wait before interacting with the VM. This should correspond to the time the VM takes to boot.
730 Conffile: vm
731 Example: vmtmout default = 180,vmtmout mandriva-2009.0-x86_64 = 500
732
733=item B<vmtype>
734
735 Nature: Mandatory
736 Key: project (as defined in the -p option or PBPROJ environment variable)
737 Value: qemu|kvm. For the moment, only QEMU or KVM are supported as virtualization technologies.
738 Conffile: vm
739 Example: vmrtype default = kvm
740
741=item B<webdir>
742
743 Nature: Optional
744 Key: project (as defined in the -p option or PBPROJ environment variable)
745 Value: Target directory containing the web content in the project that should be delivered when using the sbx|cms2webssh|pkg command of pb.
746 Conffile: project
747 Example: webdir mondorescue = website
748
749=item B<websshdir>
750
751 Nature: Optional (when not using *2webssh commands)
752 Key: project (as defined in the -p option or PBPROJ environment variable)
753 Value: dirname into which content is uploaded on the B<websshhost> machine.
754 Conffile: project
755 Example: websshdir mondorescue = /var/www/html
756
757=item B<websshhost>
758
759 Nature: Optional (when not using *2webssh commands)
760 Key: project (as defined in the -p option or PBPROJ environment variable)
761 Value: hostname to connect to in order to deliver content to the Web server.
762 Conffile: project
763 Example: websshhost mondorescue = www.mondorescue.org
764
765=item B<websshlogin>
766
767 Nature: Optional (when not using *2webssh commands)
768 Key: project (as defined in the -p option or PBPROJ environment variable)
769 Value: login to use when connecting to the Web server B<websshhost> for content delivery.
770 Conffile: project
771 Example: websshlogin mondorescue = mylogin
772
773=item B<websshport>
774
775 Nature: Optional (when not using *2webssh commands)
776 Key: project (as defined in the -p option or PBPROJ environment variable)
777 Value: port to use when connecting to the Web server B<websshhost> for content delivery.
778 Conffile: project
779 Example: websshport mondorescue = 22
780
781=back
782
783=head1 OTHER PARAMETERS
784=item B<pb_URL>
785=item B<pb_directory_desc>
786=item B<pb_environment_variables>
Note: See TracBrowser for help on using the repository browser.