-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
232 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,232 @@ | ||
# Reference | ||
|
||
<!-- DO NOT EDIT: This document was generated by Puppet Strings --> | ||
|
||
## Table of Contents | ||
|
||
### Classes | ||
|
||
#### Public Classes | ||
|
||
|
||
#### Private Classes | ||
|
||
* `pbuilder::common`: Manage generic resources for pbuilder | ||
* `pbuilder::cowbuilder::common`: Basic installation of cowbuilder | ||
|
||
### Defined types | ||
|
||
#### Public Defined types | ||
|
||
* [`pbuilder`](#pbuilder): Provide a pbuilder resource. | ||
* [`pbuilder::cowbuilder`](#pbuildercowbuilder): Manage a cowbuilder environment | ||
|
||
#### Private Defined types | ||
|
||
* `pbuilder::apt::preferences`: Manage preferences for a pbuilder setup | ||
* `pbuilder::apt::sources_list`: Manage sources.list for a pbuilder setup | ||
|
||
## Classes | ||
|
||
## Defined types | ||
|
||
### <a name="pbuilder"></a>`pbuilder` | ||
|
||
Provide a pbuilder resource. | ||
|
||
#### Examples | ||
|
||
##### Set a pbuilder using the release and architecture of the host | ||
|
||
```puppet | ||
pbuilder { 'focal': | ||
methodurl => 'http://archive.ubuntu.com/ubuntu', | ||
} | ||
``` | ||
|
||
##### Destroy an old existing pbuilder | ||
|
||
```puppet | ||
pbuilder { 'jessie': | ||
ensure => absent, | ||
} | ||
``` | ||
|
||
##### Set an am64 pbuilder for the etch release, including sources in the .changes | ||
|
||
```puppet | ||
pbuilder { 'buster-amd64': | ||
release => buster, | ||
methodurl => 'http://deb.debian.org/debian', | ||
debbuildopts => "-sa", | ||
} | ||
``` | ||
|
||
#### Parameters | ||
|
||
The following parameters are available in the `pbuilder` defined type: | ||
|
||
* [`ensure`](#ensure) | ||
* [`release`](#release) | ||
* [`arch`](#arch) | ||
* [`methodurl`](#methodurl) | ||
* [`debbuildopts`](#debbuildopts) | ||
* [`bindmounts`](#bindmounts) | ||
* [`bindir`](#bindir) | ||
* [`chrootdir`](#chrootdir) | ||
* [`cachedir`](#cachedir) | ||
* [`confdir`](#confdir) | ||
* [`rctemplate`](#rctemplate) | ||
|
||
##### <a name="ensure"></a>`ensure` | ||
|
||
Data type: `Enum['present', 'absent']` | ||
|
||
Whether the pbuilder should be present | ||
|
||
Default value: `'present'` | ||
|
||
##### <a name="release"></a>`release` | ||
|
||
Data type: `String[1]` | ||
|
||
The Debian/Ubuntu release to be used (Buster, Bionic, etc) | ||
|
||
Default value: `$lsbdistcodename` | ||
|
||
##### <a name="arch"></a>`arch` | ||
|
||
Data type: `String[1]` | ||
|
||
The architecture of the pbuilder (i386, amd64, etc.) | ||
|
||
Default value: `$architecture` | ||
|
||
##### <a name="methodurl"></a>`methodurl` | ||
|
||
Data type: `Optional[String[1]]` | ||
|
||
The URL used to grab the packages from | ||
(e.g. http://deb.debian.org/debian) | ||
|
||
Default value: ``undef`` | ||
|
||
##### <a name="debbuildopts"></a>`debbuildopts` | ||
|
||
Data type: `String` | ||
|
||
The options to send to debuild (see `man dpkg-buildpackage`) | ||
|
||
Default value: `'-b'` | ||
|
||
##### <a name="bindmounts"></a>`bindmounts` | ||
|
||
Data type: `Optional[String[1]]` | ||
|
||
A list of space-separated directories to bind-mount in the chroot | ||
|
||
Default value: ``undef`` | ||
|
||
##### <a name="bindir"></a>`bindir` | ||
|
||
Data type: `Stdlib::Absolutepath` | ||
|
||
Where to put the pbuilder script | ||
|
||
Default value: `'/usr/local/bin'` | ||
|
||
##### <a name="chrootdir"></a>`chrootdir` | ||
|
||
Data type: `Stdlib::Absolutepath` | ||
|
||
Where to put the basetgz tarball | ||
|
||
Default value: `'/var/chroot/pbuilder'` | ||
|
||
##### <a name="cachedir"></a>`cachedir` | ||
|
||
Data type: `Stdlib::Absolutepath` | ||
|
||
Where to create the aptcache, build and result directories | ||
|
||
Default value: `'/var/cache/pbuilder'` | ||
|
||
##### <a name="confdir"></a>`confdir` | ||
|
||
Data type: `Stdlib::Absolutepath` | ||
|
||
Where to store the configuration for the script | ||
|
||
Default value: `'/etc/pbuilder'` | ||
|
||
##### <a name="rctemplate"></a>`rctemplate` | ||
|
||
Data type: `String[1]` | ||
|
||
The pbuilderrc ERB template to use | ||
|
||
Default value: `'pbuilder/pbuilderrc.erb'` | ||
|
||
### <a name="pbuildercowbuilder"></a>`pbuilder::cowbuilder` | ||
|
||
Manage a cowbuilder environment | ||
|
||
#### Parameters | ||
|
||
The following parameters are available in the `pbuilder::cowbuilder` defined type: | ||
|
||
* [`ensure`](#ensure) | ||
* [`dist`](#dist) | ||
* [`arch`](#arch) | ||
* [`cachedir`](#cachedir) | ||
* [`confdir`](#confdir) | ||
* [`pbuilderrc`](#pbuilderrc) | ||
|
||
##### <a name="ensure"></a>`ensure` | ||
|
||
Data type: `Enum['present', 'absent']` | ||
|
||
Whether the pbuilder should be present | ||
|
||
Default value: `'present'` | ||
|
||
##### <a name="dist"></a>`dist` | ||
|
||
Data type: `String[1]` | ||
|
||
The Debian/Ubuntu release to be used (Buster, Bionic, etc) | ||
|
||
Default value: `$facts['os']['distro']['codename']` | ||
|
||
##### <a name="arch"></a>`arch` | ||
|
||
Data type: `String[1]` | ||
|
||
The architecture of the pbuilder (i386, amd64, etc.) | ||
|
||
Default value: `$facts['os']['architecture']` | ||
|
||
##### <a name="cachedir"></a>`cachedir` | ||
|
||
Data type: `Stdlib::Absolutepath` | ||
|
||
Where to create the aptcache, build and result directories | ||
|
||
Default value: `'/var/cache/pbuilder'` | ||
|
||
##### <a name="confdir"></a>`confdir` | ||
|
||
Data type: `Stdlib::Absolutepath` | ||
|
||
Where to store the configuration for the script | ||
|
||
Default value: `'/etc/pbuilder'` | ||
|
||
##### <a name="pbuilderrc"></a>`pbuilderrc` | ||
|
||
Data type: `Optional[String[1]]` | ||
|
||
The pbuilderrc content | ||
|
||
Default value: ``undef`` | ||
|