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

Last change on this file since 1386 was 1386, checked in by bruno, 7 years ago
  • Adds option checkexclude and command checkssh with the -rebuild option: this allows to check after the build which packages have not been built correctly and to potentially relaunch the build (however why it didn't built is left as an exercise to the reader !)
File size: 37.6 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<checkexclude>
26
27 Nature: Optional
28 Key: package (as provided in defpkgdir or extpkgdir)
29 Value: coma separated list of OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch) that are excluded from the checkssh command (no build made for them). The OS name is generaly used here.
30 Conffile: project
31 Example: checkexclude pkg1 = centos,lsb,solaris
32
33=item B<cpandir>
34
35 Nature: Optional
36 Key: project (as defined in the -p option or PBPROJ environment variable)
37 Value: CPAN Pause directory to upload new modules
38 Conffile: pb
39 Example: cpandir default = incoming
40
41=item B<cpanpasswd>
42
43 Nature: Optional
44 Key: project (as defined in the -p option or PBPROJ environment variable)
45 Value: CPAN Pause user's password
46 Conffile: home
47 Example: cpanpasswd default = mycomplicatedpwd
48
49=item B<cpanpause>
50
51 Nature: Optional
52 Key: project (as defined in the -p option or PBPROJ environment variable)
53 Value: CPAN Pause site to upload new modules
54 Conffile: pb
55 Example: cpanpause default = pause.perl.org
56
57=item B<cpansubdir>
58
59 Nature: Optional
60 Key: project (as defined in the -p option or PBPROJ environment variable)
61 Value: CPAN Pause subdirectory in the user's area to upload into
62 Conffile: pb
63 Example: cpansubdir default = mydir
64
65=item B<cpanurl>
66
67 Nature: Optional
68 Key: project (as defined in the -p option or PBPROJ environment variable)
69 Value: CPAN Pause URL to activate the upload mecanism
70 Conffile: pb
71 Example: cpanurl default = http://pause.perl.org/pause/authenquery
72
73=item B<cpanuser>
74
75 Nature: Optional
76 Key: project (as defined in the -p option or PBPROJ environment variable)
77 Value: CPAN Pause user
78 Conffile: home
79 Example: cpanuser default = XXX
80
81=item B<defpkgdir>
82
83 Nature: Mandatory
84 Key: project (as defined in the -p option or PBPROJ environment variable)
85 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.
86 Conffile: project
87 Example: defpkgdir mondorescue = mondo,mindi NB: a default value is not really meaningful.
88
89=item B<delivery>
90
91 Nature: Optional
92 Key: project (as defined in the -p option or PBPROJ environment variable)
93 Value: directory where to deliver packages once built for ftp/web access.
94 Conffile: project
95 Example: delivery mondorescue = prod
96
97=item B<extpkgdir>
98
99 Nature: Optional
100 Key: project (as defined in the -p option or PBPROJ environment variable)
101 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.
102 Conffile: project
103 Example: extpkgdir mondorescue = mondo-doc,mindi-mindibusybox
104
105=item B<filteredfiles>
106
107 Nature: Optional
108 Key: package (as provided in defpkgdir or extpkgdir)
109 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.
110 Conffile: project
111 Example: filteredfiles mindi = rootfs/sbin/init,mindi,install.sh,doc/mindi.8
112
113=item B<mkbmpath>
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). The family name is generaly used here.
117 Value: path of the temporary directory into which the boot media is created.
118 Conffile: pb
119 Example: mkbmpath default = /var/cache/pbmkbm
120
121=item B<namingtype>
122
123 Nature: Optional
124 Key: package (as provided in defpkgdir or extpkgdir)
125 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)
126 Conffile: project
127 Example: namingtype ProjectBuilder = perl
128
129=item B<osambiguous>
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). In that case, should be an OS name.
133 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>
134 Conffile: pb
135 Example: osambiguous debian = debian,ubuntu
136
137=item B<oschkcmd>
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: package checker tool.
142 Conffile: pb
143 Example: oschkcmd deb = /usr/bin/lintian
144
145=item B<oschkopt>
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: package checker tool options.
150 Conffile: pb
151 Example: oschkcmd rpm = -i
152
153=item B<oscmd>
154
155 Nature: Mandatory
156 Key: tool (pb or rpmbootstrap)
157 Value: come separated list of commands that are mandatory on the underlying system
158 Conffile: pb
159 Example: oscmd pb = tar,ls
160
161=item B<oscmdopt>
162
163 Nature: Mandatory
164 Key: tool (pb or rpmbootstrap)
165 Value: come separated list of commands that are optional on the underlying system
166 Conffile: pb
167 Example: oscmd pb = svn2cl,svn,cvs
168
169=item B<oscodename>
170
171 Nature: Optional
172 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.
173 Value: code name. Mostly useful for debian and ubuntu, due to debootstrap.
174 Conffile: pb
175 Example: oscodename debian-5.0 = lenny
176
177=item B<osfamily>
178
179 Nature: Mandatory
180 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.
181 Value: OS family name (used to group similar distribution for handling)
182 Conffile: pb
183 Example: osfamily debian = du
184
185=item B<osins>
186
187 Nature: Optional
188 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.
189 Value: OS command to lauch in order to automatically install packages on it.
190 Conffile: pb
191 Example: osins fedora = sudo yum -y install
192
193=item B<osmindep>
194
195 Nature: Optional
196 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.
197 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.
198 Conffile: pb
199 Example: osmindep default = perl,sudo,wget,tar,make,gzip
200
201=item B<osnover>
202
203 Nature: Optional
204 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
205 Value: true|false. True means that this OS has no need to keep the version
206 Conffile: pb
207 Example: osnover gentoo = true
208
209=item B<ospatchcmd>
210
211 Nature: Optional
212 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
213 Value: package patch command. For RPM is implicit.
214 Conffile: pb
215 Example: ospatchcmd deb = /usr/bin/patch
216
217=item B<ospatchopt>
218
219 Nature: Optional
220 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
221 Value: package patch options.
222 Conffile: pb
223 Example: ospatchcmd deb = -s -p1
224
225=item B<ospathcmd-*>
226
227 Nature: Optional
228 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
229 Value: Full path name of the command mentioned after the '-' for the relative OS
230 Conffile: pb
231 Example: ospathcmd-halt solaris = /usr/sbin/halt, ospathcmd-halt default = /sbin/halt
232
233=item B<osperldep>
234
235 Nature: Optional
236 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
237 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.
238 Conffile: pb
239 Example: osperldep rhel-5 = Module-Build,File-MimeInfo,File-BaseDir,Mail-Sendmail
240
241=item B<osperlver>
242
243 Nature: Mandatory (for each module mentioned in B<osperldep>)
244 Key: Perl Module (as defined in B<osperldep>)
245 Value: Version of the perl module that needs to be found on CPAN.
246 Conffile: pb
247 Example: Date-Manip = 5.54
248
249=item B<ospkg>
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: ospkg rhel-5 = project-builder
256
257=item B<ospkgdep>
258
259 Nature: Optional
260 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
261 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.
262 Conffile: pb
263 Example: ospkgdep rhel-5 = wget,make,ntp,patch,perl-DateManip
264
265=item B<osrelambfile>
266
267 Nature: Mandatory (per OS mentioned in B<osambiguous>)
268 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.
269 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.
270 Conffile: pb
271 Example: osrelambfile debian = /etc/debian_version
272
273=item B<osrelexpr>
274
275 Nature: Mandatory (per OS mentioned in B<osrelambfile> and B<osrelfile>)
276 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
277 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)
278 Conffile: pb
279osrelexpr rhel = Red Hat (?:Enterprise Linux|Linux Advanced Server) .*release ([0-9.]+).* \(
280 Example:
281
282=item B<osrelfile>
283
284 Nature: Mandatory
285 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.
286 Value: full path name of the file describing non-ambiguously that distribution. There should be a bijection between the file and the distribution name.
287 Conffile: pb
288 Example: osrelfile fedora = /etc/fedora-release
289
290=item B<osremovedotinver>
291
292 Nature: Optional
293 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
294 Value: true|false. If true, then no '.' (dot) character is kept in the version name of that OS.
295 Conffile: pb
296 Example: osremovedotinver redhat = true
297
298=item B<osrepo>
299
300 Nature: Optional (Mandatory if pbinstalltype is pkg)
301 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
302 Value: coma separated list of packages or repo file to be added to the VE|VM to support package installation of pb
303 Conffile: pb
304 Example: osrepo rpm = ftp://ftp.project-builder.org/$ddir/$dver/pb.repo
305
306=item B<ossha>
307
308 Nature: Optional (Mandatory if rpm type of package)
309 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
310 Value: sha algorithm used br createrepo
311 Conffile: pb
312 Example: ossha fedora-10 = sha1
313
314=item B<ossuffix>
315
316 Nature: Optional
317 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
318 Value: suffix that will be used in the name of the packages created. By default, concatenation of OS name and version.
319 Conffile: pb
320 Example: ossuffix mandriva = mdv
321
322=item B<ostype>
323
324 Nature: Mandatory
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: build type grouping packages family. This is used internaly by pb to make various handling depending on that build type.
327 Conffile: pb
328 Example: ostype rh = rpm, ostype md = rpm, ostype novell = rpm
329
330=item B<osupd>
331
332 Nature: Optional
333 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.
334 Value: OS command to lauch in order to automatically update th VM|VE
335 Conffile: pb
336 Example: osupd fedora = sudo yum -y update
337
338=item B<pbconfurl>
339
340 Nature: Mandatory
341 Key: project (as defined in the -p option or PBPROJ environment variable)
342 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
343 Conffile: home|project
344 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
345
346=item B<pbdefdir>
347
348 Nature: Optional
349 Key: project (as defined in the -p option or PBPROJ environment variable)
350 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.
351 Conffile: home
352 Example: pbdefdir default = $ENV{'HOME'}/local/pb/projects
353
354=item B<pbinstalltype>
355
356 Nature: Mandatory
357 Key: project (as defined in the -p option or PBPROJ environment variable)
358 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.
359 Conffile: pb
360
361=item B<pbml>
362
363 Nature: Optional (Mandatory if using announce command)
364 Key: project (as defined in the -p option or PBPROJ environment variable)
365 Value: white space separated list of e-mail adresses used to send announces with the pb announce option.
366 Conffile: project
367 Example: pbml pb = pb-announce@project-builder.org pb-devel@project-builder.org
368
369=item B<pbpackager>
370
371 Nature: Mandatory
372 Key: project (as defined in the -p option or PBPROJ environment variable)
373 Value: Firstname Name and e-mail address of the person packaging the software.
374 Conffile: project
375 Example: pbpackager pb = Bruno Cornec <bruno@project-builder.org>
376
377=item B<pbparallel>
378
379 Nature: Optional
380 Key: tool (pb or rpmbootstrap)
381 Value: number of processes to execute in parallel. By default use the number of cores.
382 Conffile: pb
383 Example: pbparallel pb = 12
384
385=item B<pbpassfile>
386
387 Nature: Optional
388 Key: project (as defined in the -p option or PBPROJ environment variable)
389 Value: File containing the GPG passphrase that is used to sign packages
390 Conffile: home
391 Example: pbpassfile pb = /users/me/secret/passfile
392
393=item B<pbpasspath>
394
395 Nature: Optional
396 Key: project (as defined in the -p option or PBPROJ environment variable)
397 Value: The directory under which will be found your secret key file.
398 Conffile: home
399 Example: pbpasspath pb = /home/me/.gnupg
400
401=item B<pbpassphrase>
402
403 Nature: Optional
404 Key: project (as defined in the -p option or PBPROJ environment variable)
405 Value: The GPG passphrase that is used to sign packages. Putting it in your conf file has security implications.
406 Conffile: home
407 Example: pbpassphrase pb = TheSecretPassPhrase
408
409=item B<pbprojdir>
410
411 Nature: Optional
412 Key: project (as defined in the -p option or PBPROJ environment variable)
413 Value: local directory under which the project is locally exported. NB: a default value is highly interesting here. By default pbdefdir/projectname
414 Conffile: home
415 Example: pbprojdir mondorescue = $ENV{'HOME'}/local/mondorescue
416
417=item B<pbrepo>
418
419 Nature: Mandatory
420 Key: project (as defined in the -p option or PBPROJ environment variable)
421 Value: URL of the server hosting the upstream tar file.
422 Conffile: project
423 Example: pbrepo mondorescue = ftp://ftp.mondorescue.org
424
425=item B<pbsmtp>
426
427 Nature: Optional (Mandatory if using the announce command)
428 Key: project (as defined in the -p option or PBPROJ environment variable)
429 Value: FQDN of the mail server to use to send announces. NB: a default value is highly interesting here.
430 Conffile: home
431 Example: pbsmtp mondorescue = localhost
432
433=item B<pbsockscmd>
434
435 Nature: Optional
436 Key: project (as defined in the -p option or PBPROJ environment variable)
437 Value: name of the command to use to socksify network calls. NB: a default value is highly interesting here.
438 Conffile: home
439 Example: pbsockscmd default = tsocks
440
441=item B<pburl>
442
443 Nature: Optional
444 Key: project (as defined in the -p option or PBPROJ environment variable)
445 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
446 Conffile: home|project
447 Example: pburl linuxcoe = cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe, pburl pb = svk:////local/pb
448
449=item B<pbwf>
450
451 Nature: Optional
452 Key: project (as defined in the -p option or PBPROJ environment variable)
453 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.
454 Conffile: project
455 Example: pbwf afio = 1
456
457=item B<pkgtag>
458
459 Nature: Optional
460 Key: package (as provided in defpkgdir or extpkgdir)
461 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).
462 Conffile: project
463 Example: pkgtag mindi-busybox = 2
464
465=item B<pkgver>
466
467 Nature: Optional
468 Key: package (as provided in defpkgdir or extpkgdir)
469 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>.
470 Conffile: project
471 Example: pkgver mindi-busybox = 1.7.3
472
473=item B<projtag>
474
475 Nature: Mandatory
476 Key: project (as defined in the -p option or PBPROJ environment variable)
477 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>.
478 Conffile: project
479 Example: projtag mondorescue = 1
480
481=item B<projver>
482
483 Nature: Mandatory
484 Key: project (as defined in the -p option or PBPROJ environment variable)
485 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>.
486 Conffile: project
487 Example: projver mondorescue = 2.2.9
488
489=item B<rbsconf>
490
491 Nature: Optional
492 Key: project (as defined in the -p option or PBPROJ environment variable)
493 Value: for mock it's the configuration directory. For rinse it's its configuration file. For rpmbootstrap it's not used yet.
494 Conffile: ve
495 Example: rbsconf default = /etc/mock, rbsconf default = /etc/pb/pb-rinse.conf
496
497=item B<rbsb4pi>
498
499 Nature: Optional
500 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.
501 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.
502 Conffile: ve
503 Example: rbsb4pi centos = /home/rinse/bin/before-post-install.sh
504
505=item B<rbsopt>
506
507 Nature: Optional
508 Key: tool used for rpm based VE. Could be one of rpmbootstrap, rinse, mock, ...
509 Value: Additional option to pass to the command
510 Conffile: ve
511 Example: rbsopt rpmbootstrap = -k
512
513=item B<rbspi>
514
515 Nature: Optional
516 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.
517 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.
518 Conffile: ve
519 Example: rbspi centos = /home/rinse/bin/post-install.sh
520
521=item B<rmhost>
522
523 Nature: Mandatory
524 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.
525 Value: IP address or name of the Remote Machine running the OS mentioned in the key, accessed through ssh.
526 Conffile: rm
527 Example: rmhost default = localhost - rmhost hpux-11.3-ia64 = 10.10.10.10 - rmhost mandriva-2010.2-x86_64 = machine1.domain.name
528
529=item B<rmlist>
530
531 Nature: Mandatory
532 Key: project (as defined in the -p option or PBPROJ environment variable)
533 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.
534 Conffile: rm
535 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
536
537=item B<rmlogin>
538
539 Nature: Mandatory
540 Key: project (as defined in the -p option or PBPROJ environment variable)
541 Value: account name to use on the Remote Machine to build packages. Communication is done with ssh.
542 Conffile: rm
543 Example: rmlogin default = pb
544
545=item B<rmmonport>
546
547 Nature: Optional
548 Key: project (as defined in the -p option or PBPROJ environment variable)
549 Value: TCP port that is used to dialog with the monitor of the Remote Machine, to pass orders.
550 Conffile: rm
551 Example: rmmonport default = 4444
552
553=item B<rmntp>
554
555 Nature: Optional
556 Key: project (as defined in the -p option or PBPROJ environment variable)
557 Value: NTP server to contact for time accuracy with B<rmntpcmd> before building.
558 Conffile: rm
559 Example: rmntp default = 1.pool.ntp.org
560
561=item B<rmntpcmd>
562
563 Nature: Mandatory
564 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
565 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.
566 Conffile: rm
567 Example: rmntpcmd default = /usr/sbin/ntpdate,rmntpcmd opensuse-10.1-i386 = /usr/sbin/sntp -P no -r
568
569=item B<rmpath>
570
571 Nature: Mandatory
572 Key: project (as defined in the -p option or PBPROJ environment variable)
573 Value: path where to find configuration file for Remote Machines management.
574 Conffile: rm
575 Example: rmpath default = /home/remote
576
577=item B<rmport>
578
579 Nature: Mandatory
580 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
581 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.
582 Conffile: rm
583 Example: rmport pb = 2222,rmport mondorescue = 2223
584
585=item B<rmtmout>
586
587 Nature: Optional
588 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.
589 Value: Time in seconds to wait before interacting with the RM. This may correspond to the time the RM takes to boot.
590 Conffile: rm
591 Example: rmtmout default = 10
592
593=item B<rmtype>
594
595 Nature: Mandatory
596 Key: project (as defined in the -p option or PBPROJ environment variable)
597 Value: ssh. For the moment, only ssh is supported as a communication means with RM.
598 Conffile: rm
599 Example: rmrtype default = ssh
600
601=item B<sshdir>
602
603 Nature: Mandatory
604 Key: project (as defined in the -p option or PBPROJ environment variable)
605 Value: dirname into which packages are uploaded on the B<sshhost> machine.
606 Conffile: project
607 Example: sshdir mondorescue = /pub/mondorescue
608
609=item B<sshhost>
610
611 Nature: Mandatory
612 Key: project (as defined in the -p option or PBPROJ environment variable)
613 Value: hostname to connect to in order to deliver packages to the repository server.
614 Conffile: project
615 Example: sshhost mondorescue = ftp.mondorescue.org
616
617=item B<sshlogin>
618
619 Nature: Mandatory
620 Key: project (as defined in the -p option or PBPROJ environment variable)
621 Value: login to use when connecting to the repository server B<sshhost> for package delivery.
622 Conffile: project
623 Example: sshlogin mondorescue = mylogin
624
625=item B<sshport>
626
627 Nature: Mandatory
628 Key: project (as defined in the -p option or PBPROJ environment variable)
629 Value: port to use when connecting to the repository server B<sshhost> for package delivery.
630 Conffile: project
631 Example: sshport mondorescue = 22
632
633=item B<supfiles>
634
635Not used yet.
636
637=item B<testver>
638
639 Nature: Optional
640 Key: project (as defined in the -p option or PBPROJ environment variable)
641 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.
642 Conffile: project
643 Example: testver mondorescue = true
644
645=item B<vedebtype>
646
647 Nature: Mandatory
648 Key: project (as defined in the -p option or PBPROJ environment variable)
649 Value: debootstrap (no other tool to create deb distro based chroot)
650 Conffile: ve
651 Example: vedebtype default = debootstrap
652
653=item B<velist>
654
655 Nature: Mandatory
656 Key: project (as defined in the -p option or PBPROJ environment variable)
657 Value: list of coma separated OS (under the form of os-ver-arch).
658 Conffile: ve
659 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
660
661=item B<velogin>
662
663 Nature: Mandatory
664 Key: project (as defined in the -p option or PBPROJ environment variable)
665 Value: account name to use in the VE to build packages.
666 Conffile: ve
667 Example: velogin default = pb
668
669=item B<ventp>
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<ventpcmd> before building.
674 Conffile: ve
675 Example: ventp default = 1.pool.ntp.org
676
677=item B<ventpcmd>
678
679 Nature: Mandatory
680 Key: project (as defined in the -p option or PBPROJ environment variable)
681 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.
682 Conffile: ve
683 Example: ventpcmd default = /usr/sbin/ntpdate
684
685=item B<vepath>
686
687 Nature: Mandatory
688 Key: project (as defined in the -p option or PBPROJ environment variable)
689 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.
690 Conffile: ve
691 Example: vepath default = /home/rpmbootstrap
692
693=item B<verebuild>
694
695 Nature: Optional
696 Key: project (as defined in the -p option or PBPROJ environment variable)
697 Value: true|false. True means that the VE should be rebuild before usage.
698 Conffile: ve
699 Example: verebuild default = true
700
701=item B<verpmtype>
702
703 Nature: Mandatory
704 Key: project (as defined in the -p option or PBPROJ environment variable)
705 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).
706 Conffile: ve
707 Example: verpmtype default = rpmbootstrap
708
709=item B<vesnap>
710
711 Nature: Optional
712 Key: project (as defined in the -p option or PBPROJ environment variable)
713 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.
714 Conffile: ve
715 Example: vesnap default = true
716
717=item B<vetype>
718
719 Nature: Mandatory
720 Key: project (as defined in the -p option or PBPROJ environment variable)
721 Value: chroot|schroot. There are two different ways of launching a chroot activity in pb. For the moment only chroot has been tested.
722 Conffile: ve
723 Example: vertype default = chroot
724
725=item B<vmbuildtm>
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). Default value is set to vmtmout
729 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.
730 Conffile: project
731 Example: vmbuildtm default = 600,vmbuildtm mandriva-2009.0-x86_64 = 1200
732
733=item B<vmcmd>
734
735 Nature: Mandatory
736 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.
737 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.
738 Conffile: vm
739 Example: vmcmd default = /usr/bin/kvm
740
741=item B<vmhost>
742
743 Nature: Mandatory
744 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
745 Value: hostname to connect to in order to reach the VM through ssh. Generally redirected from a port on localhost.
746 Conffile: vm
747 Example: vmhost default = localhost
748
749=item B<vmlist>
750
751 Nature: Mandatory
752 Key: project (as defined in the -p option or PBPROJ environment variable)
753 Value: list of coma separated OS (under the form of os-ver-arch).
754 Conffile: vm
755 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
756
757=item B<vmlogin>
758
759 Nature: Mandatory
760 Key: project (as defined in the -p option or PBPROJ environment variable)
761 Value: account name to use in the VM to build packages. Communication is done with ssh.
762 Conffile: vm
763 Example: vmlogin default = pb
764
765=item B<vmmem>
766
767 Nature: Optional
768 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
769 Value: Memory size in MB to allocate to the VM.
770 Conffile: vm
771 Example: vmmem default = 512
772
773=item B<vmmonport>
774
775 Nature: Optional
776 Key: project (as defined in the -p option or PBPROJ environment variable)
777 Value: TCP port that is used to dialog with the monitor of the VM, to pass orders such as snapshot. Not really operational yet.
778 Conffile: vm
779 Example: vmmonport default = 4444
780
781=item B<vmntp>
782
783 Nature: Optional
784 Key: project (as defined in the -p option or PBPROJ environment variable)
785 Value: NTP server to contact for time accuracy with B<vmntpcmd> before building.
786 Conffile: vm
787 Example: vmntp default = 1.pool.ntp.org
788
789=item B<vmntpcmd>
790
791 Nature: Mandatory
792 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
793 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.
794 Conffile: vm
795 Example: vmntpcmd default = /usr/sbin/ntpdate,vmntpcmd opensuse-11.0-i386 = /usr/sbin/sntp -P no -r
796
797=item B<vmopt>
798
799 Nature: Optional
800 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.
801 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.
802 Conffile: vm
803 Example: vmopt default = -m 384 -daemonize,vmopt mandriva-2009.0-i386 = -m 256 -daemonize -no-kvm
804
805=item B<vmpath>
806
807 Nature: Mandatory
808 Key: project (as defined in the -p option or PBPROJ environment variable)
809 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.
810 Conffile: vm
811 Example: vmpath default = /home/qemu
812
813=item B<vmport>
814
815 Nature: Mandatory
816 Key: project (as defined in the -p option or PBPROJ environment variable)
817 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.
818 Conffile: vm
819 Example: vmport pb = 2222,vmport mondorescue = 2223
820
821=item B<vmsize>
822
823 Nature: Mandatory
824 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
825 Value: Size of the VM to create when using the newvm command of pb.
826 Conffile: vm
827 Example: vmsize default = 7G
828
829=item B<vmsnap>
830
831 Nature: Optional
832 Key: project (as defined in the -p option or PBPROJ environment variable)
833 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.
834 Conffile: vm
835 Example: vmsnap default = true
836
837=item B<vmtmout>
838
839 Nature: Optional
840 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.
841 Value: Time in seconds to wait before interacting with the VM. This should correspond to the time the VM takes to boot.
842 Conffile: vm
843 Example: vmtmout default = 180,vmtmout mandriva-2009.0-x86_64 = 500
844
845=item B<vmtype>
846
847 Nature: Mandatory
848 Key: project (as defined in the -p option or PBPROJ environment variable)
849 Value: qemu|kvm. For the moment, only QEMU or KVM are supported as virtualization technologies.
850 Conffile: vm
851 Example: vmrtype default = kvm
852
853=item B<webdir>
854
855 Nature: Optional
856 Key: project (as defined in the -p option or PBPROJ environment variable)
857 Value: Target directory containing the web content in the project that should be delivered when using the sbx|cms2webssh|pkg command of pb.
858 Conffile: project
859 Example: webdir mondorescue = website
860
861=item B<websshdir>
862
863 Nature: Optional (when not using *2webssh commands)
864 Key: project (as defined in the -p option or PBPROJ environment variable)
865 Value: dirname into which content is uploaded on the B<websshhost> machine.
866 Conffile: project
867 Example: websshdir mondorescue = /var/www/html
868
869=item B<websshhost>
870
871 Nature: Optional (when not using *2webssh commands)
872 Key: project (as defined in the -p option or PBPROJ environment variable)
873 Value: hostname to connect to in order to deliver content to the Web server.
874 Conffile: project
875 Example: websshhost mondorescue = www.mondorescue.org
876
877=item B<websshlogin>
878
879 Nature: Optional (when not using *2webssh commands)
880 Key: project (as defined in the -p option or PBPROJ environment variable)
881 Value: login to use when connecting to the Web server B<websshhost> for content delivery.
882 Conffile: project
883 Example: websshlogin mondorescue = mylogin
884
885=item B<websshport>
886
887 Nature: Optional (when not using *2webssh commands)
888 Key: project (as defined in the -p option or PBPROJ environment variable)
889 Value: port to use when connecting to the Web server B<websshhost> for content delivery.
890 Conffile: project
891 Example: websshport mondorescue = 22
892
893=back
894
895=head1 OTHER PARAMETERS
896=item B<pb_URL>
897=item B<pb_directory_desc>
898=item B<pb_environment_variables>
Note: See TracBrowser for help on using the repository browser.