other/Puppet: modules/inifile/README.md annotate

annotate modules/inifile/README.md @ 482:d83de9b3a62b default tip

Update hiera.yaml within Puppet config Forgot that we manage it from here. Now has content to match new packages

author	IBBoard <dev@ibboard.co.uk>
date	Fri, 30 Aug 2024 16:10:36 +0100
parents	adf6fe9bbc17
children

rev	line source
386 3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1 # inifile
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	2
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	3 #### Table of Contents
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	4
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	5 1. [Overview](#overview)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	6 1. [Module Description - What the module does and why it is useful](#module-description)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	7 1. [Setup - The basics of getting started with inifile module](#setup)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	8 1. [Usage - Configuration options and additional functionality](#usage)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	9 1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	10 1. [Limitations - OS compatibility, etc.](#limitations)
478 adf6fe9bbc17 Update Puppet modules to latest versions IBBoard <dev@ibboard.co.uk> parents: 386 diff changeset	11 1. [License](#license)
386 3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	12 1. [Development - Guide for contributing to the module](#development)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	13
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	14 <a id="overview"></a>
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	15 ## Overview
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	16
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	17 The inifile module lets Puppet manage settings stored in INI-style configuration files.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	18
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	19 <a id="module-description"></a>
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	20 ## Module Description
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	21
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	22 Many applications use INI-style configuration files to store their settings. This module supplies two custom resource types to let you manage those settings through Puppet.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	23
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	24 <a id="setup"></a>
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	25 ## Setup
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	26
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	27 ### Beginning with inifile
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	28
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	29 To manage a single setting in an INI file, add the `ini_setting` type to a class:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	30
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	31 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	32 ini_setting { "sample setting":
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	33 ensure => present,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	34 path => '/tmp/foo.ini',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	35 section => 'bar',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	36 setting => 'baz',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	37 value => 'quux',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	38 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	39 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	40
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	41 <a id="usage"></a>
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	42 ## Usage
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	43
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	44
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	45 The inifile module is used to:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	46
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	47 * Support comments starting with either '#' or ';'.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	48 * Support either whitespace or no whitespace around '='.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	49 * Add any missing sections to the INI file.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	50
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	51 It does not manipulate your file any more than it needs to. In most cases, it doesn't affect the original whitespace, comments, or ordering. See the common usages below for examples.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	52
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	53 ### Manage multiple values in a setting
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	54
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	55 Use the `ini_subsetting` type:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	56
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	57 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	58 ini_subsetting {'sample subsetting':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	59 ensure => present,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	60 section => '',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	61 key_val_separator => '=',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	62 path => '/etc/default/pe-puppetdb',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	63 setting => 'JAVA_ARGS',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	64 subsetting => '-Xmx',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	65 value => '512m',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	66 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	67 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	68
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	69 Results in managing this `-Xmx` subsetting:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	70
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	71 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	72 JAVA_ARGS="-Xmx512m -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/var/log/pe-puppetdb/puppetdb-oom.hprof"
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	73 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	74
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	75
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	76 ### Use a non-standard section header
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	77
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	78 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	79 ini_setting { 'default minage':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	80 ensure => present,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	81 path => '/etc/security/users',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	82 section => 'default',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	83 setting => 'minage',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	84 value => '1',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	85 section_prefix => '',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	86 section_suffix => ':',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	87 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	88 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	89
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	90 Results in:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	91
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	92 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	93 default:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	94 minage = 1
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	95 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	96
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	97 ### Use a non-standard indent character
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	98
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	99 To use a non-standard indent character or string for added settings, set the `indent_char` and the `indent_width` parameters. The `indent_width` parameter controls how many `indent_char` appear in the indent.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	100
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	101
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	102 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	103 ini_setting { 'procedure cache size':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	104 ensure => present,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	105 path => '/var/lib/ase/config/ASE-16_0/SYBASE.cfg',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	106 section => 'SQL Server Administration',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	107 setting => 'procedure cache size',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	108 value => '15000',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	109 indent_char => "\t",
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	110 indent_width => 2,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	111 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	112 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	113
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	114 Results in:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	115
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	116 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	117 [SQL Server Administration]
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	118 procedure cache size = 15000
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	119 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	120
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	121 ### Implement child providers
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	122
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	123 You might want to create child providers that inherit the `ini_setting` provider for one of the following reasons:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	124
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	125 * To make a custom resource to manage an application that stores its settings in INI files, without recreating the code to manage the files themselves.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	126 * To [purge all unmanaged settings](https://docs.puppetlabs.com/references/latest/type.html#resources-attribute-purge) from a managed INI file.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	127
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	128 To implement child providers, first specify a custom type. Have it implement a namevar called `name` and a property called `value`:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	129
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	130 ~~~ruby
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	131 #my_module/lib/puppet/type/glance_api_config.rb
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	132 Puppet::Type.newtype(:glance_api_config) do
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	133 ensurable
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	134 newparam(:name, :namevar => true) do
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	135 desc 'Section/setting name to manage from glance-api.conf'
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	136 # namevar should be of the form section/setting
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	137 newvalues(/\S+\/\S+/)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	138 end
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	139 newproperty(:value) do
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	140 desc 'The value of the setting to define'
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	141 munge do \|v\|
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	142 v.to_s.strip
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	143 end
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	144 end
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	145 end
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	146 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	147
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	148 Your type also needs a provider that uses the `ini_setting` provider as its parent:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	149
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	150 ~~~ruby
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	151 # my_module/lib/puppet/provider/glance_api_config/ini_setting.rb
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	152 Puppet::Type.type(:glance_api_config).provide(
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	153 :ini_setting,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	154 # set ini_setting as the parent provider
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	155 :parent => Puppet::Type.type(:ini_setting).provider(:ruby)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	156 ) do
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	157 # implement section as the first part of the namevar
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	158 def section
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	159 resource[:name].split('/', 2).first
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	160 end
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	161 def setting
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	162 # implement setting as the second part of the namevar
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	163 resource[:name].split('/', 2).last
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	164 end
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	165 # hard code the file path (this allows purging)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	166 def self.file_path
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	167 '/etc/glance/glance-api.conf'
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	168 end
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	169 end
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	170 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	171
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	172 Now you can manage the settings in the `/etc/glance/glance-api.conf` file as individual resources:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	173
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	174 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	175 glance_api_config { 'HEADER/important_config':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	176 value => 'secret_value',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	177 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	178 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	179
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	180 If you've implemented `self.file_path`, you can have Puppet purge the file of the all lines that aren't implemented as Puppet resources:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	181
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	182 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	183 resources { 'glance_api_config':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	184 purge => true,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	185 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	186 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	187
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	188 ### Manage multiple ini_settings
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	189
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	190 To manage multiple `ini_settings`, use the [`inifile::create_ini_settings`](REFERENCE.md#inifilecreate_ini_settings) function.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	191
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	192 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	193 $defaults = { 'path' => '/tmp/foo.ini' }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	194 $example = { 'section1' => { 'setting1' => 'value1' } }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	195 inifile::create_ini_settings($example, $defaults)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	196 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	197
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	198 Results in:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	199
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	200 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	201 ini_setting { '[section1] setting1':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	202 ensure => present,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	203 section => 'section1',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	204 setting => 'setting1',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	205 value => 'value1',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	206 path => '/tmp/foo.ini',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	207 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	208 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	209
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	210 To include special parameters, use the following code:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	211
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	212 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	213 $defaults = { 'path' => '/tmp/foo.ini' }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	214 $example = {
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	215 'section1' => {
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	216 'setting1' => 'value1',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	217 'settings2' => {
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	218 'ensure' => 'absent'
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	219 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	220 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	221 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	222 inifile::create_ini_settings($example, $defaults)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	223 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	224
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	225 Results in:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	226
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	227 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	228 ini_setting { '[section1] setting1':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	229 ensure => present,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	230 section => 'section1',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	231 setting => 'setting1',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	232 value => 'value1',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	233 path => '/tmp/foo.ini',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	234 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	235 ini_setting { '[section1] setting2':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	236 ensure => absent,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	237 section => 'section1',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	238 setting => 'setting2',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	239 path => '/tmp/foo.ini',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	240 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	241 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	242
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	243 #### Manage multiple ini_settings with Hiera
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	244
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	245 For the profile `example`:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	246
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	247 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	248 class profile::example (
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	249 Hash $settings,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	250 ) {
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	251 $defaults = { 'path' => '/tmp/foo.ini' }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	252 inifile::create_ini_settings($settings, $defaults)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	253 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	254 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	255
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	256 Provide this in your Hiera data:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	257
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	258 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	259 profile::example::settings:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	260 section1:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	261 setting1: value1
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	262 setting2: value2
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	263 setting3:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	264 ensure: absent
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	265 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	266
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	267 Results in:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	268
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	269 ~~~puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	270 ini_setting { '[section1] setting1':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	271 ensure => present,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	272 section => 'section1',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	273 setting => 'setting1',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	274 value => 'value1',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	275 path => '/tmp/foo.ini',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	276 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	277 ini_setting { '[section1] setting2':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	278 ensure => present,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	279 section => 'section1',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	280 setting => 'setting2',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	281 value => 'value2',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	282 path => '/tmp/foo.ini',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	283 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	284 ini_setting { '[section1] setting3':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	285 ensure => absent,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	286 section => 'section1',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	287 setting => 'setting3',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	288 path => '/tmp/foo.ini',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	289 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	290 ~~~
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	291
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	292 <a id="reference"></a>
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	293 ## Reference
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	294 See [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-inifile/blob/main/REFERENCE.md)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	295
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	296 <a id="limitations"></a>
478 adf6fe9bbc17 Update Puppet modules to latest versions IBBoard <dev@ibboard.co.uk> parents: 386 diff changeset	297
386 3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	298 ## Limitations
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	299
478 adf6fe9bbc17 Update Puppet modules to latest versions IBBoard <dev@ibboard.co.uk> parents: 386 diff changeset	300 ### Supported operating systems
adf6fe9bbc17 Update Puppet modules to latest versions IBBoard <dev@ibboard.co.uk> parents: 386 diff changeset	301
386 3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	302 For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-inifile/blob/main/metadata.json)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	303
478 adf6fe9bbc17 Update Puppet modules to latest versions IBBoard <dev@ibboard.co.uk> parents: 386 diff changeset	304 ### create_ini_settings
adf6fe9bbc17 Update Puppet modules to latest versions IBBoard <dev@ibboard.co.uk> parents: 386 diff changeset	305
adf6fe9bbc17 Update Puppet modules to latest versions IBBoard <dev@ibboard.co.uk> parents: 386 diff changeset	306 When using inifile::create_ini_settings it’s worth noting that namespace tags will not be applied to the resource. If you need these namespace tags we advise using the standard ini_setting resource.
adf6fe9bbc17 Update Puppet modules to latest versions IBBoard <dev@ibboard.co.uk> parents: 386 diff changeset	307
adf6fe9bbc17 Update Puppet modules to latest versions IBBoard <dev@ibboard.co.uk> parents: 386 diff changeset	308 For more information about resource tags, please see [this article](https://puppet.com/docs/puppet/7/lang_tags.html#lang_tags-assigning-tags-to-resources).
adf6fe9bbc17 Update Puppet modules to latest versions IBBoard <dev@ibboard.co.uk> parents: 386 diff changeset	309
adf6fe9bbc17 Update Puppet modules to latest versions IBBoard <dev@ibboard.co.uk> parents: 386 diff changeset	310 <a id="license"></a>
adf6fe9bbc17 Update Puppet modules to latest versions IBBoard <dev@ibboard.co.uk> parents: 386 diff changeset	311 ## License
adf6fe9bbc17 Update Puppet modules to latest versions IBBoard <dev@ibboard.co.uk> parents: 386 diff changeset	312
adf6fe9bbc17 Update Puppet modules to latest versions IBBoard <dev@ibboard.co.uk> parents: 386 diff changeset	313 This codebase is licensed under the Apache2.0 licensing, however due to the nature of the codebase the open source dependencies may also use a combination of [AGPL](https://opensource.org/license/agpl-v3/), [BSD-2](https://opensource.org/license/bsd-2-clause/), [BSD-3](https://opensource.org/license/bsd-3-clause/), [GPL2.0](https://opensource.org/license/gpl-2-0/), [LGPL](https://opensource.org/license/lgpl-3-0/), [MIT](https://opensource.org/license/mit/) and [MPL](https://opensource.org/license/mpl-2-0/) Licensing.
adf6fe9bbc17 Update Puppet modules to latest versions IBBoard <dev@ibboard.co.uk> parents: 386 diff changeset	314
386 3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	315 <a id="development"></a>
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	316 ## Development
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	317
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	318 We are experimenting with a new tool for running acceptance tests. It's name is [puppet_litmus](https://github.com/puppetlabs/puppet_litmus) this replaces beaker as the test runner. To run the acceptance tests follow the instructions [here](https://github.com/puppetlabs/puppet_litmus/wiki/Tutorial:-use-Litmus-to-execute-acceptance-tests-with-a-sample-module-(MoTD)#install-the-necessary-gems-for-the-module).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	319
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	320 Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	321
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	322 We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	323
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	324 For more information, see our [module contribution guide.](https://puppet.com/docs/puppet/latest/contributing.html)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	325
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	326 ### Contributors
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	327
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	328 To see who's already involved, see the [list of contributors.](https://github.com/puppetlabs/puppetlabs-inifile/graphs/contributors)

Mercurial > repos > other > Puppet

annotate modules/inifile/README.md @ 482:d83de9b3a62b default tip