https://github.com/ulhpc/puppet-kernel
Configure various aspects of Linux kernel (modules etc.)
https://github.com/ulhpc/puppet-kernel
Last synced: about 1 year ago
JSON representation
Configure various aspects of Linux kernel (modules etc.)
- Host: GitHub
- URL: https://github.com/ulhpc/puppet-kernel
- Owner: ULHPC
- License: other
- Created: 2015-06-17T14:57:41.000Z (almost 11 years ago)
- Default Branch: devel
- Last Pushed: 2024-06-24T16:42:06.000Z (almost 2 years ago)
- Last Synced: 2025-03-28T11:51:07.522Z (about 1 year ago)
- Language: Puppet
- Size: 46.9 KB
- Stars: 1
- Watchers: 9
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing/index.md
- License: LICENSE
Awesome Lists containing this project
README
-*- mode: markdown; mode: visual-line; -*-
# Kernel Puppet Module
[](https://forge.puppetlabs.com/ULHPC/kernel)
[](LICENSE)
[](https://readthedocs.org/projects/ulhpc-puppet-kernel/?badge=latest)
Configure various aspects of Linux kernel (modules etc.)
Copyright (c) 2015 S. Varrette, H. Cartiaux, V. Plugaru, S. Diehl aka. UL HPC Management Team
| [Project Page](https://github.com/ULHPC/puppet-kernel) | [Sources](https://github.com/ULHPC/puppet-kernel) | [Documentation](https://ulhpc-puppet-kernel.readthedocs.org/en/latest/) | [Issues](https://github.com/ULHPC/puppet-kernel/issues) |
## Synopsis
Configure various aspects of Linux kernel (modules etc.).
This module implements the following elements:
* __Puppet classes__:
- `kernel`
- `kernel::common`
- `kernel::common::debian`
- `kernel::common::redhat`
- `kernel::params`
* __Puppet definitions__:
- `kernel::module`
All these components are configured through a set of variables you will find in
[`manifests/params.pp`](manifests/params.pp).
_Note_: the various operations that can be conducted from this repository are piloted from a [`Rakefile`](https://github.com/ruby/rake) and assumes you have a running [Ruby](https://www.ruby-lang.org/en/) installation.
See `docs/contributing.md` for more details on the steps you shall follow to have this `Rakefile` working properly.
## Dependencies
See [`metadata.json`](metadata.json). In particular, this module depends on
* [puppetlabs/stdlib](https://forge.puppetlabs.com/puppetlabs/stdlib)
## Overview and Usage
### Class `kernel`
This is the main class defined in this module.
It accepts the following parameters:
* `$ensure`: default to 'present', can be 'absent'
Use it as follows:
include ' kernel'
See also [`tests/init.pp`](tests/init.pp)
### Definition `kernel::module`
The definition `kernel::module` provides ...
This definition accepts the following parameters:
* `$ensure`: default to 'present', can be 'absent'
* `$content`: specify the contents of the directive as a string
* `$source`: copy a file as the content of the directive.
Example:
kernel::module { 'toto':
ensure => 'present',
}
See also [`tests/module.pp`](tests/module.pp)
## Librarian-Puppet / R10K Setup
You can of course configure the kernel module in your `Puppetfile` to make it available with [Librarian puppet](http://librarian-puppet.com/) or
[r10k](https://github.com/adrienthebo/r10k) by adding the following entry:
# Modules from the Puppet Forge
mod "ULHPC/kernel"
or, if you prefer to work on the git version:
mod "ULHPC/kernel",
:git => 'https://github.com/ULHPC/puppet-kernel',
:ref => 'production'
## Issues / Feature request
You can submit bug / issues / feature request using the [ULHPC/kernel Puppet Module Tracker](https://github.com/ULHPC/puppet-kernel/issues).
## Developments / Contributing to the code
If you want to contribute to the code, you shall be aware of the way this module is organized.
These elements are detailed on [`docs/contributing.md`](contributing/index.md).
You are more than welcome to contribute to its development by [sending a pull request](https://help.github.com/articles/using-pull-requests).
## Puppet modules tests within a Vagrant box
The best way to test this module in a non-intrusive way is to rely on [Vagrant](http://www.vagrantup.com/).
The `Vagrantfile` at the root of the repository pilot the provisioning various vagrant boxes available on [Vagrant cloud](https://atlas.hashicorp.com/boxes/search?utf8=%E2%9C%93&sort=&provider=virtualbox&q=svarrette) you can use to test this module.
See [`docs/vagrant.md`](vagrant.md) for more details.
## Online Documentation
[Read the Docs](https://readthedocs.org/) aka RTFD hosts documentation for the open source community and the [ULHPC/kernel](https://github.com/ULHPC/puppet-kernel) puppet module has its documentation (see the `docs/` directly) hosted on [readthedocs](http://ulhpc-puppet-kernel.rtfd.org).
See [`docs/rtfd.md`](rtfd.md) for more details.
## Licence
This project and the sources proposed within this repository are released under the terms of the [GPL-3.0](LICENCE) licence.
[](LICENSE)