source: devel/etc/pb.conf.pod @ 1500

Last change on this file since 1500 was 1500, checked in by bruno, 7 years ago

project-builder-r1426

File size: 41.4 KB
RevLine 
[1498]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
[1500]14Those files have the same format, which is near from a perl hash structure:
[1498]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
[1500]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
[1498]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
[1500]113=item B<logcmd>
114
115 Nature: Mandatory
116 Key: project (as defined in the -p option or PBPROJ environment variable)
117 Value: internal (the application then handles the logging of what it finds useful) or the name of an application to launch to log context (e.g. sos, cfg2html, ...).
118 Conffile: pb
119 Example: logcmd pbmkbm = sos
120
121=item B<logcmds>
122
123 Nature: Optional
124 Key: project (as defined in the -p option or PBPROJ environment variable)
125 Value: In case the B<logcmd> command is internal, a coma separated list of the commands whose trace execution is to be captured in order to log context.
126 Conffile: pb
127 Example: logcmds pbmkbm = mount,lsmod,esxcfg-module -l,df -T
128
129=item B<logfiles>
130
131 Nature: Optional
132 Key: project (as defined in the -p option or PBPROJ environment variable)
133 Value: In case the B<logcmd> command is internal, a coma separated list of the files to capture in order to log context.
134 Conffile: pb
135 Example: logfiles pbmkbm = /etc/raidtab,/proc/cmdline,/proc/swaps
136
137=item B<logopt>
138
139 Nature: Optional
140 Key: project (as defined in the -p option or PBPROJ environment variable)
141 Value: In case the B<logcmd> command is not internal, the options of the B<logcmd> application to launch to log context
142 Conffile: pb
143 Example: logcmd pbmkbm = --all
144
145=item B<mkbmbootcmds>
146
147 Nature: Mandatory
148 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.
149 Value: coma separated list of commands to be copied from the original OS to the target boot media tree (works recursively for directory creation on the target). Their actual path is deduced from the PATH variable.
150 Conffile: pb
151 Example: mkbmbootcmds linux = perl,awk,gawk,dd,grep,uname
152
153=item B<mkbmbootdirs>
154
155 Nature: Mandatory
156 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.
157 Value: coma separated list of directories to be copied from the original OS to the target boot media tree (works recursively on the target).
158 Conffile: pb
159 Example: mkbmbootdirs linux = /etc/ssh,/etc/udev,/etc/mdadm
160
161=item B<mkbmbootfiles>
162
163 Nature: Mandatory
164 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.
165 Value: coma separated list of files to be copied from the original OS to the target boot media tree (works recursively for directory creation on the target).
166 Conffile: pb
167 Example: mkbmbootfiles linux = /etc/mdadm.conf,/etc/raidtab,/etc/modprobe.conf
168
169=item B<mkbmkerneldir>
170
171 Nature: Mandatory
172 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.
173 Value: path of the directory containing your kernel.
174 Conffile: pb
175 Example: mkbmkerneldir linux = /boot
176
177=item B<mkbmkernelfile>
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). The family name is generaly used here.
181 Value: full path of the your kernel.
182 Conffile: pb
183 Example: mkbmkernelfile linux = /boot/vmlinuz-specific
184
185=item B<mkbmkernelnamere>
186
187 Nature: Mandatory
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: Perl Regular Expression allowing to find OS kernel names in the B<kerneldir> directory.
190 Conffile: pb
191 Example: mkbmkerneldir linux = ^linu|^vmlinu|^xen
192
193=item B<mkbmpath>
194
195 Nature: Mandatory
196 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.
197 Value: path of the temporary directory into which the boot media is created.
198 Conffile: pb
199 Example: mkbmpath default = /var/cache/pbmkbm
200
201=item B<mkbmtargetdirs>
202
203 Nature: Mandatory
204 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.
205 Value: coma separated list of empty directory paths to be created on the target boot media.
206 Conffile: pb
207 Example: mkbmtargetdirs linux = /tmp,/dev
208
[1498]209=item B<namingtype>
210
211 Nature: Optional
212 Key: package (as provided in defpkgdir or extpkgdir)
213 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)
214 Conffile: project
215 Example: namingtype ProjectBuilder = perl
216
217=item B<osambiguous>
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). In that case, should be an OS name.
221 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>
222 Conffile: pb
223 Example: osambiguous debian = debian,ubuntu
224
225=item B<oschkcmd>
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: package checker tool.
230 Conffile: pb
231 Example: oschkcmd deb = /usr/bin/lintian
232
233=item B<oschkopt>
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: package checker tool options.
238 Conffile: pb
239 Example: oschkcmd rpm = -i
240
241=item B<oscmd>
242
243 Nature: Mandatory
244 Key: tool (pb or rpmbootstrap)
245 Value: come separated list of commands that are mandatory on the underlying system
246 Conffile: pb
247 Example: oscmd pb = tar,ls
248
249=item B<oscmdopt>
250
251 Nature: Mandatory
252 Key: tool (pb or rpmbootstrap)
253 Value: come separated list of commands that are optional on the underlying system
254 Conffile: pb
255 Example: oscmd pb = svn2cl,svn,cvs
256
257=item B<oscodename>
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). In that case, should be an os-ver.
261 Value: code name. Mostly useful for debian and ubuntu, due to debootstrap.
262 Conffile: pb
263 Example: oscodename debian-5.0 = lenny
264
265=item B<osfamily>
266
267 Nature: Mandatory
268 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.
269 Value: OS family name (used to group similar distribution for handling)
270 Conffile: pb
271 Example: osfamily debian = du
272
273=item B<osins>
274
275 Nature: Optional
276 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.
277 Value: OS command to lauch in order to automatically install packages on it.
278 Conffile: pb
279 Example: osins fedora = sudo yum -y install
280
281=item B<osmindep>
282
283 Nature: Optional
284 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.
285 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.
286 Conffile: pb
287 Example: osmindep default = perl,sudo,wget,tar,make,gzip
288
289=item B<osnover>
290
291 Nature: Optional
292 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
293 Value: true|false. True means that this OS has no need to keep the version
294 Conffile: pb
295 Example: osnover gentoo = true
296
[1500]297=item B<ospatchcmd>
298
299 Nature: Optional
300 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
301 Value: package patch command. For RPM is implicit.
302 Conffile: pb
303 Example: ospatchcmd deb = /usr/bin/patch
304
305=item B<ospatchopt>
306
307 Nature: Optional
308 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
309 Value: package patch options.
310 Conffile: pb
311 Example: ospatchcmd deb = -s -p1
312
[1498]313=item B<ospathcmd-*>
314
315 Nature: Optional
316 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
317 Value: Full path name of the command mentioned after the '-' for the relative OS
318 Conffile: pb
319 Example: ospathcmd-halt solaris = /usr/sbin/halt, ospathcmd-halt default = /sbin/halt
320
321=item B<osperldep>
322
323 Nature: Optional
324 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
325 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.
326 Conffile: pb
327 Example: osperldep rhel-5 = Module-Build,File-MimeInfo,File-BaseDir,Mail-Sendmail
328
329=item B<osperlver>
330
331 Nature: Mandatory (for each module mentioned in B<osperldep>)
332 Key: Perl Module (as defined in B<osperldep>)
333 Value: Version of the perl module that needs to be found on CPAN.
334 Conffile: pb
335 Example: Date-Manip = 5.54
336
337=item B<ospkg>
338
339 Nature: Optional (Mandatory if pbinstalltype is pkg)
340 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
341 Value: coma separated list of packages that have to be installed in order for pb to be operational in the VE|VM
342 Conffile: pb
343 Example: ospkg rhel-5 = project-builder
344
345=item B<ospkgdep>
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).
349 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.
350 Conffile: pb
351 Example: ospkgdep rhel-5 = wget,make,ntp,patch,perl-DateManip
352
353=item B<osrelambfile>
354
355 Nature: Mandatory (per OS mentioned in B<osambiguous>)
356 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.
357 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.
358 Conffile: pb
359 Example: osrelambfile debian = /etc/debian_version
360
361=item B<osrelexpr>
362
363 Nature: Mandatory (per OS mentioned in B<osrelambfile> and B<osrelfile>)
364 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
365 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)
366 Conffile: pb
367osrelexpr rhel = Red Hat (?:Enterprise Linux|Linux Advanced Server) .*release ([0-9.]+).* \(
368 Example:
369
370=item B<osrelfile>
371
372 Nature: Mandatory
373 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.
374 Value: full path name of the file describing non-ambiguously that distribution. There should be a bijection between the file and the distribution name.
375 Conffile: pb
376 Example: osrelfile fedora = /etc/fedora-release
377
378=item B<osremovedotinver>
379
380 Nature: Optional
381 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
382 Value: true|false. If true, then no '.' (dot) character is kept in the version name of that OS.
383 Conffile: pb
384 Example: osremovedotinver redhat = true
385
386=item B<osrepo>
387
388 Nature: Optional (Mandatory if pbinstalltype is pkg)
389 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
390 Value: coma separated list of packages or repo file to be added to the VE|VM to support package installation of pb
391 Conffile: pb
392 Example: osrepo rpm = ftp://ftp.project-builder.org/$ddir/$dver/pb.repo
393
394=item B<ossha>
395
396 Nature: Optional (Mandatory if rpm type of package)
397 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
398 Value: sha algorithm used br createrepo
399 Conffile: pb
400 Example: ossha fedora-10 = sha1
401
402=item B<ossuffix>
403
404 Nature: Optional
405 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
406 Value: suffix that will be used in the name of the packages created. By default, concatenation of OS name and version.
407 Conffile: pb
408 Example: ossuffix mandriva = mdv
409
410=item B<ostype>
411
412 Nature: Mandatory
413 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.
414 Value: build type grouping packages family. This is used internaly by pb to make various handling depending on that build type.
415 Conffile: pb
416 Example: ostype rh = rpm, ostype md = rpm, ostype novell = rpm
417
418=item B<osupd>
419
420 Nature: Optional
421 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.
422 Value: OS command to lauch in order to automatically update th VM|VE
423 Conffile: pb
424 Example: osupd fedora = sudo yum -y update
425
426=item B<pbconfurl>
427
428 Nature: Mandatory
429 Key: project (as defined in the -p option or PBPROJ environment variable)
430 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
431 Conffile: home|project
432 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
433
434=item B<pbdefdir>
435
436 Nature: Optional
437 Key: project (as defined in the -p option or PBPROJ environment variable)
438 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.
439 Conffile: home
440 Example: pbdefdir default = $ENV{'HOME'}/local/pb/projects
441
442=item B<pbinstalltype>
443
444 Nature: Mandatory
445 Key: project (as defined in the -p option or PBPROJ environment variable)
446 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.
447 Conffile: pb
448
449=item B<pbml>
450
451 Nature: Optional (Mandatory if using announce command)
452 Key: project (as defined in the -p option or PBPROJ environment variable)
453 Value: white space separated list of e-mail adresses used to send announces with the pb announce option.
454 Conffile: project
455 Example: pbml pb = pb-announce@project-builder.org pb-devel@project-builder.org
456
457=item B<pbpackager>
458
459 Nature: Mandatory
460 Key: project (as defined in the -p option or PBPROJ environment variable)
461 Value: Firstname Name and e-mail address of the person packaging the software.
462 Conffile: project
463 Example: pbpackager pb = Bruno Cornec <bruno@project-builder.org>
464
465=item B<pbparallel>
466
467 Nature: Optional
468 Key: tool (pb or rpmbootstrap)
469 Value: number of processes to execute in parallel. By default use the number of cores.
470 Conffile: pb
471 Example: pbparallel pb = 12
472
473=item B<pbpassfile>
474
475 Nature: Optional
476 Key: project (as defined in the -p option or PBPROJ environment variable)
477 Value: File containing the GPG passphrase that is used to sign packages
478 Conffile: home
479 Example: pbpassfile pb = /users/me/secret/passfile
480
481=item B<pbpasspath>
482
483 Nature: Optional
484 Key: project (as defined in the -p option or PBPROJ environment variable)
485 Value: The directory under which will be found your secret key file.
486 Conffile: home
487 Example: pbpasspath pb = /home/me/.gnupg
488
489=item B<pbpassphrase>
490
491 Nature: Optional
492 Key: project (as defined in the -p option or PBPROJ environment variable)
493 Value: The GPG passphrase that is used to sign packages. Putting it in your conf file has security implications.
494 Conffile: home
495 Example: pbpassphrase pb = TheSecretPassPhrase
496
497=item B<pbprojdir>
498
499 Nature: Optional
500 Key: project (as defined in the -p option or PBPROJ environment variable)
501 Value: local directory under which the project is locally exported. NB: a default value is highly interesting here. By default pbdefdir/projectname
502 Conffile: home
503 Example: pbprojdir mondorescue = $ENV{'HOME'}/local/mondorescue
504
505=item B<pbrepo>
506
507 Nature: Mandatory
508 Key: project (as defined in the -p option or PBPROJ environment variable)
509 Value: URL of the server hosting the upstream tar file.
510 Conffile: project
511 Example: pbrepo mondorescue = ftp://ftp.mondorescue.org
512
513=item B<pbsmtp>
514
515 Nature: Optional (Mandatory if using the announce command)
516 Key: project (as defined in the -p option or PBPROJ environment variable)
517 Value: FQDN of the mail server to use to send announces. NB: a default value is highly interesting here.
518 Conffile: home
519 Example: pbsmtp mondorescue = localhost
520
521=item B<pbsockscmd>
522
523 Nature: Optional
524 Key: project (as defined in the -p option or PBPROJ environment variable)
525 Value: name of the command to use to socksify network calls. NB: a default value is highly interesting here.
526 Conffile: home
527 Example: pbsockscmd default = tsocks
528
529=item B<pburl>
530
531 Nature: Optional
532 Key: project (as defined in the -p option or PBPROJ environment variable)
533 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
534 Conffile: home|project
535 Example: pburl linuxcoe = cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe, pburl pb = svk:////local/pb
536
537=item B<pbwf>
538
539 Nature: Optional
540 Key: project (as defined in the -p option or PBPROJ environment variable)
541 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.
542 Conffile: project
543 Example: pbwf afio = 1
544
545=item B<pkgtag>
546
547 Nature: Optional
548 Key: package (as provided in defpkgdir or extpkgdir)
549 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).
550 Conffile: project
551 Example: pkgtag mindi-busybox = 2
552
553=item B<pkgver>
554
555 Nature: Optional
556 Key: package (as provided in defpkgdir or extpkgdir)
557 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>.
558 Conffile: project
559 Example: pkgver mindi-busybox = 1.7.3
560
561=item B<projtag>
562
563 Nature: Mandatory
564 Key: project (as defined in the -p option or PBPROJ environment variable)
565 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>.
566 Conffile: project
567 Example: projtag mondorescue = 1
568
569=item B<projver>
570
571 Nature: Mandatory
572 Key: project (as defined in the -p option or PBPROJ environment variable)
573 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>.
574 Conffile: project
575 Example: projver mondorescue = 2.2.9
576
577=item B<rbsconf>
578
579 Nature: Optional
580 Key: project (as defined in the -p option or PBPROJ environment variable)
581 Value: for mock it's the configuration directory. For rinse it's its configuration file. For rpmbootstrap it's not used yet.
582 Conffile: ve
583 Example: rbsconf default = /etc/mock, rbsconf default = /etc/pb/pb-rinse.conf
584
585=item B<rbsb4pi>
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: 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.
590 Conffile: ve
591 Example: rbsb4pi centos = /home/rinse/bin/before-post-install.sh
592
593=item B<rbsopt>
594
595 Nature: Optional
596 Key: tool used for rpm based VE. Could be one of rpmbootstrap, rinse, mock, ...
597 Value: Additional option to pass to the command
598 Conffile: ve
599 Example: rbsopt rpmbootstrap = -k
600
601=item B<rbspi>
602
603 Nature: Optional
604 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.
605 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.
606 Conffile: ve
607 Example: rbspi centos = /home/rinse/bin/post-install.sh
608
609=item B<rmhost>
610
611 Nature: Mandatory
612 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.
613 Value: IP address or name of the Remote Machine running the OS mentioned in the key, accessed through ssh.
614 Conffile: rm
615 Example: rmhost default = localhost - rmhost hpux-11.3-ia64 = 10.10.10.10 - rmhost mandriva-2010.2-x86_64 = machine1.domain.name
616
617=item B<rmlist>
618
619 Nature: Mandatory
620 Key: project (as defined in the -p option or PBPROJ environment variable)
621 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.
622 Conffile: rm
623 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
624
625=item B<rmlogin>
626
627 Nature: Mandatory
628 Key: project (as defined in the -p option or PBPROJ environment variable)
629 Value: account name to use on the Remote Machine to build packages. Communication is done with ssh.
630 Conffile: rm
631 Example: rmlogin default = pb
632
633=item B<rmmonport>
634
635 Nature: Optional
636 Key: project (as defined in the -p option or PBPROJ environment variable)
637 Value: TCP port that is used to dialog with the monitor of the Remote Machine, to pass orders.
638 Conffile: rm
639 Example: rmmonport default = 4444
640
641=item B<rmntp>
642
643 Nature: Optional
644 Key: project (as defined in the -p option or PBPROJ environment variable)
645 Value: NTP server to contact for time accuracy with B<rmntpcmd> before building.
646 Conffile: rm
647 Example: rmntp default = 1.pool.ntp.org
648
649=item B<rmntpcmd>
650
651 Nature: Mandatory
652 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
653 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.
654 Conffile: rm
655 Example: rmntpcmd default = /usr/sbin/ntpdate,rmntpcmd opensuse-10.1-i386 = /usr/sbin/sntp -P no -r
656
657=item B<rmpath>
658
659 Nature: Mandatory
660 Key: project (as defined in the -p option or PBPROJ environment variable)
661 Value: path where to find configuration file for Remote Machines management.
662 Conffile: rm
663 Example: rmpath default = /home/remote
664
665=item B<rmport>
666
667 Nature: Mandatory
668 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
669 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.
670 Conffile: rm
671 Example: rmport pb = 2222,rmport mondorescue = 2223
672
673=item B<rmtmout>
674
675 Nature: Optional
676 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.
677 Value: Time in seconds to wait before interacting with the RM. This may correspond to the time the RM takes to boot.
678 Conffile: rm
679 Example: rmtmout default = 10
680
681=item B<rmtype>
682
683 Nature: Mandatory
684 Key: project (as defined in the -p option or PBPROJ environment variable)
685 Value: ssh. For the moment, only ssh is supported as a communication means with RM.
686 Conffile: rm
687 Example: rmrtype default = ssh
688
689=item B<sshdir>
690
691 Nature: Mandatory
692 Key: project (as defined in the -p option or PBPROJ environment variable)
693 Value: dirname into which packages are uploaded on the B<sshhost> machine.
694 Conffile: project
695 Example: sshdir mondorescue = /pub/mondorescue
696
697=item B<sshhost>
698
699 Nature: Mandatory
700 Key: project (as defined in the -p option or PBPROJ environment variable)
701 Value: hostname to connect to in order to deliver packages to the repository server.
702 Conffile: project
703 Example: sshhost mondorescue = ftp.mondorescue.org
704
705=item B<sshlogin>
706
707 Nature: Mandatory
708 Key: project (as defined in the -p option or PBPROJ environment variable)
709 Value: login to use when connecting to the repository server B<sshhost> for package delivery.
710 Conffile: project
711 Example: sshlogin mondorescue = mylogin
712
713=item B<sshport>
714
715 Nature: Mandatory
716 Key: project (as defined in the -p option or PBPROJ environment variable)
717 Value: port to use when connecting to the repository server B<sshhost> for package delivery.
718 Conffile: project
719 Example: sshport mondorescue = 22
720
721=item B<supfiles>
722
723Not used yet.
724
725=item B<testver>
726
727 Nature: Optional
728 Key: project (as defined in the -p option or PBPROJ environment variable)
729 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.
730 Conffile: project
731 Example: testver mondorescue = true
732
733=item B<vedebtype>
734
735 Nature: Mandatory
736 Key: project (as defined in the -p option or PBPROJ environment variable)
737 Value: debootstrap (no other tool to create deb distro based chroot)
738 Conffile: ve
739 Example: vedebtype default = debootstrap
740
741=item B<velist>
742
743 Nature: Mandatory
744 Key: project (as defined in the -p option or PBPROJ environment variable)
745 Value: list of coma separated OS (under the form of os-ver-arch).
746 Conffile: ve
747 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
748
749=item B<velogin>
750
751 Nature: Mandatory
752 Key: project (as defined in the -p option or PBPROJ environment variable)
753 Value: account name to use in the VE to build packages.
754 Conffile: ve
755 Example: velogin default = pb
756
757=item B<ventp>
758
759 Nature: Optional
760 Key: project (as defined in the -p option or PBPROJ environment variable)
761 Value: NTP server to contact for time accuracy with B<ventpcmd> before building.
762 Conffile: ve
763 Example: ventp default = 1.pool.ntp.org
764
765=item B<ventpcmd>
766
767 Nature: Mandatory
768 Key: project (as defined in the -p option or PBPROJ environment variable)
769 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.
770 Conffile: ve
771 Example: ventpcmd default = /usr/sbin/ntpdate
772
773=item B<vepath>
774
775 Nature: Mandatory
776 Key: project (as defined in the -p option or PBPROJ environment variable)
777 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.
778 Conffile: ve
779 Example: vepath default = /home/rpmbootstrap
780
781=item B<verebuild>
782
783 Nature: Optional
784 Key: project (as defined in the -p option or PBPROJ environment variable)
785 Value: true|false. True means that the VE should be rebuild before usage.
786 Conffile: ve
787 Example: verebuild default = true
788
789=item B<verpmtype>
790
791 Nature: Mandatory
792 Key: project (as defined in the -p option or PBPROJ environment variable)
793 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).
794 Conffile: ve
795 Example: verpmtype default = rpmbootstrap
796
797=item B<vesnap>
798
799 Nature: Optional
800 Key: project (as defined in the -p option or PBPROJ environment variable)
801 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.
802 Conffile: ve
803 Example: vesnap default = true
804
805=item B<vetype>
806
807 Nature: Mandatory
808 Key: project (as defined in the -p option or PBPROJ environment variable)
809 Value: chroot|schroot. There are two different ways of launching a chroot activity in pb. For the moment only chroot has been tested.
810 Conffile: ve
811 Example: vertype default = chroot
812
813=item B<vmbuildtm>
814
815 Nature: Optional
816 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
817 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.
818 Conffile: project
819 Example: vmbuildtm default = 600,vmbuildtm mandriva-2009.0-x86_64 = 1200
820
821=item B<vmcmd>
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). NB: a default value is highly interesting here.
825 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.
826 Conffile: vm
827 Example: vmcmd default = /usr/bin/kvm
828
829=item B<vmhost>
830
831 Nature: Mandatory
832 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
833 Value: hostname to connect to in order to reach the VM through ssh. Generally redirected from a port on localhost.
834 Conffile: vm
835 Example: vmhost default = localhost
836
837=item B<vmlist>
838
839 Nature: Mandatory
840 Key: project (as defined in the -p option or PBPROJ environment variable)
841 Value: list of coma separated OS (under the form of os-ver-arch).
842 Conffile: vm
843 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
844
845=item B<vmlogin>
846
847 Nature: Mandatory
848 Key: project (as defined in the -p option or PBPROJ environment variable)
849 Value: account name to use in the VM to build packages. Communication is done with ssh.
850 Conffile: vm
851 Example: vmlogin default = pb
852
853=item B<vmmem>
854
855 Nature: Optional
856 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
857 Value: Memory size in MB to allocate to the VM.
858 Conffile: vm
859 Example: vmmem default = 512
860
861=item B<vmmonport>
862
863 Nature: Optional
864 Key: project (as defined in the -p option or PBPROJ environment variable)
865 Value: TCP port that is used to dialog with the monitor of the VM, to pass orders such as snapshot. Not really operational yet.
866 Conffile: vm
867 Example: vmmonport default = 4444
868
869=item B<vmntp>
870
871 Nature: Optional
872 Key: project (as defined in the -p option or PBPROJ environment variable)
873 Value: NTP server to contact for time accuracy with B<vmntpcmd> before building.
874 Conffile: vm
875 Example: vmntp default = 1.pool.ntp.org
876
877=item B<vmntpcmd>
878
879 Nature: Mandatory
880 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
881 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.
882 Conffile: vm
883 Example: vmntpcmd default = /usr/sbin/ntpdate,vmntpcmd opensuse-11.0-i386 = /usr/sbin/sntp -P no -r
884
885=item B<vmopt>
886
887 Nature: Optional
888 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.
889 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.
890 Conffile: vm
891 Example: vmopt default = -m 384 -daemonize,vmopt mandriva-2009.0-i386 = -m 256 -daemonize -no-kvm
892
893=item B<vmpath>
894
895 Nature: Mandatory
896 Key: project (as defined in the -p option or PBPROJ environment variable)
897 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.
898 Conffile: vm
899 Example: vmpath default = /home/qemu
900
901=item B<vmport>
902
903 Nature: Mandatory
904 Key: project (as defined in the -p option or PBPROJ environment variable)
905 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.
906 Conffile: vm
907 Example: vmport pb = 2222,vmport mondorescue = 2223
908
909=item B<vmsize>
910
911 Nature: Mandatory
912 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
913 Value: Size of the VM to create when using the newvm command of pb.
914 Conffile: vm
915 Example: vmsize default = 7G
916
917=item B<vmsnap>
918
919 Nature: Optional
920 Key: project (as defined in the -p option or PBPROJ environment variable)
921 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.
922 Conffile: vm
923 Example: vmsnap default = true
924
925=item B<vmtmout>
926
927 Nature: Optional
928 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.
929 Value: Time in seconds to wait before interacting with the VM. This should correspond to the time the VM takes to boot.
930 Conffile: vm
931 Example: vmtmout default = 180,vmtmout mandriva-2009.0-x86_64 = 500
932
933=item B<vmtype>
934
935 Nature: Mandatory
936 Key: project (as defined in the -p option or PBPROJ environment variable)
937 Value: qemu|kvm. For the moment, only QEMU or KVM are supported as virtualization technologies.
938 Conffile: vm
939 Example: vmrtype default = kvm
940
941=item B<webdir>
942
943 Nature: Optional
944 Key: project (as defined in the -p option or PBPROJ environment variable)
945 Value: Target directory containing the web content in the project that should be delivered when using the sbx|cms2webssh|pkg command of pb.
946 Conffile: project
947 Example: webdir mondorescue = website
948
949=item B<websshdir>
950
951 Nature: Optional (when not using *2webssh commands)
952 Key: project (as defined in the -p option or PBPROJ environment variable)
953 Value: dirname into which content is uploaded on the B<websshhost> machine.
954 Conffile: project
955 Example: websshdir mondorescue = /var/www/html
956
957=item B<websshhost>
958
959 Nature: Optional (when not using *2webssh commands)
960 Key: project (as defined in the -p option or PBPROJ environment variable)
961 Value: hostname to connect to in order to deliver content to the Web server.
962 Conffile: project
963 Example: websshhost mondorescue = www.mondorescue.org
964
965=item B<websshlogin>
966
967 Nature: Optional (when not using *2webssh commands)
968 Key: project (as defined in the -p option or PBPROJ environment variable)
969 Value: login to use when connecting to the Web server B<websshhost> for content delivery.
970 Conffile: project
971 Example: websshlogin mondorescue = mylogin
972
973=item B<websshport>
974
975 Nature: Optional (when not using *2webssh commands)
976 Key: project (as defined in the -p option or PBPROJ environment variable)
977 Value: port to use when connecting to the Web server B<websshhost> for content delivery.
978 Conffile: project
979 Example: websshport mondorescue = 22
980
981=back
982
983=head1 OTHER PARAMETERS
984=item B<pb_URL>
985=item B<pb_directory_desc>
986=item B<pb_environment_variables>
Note: See TracBrowser for help on using the repository browser.