Skip to content

REFERENCE.md

Latest commit

 

History

History
186 lines (110 loc) · 5.12 KB

REFERENCE.md

File metadata and controls

186 lines (110 loc) · 5.12 KB

Reference

Table of Contents

Classes

  • sysctl: File:: init.pp Author:: UL HPC Management Team hpc-sysadmins@uni.lu Copyright:: Copyright (c) 2015 UL HPC Management Team
  • sysctl::common: File:: common.pp Author:: UL HPC Management Team hpc-sysadmins@uni.lu Copyright:: Copyright (c) 2015 UL HPC Management Tea
  • sysctl::common::debian: ------------------------------------------------------------------------------ = Class: sysctl::debian Specialization class for Debian syste
  • sysctl::common::redhat: ------------------------------------------------------------------------------ = Class: sysctl::redhat Specialization class for Redhat syste
  • sysctl::params: File:: params.pp Author:: UL HPC Management Team hpc-sysadmins@uni.lu Copyright:: Copyright (c) 2015 UL HPC Management Tea

Defined types

Classes

sysctl

File:: init.pp Author:: UL HPC Management Team hpc-sysadmins@uni.lu Copyright:: Copyright (c) 2015 UL HPC Management Team License:: GPLv3

= Class: sysctl

Configure and manage sysctl

== Parameters:

$ensure:: Default: 'present'. Ensure the presence (or absence) of sysctl

== Actions:

Install and configure sysctl

== Requires:

n/a

== Sample Usage:

include sysctl

You can then specialize the various aspects of the configuration, for instance:

    class { 'sysctl':
        ensure => 'present'
    }

== Warnings

/!\ Always respect the style guide available here[http://docs.puppetlabs.com/guides/style_guide]

[Remember: No empty lines between comments and class definition]

Parameters

The following parameters are available in the sysctl class:

ensure

Data type: Any

Default value: $sysctl::params::ensure

sysctl::common

File:: common.pp Author:: UL HPC Management Team hpc-sysadmins@uni.lu Copyright:: Copyright (c) 2015 UL HPC Management Team License:: GPLv3

= Class: sysctl::common

Base class to be inherited by the other sysctl classes

Note: respect the Naming standard provided here[http://projects.puppetlabs.com/projects/puppet/wiki/Module_Standards]

sysctl::common::debian

= Class: sysctl::debian

Specialization class for Debian systems

sysctl::common::redhat

= Class: sysctl::redhat

Specialization class for Redhat systems

sysctl::params

File:: params.pp Author:: UL HPC Management Team hpc-sysadmins@uni.lu Copyright:: Copyright (c) 2015 UL HPC Management Team License:: GPL v3

= Class: sysctl::params

In this class are defined as variables values that are used in other sysctl classes. This class should be included, where necessary, and eventually be enhanced with support for more OS

== Warnings

/!\ Always respect the style guide available here[http://docs.puppetlabs.com/guides/style_guide]

The usage of a dedicated param classe is advised to better deal with parametrized classes, see http://docs.puppetlabs.com/guides/parameterized_classes.html

[Remember: No empty lines between comments and class definition]

Defined types

sysctl::value

File:: value.pp Author:: UL HPC Management Team hpc-sysadmins@uni.lu Copyright:: Copyright (c) 2015 UL HPC Management Team License:: GPLv3

= Define: sysctl::value

Defines kernel parameter with sysctl. You should use as name the actual name of the parameter.

== Parameter:

[value]: Value of the parameter

= Usage:

     sysctl::value { "net.bridge.bridge-nf-call-iptables":
           value => '0'
     }

== Warnings

/!\ Always respect the style guide available here[http://docs.puppetlabs.com/guides/style_guide]

[Remember: No empty lines between comments and class definition]

Parameters

The following parameters are available in the sysctl::value defined type:

value

Data type: Any

ensure

Data type: Any

Default value: $sysctl::params::ensure