Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 3.0.0
- , , ,
This module has been deprecated by its author since Dec 7th 2017.
The author has suggested puppet-virtualbox as its replacement.
Start using this module
Documentation
THIS MODULE HAS BEEN MOVED TO VOXPUPULI
This module has been donated to Vox Pupuli and can be found at https://github.com/voxpupuli/puppet-virtualbox.
This module installs VirtualBox on a Linux host using the official repositories or custom defined repositories. By default, this module will also configure the kernel modules required to run VirtualBox.
By default, this module will install the Oracle VirtualBox yum/apt repo (see the Note for Debian/Ubuntu Users using Puppet < 3.0.0 below), install the VirtualBox package, and build the VirtualBox kernel modules. You can define a custom package name and/or version, you can also opt to not manage the repositories with this module. Because of the strange convention Oracle has opted to use for versioning VirtualBox, if you set a custom package name, the version
parameter will be ignored. If you wish to define a package version with a custom package name, you must use the package_ensure
parameter.
Support
This module is tested with:
- CentOS 5.11
- CentOS 6.6
- CentOS 7.0
- Debian 6.0.10
- Debian 7.8
- Ubuntu 10.04
- Ubuntu 12.04
- Ubuntu 14.04
It may work on other distros and OS versions, but these are the versions that we're targeting. If you wish to see another distro/version added to this list, so would we! PRs are welcome :)
This module is tested with the latest version of Puppet 2.7 as well as all minor versions of Puppet 3 and Puppet 4; all Puppet supported versions of Ruby are included in the test matrix. If you're interested in the testing matrix, please have a look at the .travis.yml
file in the root of the module.
Usage
To begin using the virtualbox module, just include the virtualbox class on your node like so:
include virtualbox
This will get you set up with the basics and will meet 90% of the use cases out there.
If you wish to manage your package repositories outside of this module, you just need to set $manage_repo
to false
:
class { 'virtualbox':
manage_repo => false,
}
You can also specify a custom package name like so:
class { 'virtualbox':
manage_repo => false,
package_name => 'virtualbox-custom',
}
The peculiar versioning in use by Oracle has forced us to do some funky stuff with versioning. If you're using the default package name, this module will concatenate $package_name
and $version
together with a dash between them. If you opt to define your own package name, the $version
parameter is ignored completely and the only way to specify a version would be to use the $package_ensure
parameter:
class { 'virtualbox':
manage_repo => false,
package_name => 'virtualbox-custom',
package_ensure => '4.3.18_96516',
}
If you don't want to install the VirtualBox kernel extensions, you can set the manage_kernel
parameter to false
.
class { 'virtualbox':
manage_kernel => false,
}
You can also opt to not manage the package with the manage_package
parameter. This would effectively just install the package repository:
class { 'virtualbox':
manage_kernel => false,
manage_package => false,
}
Extension Pack
NOTE: To use this feature, you must have either camptocamp/archive or puppet/archive installed.
There's a defined type to install an Extension Pack. I'm not aware of any extension packs other than the Oracle Extension Pack, but this type should work for third party extensions. You can install Oracle's Extension Pack (adding support for USB 2.0, access to webcam, RDP and E1000 PXE ROM) like so:
virtualbox::extpack { 'Oracle_VM_VirtualBox_Extension_Pack':
ensure => present,
source => 'http://download.virtualbox.org/virtualbox/4.3.20/Oracle_VM_VirtualBox_Extension_Pack-4.3.20.vbox-extpack',
checksum_string => '4b7546ddf94308901b629865c54d5840',
follow_redirects => true,
}
This will download the extension pack, check to make sure the downloaded file matches the expected md5sum, then install the extension pack to /usr/lib/virtualbox/ExtensionPacks
.
Note for Debian/Ubuntu Users using Puppet < 3.0.0
This module depends on puppetlabs/apt
>= 2.1.0 which has dropped support for Puppet < 3.0.0. While this module is still compatible with Puppet 2.7 and above, Debian/Ubuntu users on Puppet < 3.0.0 will no longer be able to manage the VirtualBox repository with this module. The default manage_repo
setting for Debian/Ubuntu with Puppet < 3.0.0 is false
, but remains true
for all other puppetversion
and operatingsystemversion
combinations. Unfortunately, I am not able to express this nuance in the module metadata, so these users will need to work around the dependency resolution in the puppet module
tool. I apologize for the inconvenience.
Development
- Fork it
- Create a feature branch
- Write a failing test
- Write the code to make that test pass
- Refactor the code
- Submit a pull request
We politely request (demand) tests for all new features. Pull requests that contain new features without a test will not be considered. If you need help, just ask!
Change log
All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.
Unreleased
1.7.1 - 2016-07-19
Fixed
- Fixed a typo in
extpack
that prevented proper detection of thearchive
module. - Fixing missing APT keys for newer Debian/Ubuntu versions.
- Fixes typo in
spec/classes/virtualbox_spec.rb
1.7.0 - 2016-04-07
Added
- Added the ability to use either
camptocamp/archive
orpuppet/archive
Changed
- Changed the default VirtualBox version to
5.0
Fixed
1.6.0 - 2015-12-14
Added
- Parameterized the
vboxdrv
command invirtualbox::kernel
1.5.0 - 2015-08-26
Added
- Added repo_proxy parameter to the
virtualbox
andvirtualbox::install
classes. Currently only implemented on RedHat-like systems.
Changed
- Changed the default Puppet version in
Gemfile
to ~> 4.2 - Changed Ruby versions in
.travis.yml
from '2.1.0' and '2.0.0' to '2.1' and '2.0' respectively so we're testing with the most recent patchlevel - Added the Puppet 3.8 series to the test matrix in
.travis.yml
- Changed the
apt::key
resource to use the 40-character signature. Closes #19
1.4.0 - 2015-07-01
Deprecated
- Deprecated support for Puppet < 4.0.0.
Changed
- Bump the puppetlabs/apt dependency to >=2.1.0 so we can have support for Puppet < 3.5.0 again.
- Changed the default behavior for Debian/Puppet >= 3.0.0 combinations to manage the virtualbox repository.
- Updated
rspec
syntax fromshould
toexpect
.
Removed
- Removed the warnings for Debian/Puppet < 3.5.0.
Added
- Added provisional support for Fedora.
- Added warnings for Debian/Puppet < 3.0.0.
1.3.1 - 2015-04-26
Changed
- Fixed CHANGELOG headings.
1.3.0 - 2015-04-26
Changed
- Now depends on puppetlabs/apt >=2.0. This means that users of Puppet < 3.5.0 will need to manage their own repositories since puppetlabs/apt is only compatible with Puppet >= 3.5.0. This has necessitated a change in default behavior. Now, the default setting for
manage_repo
is false if thepuppetversion
fact is < 3.5.0. Unfortunately, I can't express this in the module dependencies inmetadata.json
so users will have to work around this. - More meaningful error messages when an operating system is not supported.
- Changed the
rspec-puppet
upstream inGemfile
to pull fromrubygems.org
instead of GitHub. - Bound the version requirement for
camptocamp/archive
< 1.0.0. - Cleaned up the Beaker node sets.
Added
- Now formally supports Puppet 4.0.
- Added a
manage_epel
parameter so you can now disable or enable the EPEL repo separately from the VirtualBox repo. - Added CentOS 6.6 and 5.11 to the beaker nodesets. Updated the documentation to reflect this.
- Experimental support for OpenSuSE added. There are plenty of caveats here, so this is not officially supported.
Removed
- Removed future parser tests from
.travis.yml
- This module no longer manages the
debian-keyring
anddebian-archive-keyring
packages as part of theapt::source
resource.
1.2.1 - 2015-02-07
Changed
- Added the
strings
tasks to theRakefile
and made generated documentation available via GitHub pages. - Fixed some whitespace issues in
README.md
. - Simplified the
.travis.yml
layout by moving the environment variables in theinclude
section to one line. - Added the
yard
gem to theGemfile
for generating documentation with Puppet Strings.
1.2.0 - 2015-01-31
Changed
- Updated
README.md
to documentvirtualbox::extpack
. - Refactored the way facts are handled in
spec/classes/virtualbox_spec.rb
. - Changed the default
PUPPET_VERSION
inGemfile
to~> 3.7.0
. - Use the flat-style badges in
README.md
. - Renamed
spec/acceptance/class_spec.rb
tospec/acceptance/virtualbox_spec.rb
.
Added
- Added the
virtualbox::extpack
defined type to manage VirtualBox Extension Packs. - Added acceptance tests for
virtualbox::extpack
. - Added a dependency on
camptocamp/archive
forvirtualbox::extpack
.
1.1.0 - 2014-12-19
Changed
- Added Puppet 3.7 to the test matrix in
travis.yml
. - Added support for testing the future parser in
spec/spec_helper.rb
. - Added future parser tests in
travis.yml
. - Updated
README.md
to note the test matrix. - Start using the new build environments in Travis.
- Pinned
rspec-puppet
to version 2.0.0 inGemfile
.
Added
- Added support for CentOS 7. There were no code changes required to support this, but I added a CentOS 7 node to the
beaker
tests to validate CentOS 7 compatability.
1.0.4 - 2014-12-09
Changed
- Update
README.md
to note all supported operating systems. - Clean up
metadata.json
in response to the Forge quality ratings.
1.0.3 - 2014-10-21
Changed
- Add the
json
andmetadata-json-lint
gems toGemfile
. - Add
metadata-json-lint
rake task toRakefile
and incorporate it into thetest
task. - Update the dependencies in
metadata.json
and cleanup lint in the metadata. - Tweak the spacing in
spec/acceptance/class_spec.rb
. - Add
nodesets
for Debian 6 & 7 and Ubuntu 10.04. - Use the
install_puppet
helper for acceptance tests.
1.0.2 - 2014-10-15
Changed
- Refactored the
virtualbox_version
fact to only execute if/usr/bin/VBoxManage
exists. - Refactor the acceptance tests to use new
its
syntax.
1.0.1 - 2014-10-14
Changed
- Added the Forge badge to
README.md
. - Deleted the
Vagrantfile
, not sure how this made it in here anyway. - Added some tags to the
metadata.json
file.
1.0.0 - 2014-10-13
Initial Release
Dependencies
- puppetlabs/stdlib (>=4.8.0 <5.0.0)
- puppetlabs/apt (>=2.1.0 <3.0.0)
- stahnma/epel (>=0.0.6 <2.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: 1. You must give any other recipients of the Work or Derivative Works a copy of this License; and 2. You must cause any modified files to carry prominent notices stating that You changed the files; and 3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and 4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2013 Gareth Rushgrove Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.