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

Last change on this file since 1348 was 1348, checked in by bruno, 8 years ago

r4374@localhost: bruno | 2011-10-25 12:10:59 +0200

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