You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@
16
16
1.[Contributors](#contributors)
17
17
18
18
19
+
<aid="moduledescription"></a>
19
20
## Module Description
20
21
21
22
This module provides a standard library of resources for Puppet modules. Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet:
@@ -29,12 +30,14 @@ This module provides a standard library of resources for Puppet modules. Puppet
29
30
30
31
> *Note:* As of version 3.7, Puppet Enterprise no longer includes the stdlib module. If you're running Puppet Enterprise, you should install the most recent release of stdlib for compatibility with Puppet modules.
31
32
33
+
<aid="setup"></a>
32
34
## Setup
33
35
34
36
[Install](https://puppet.com/docs/puppet/latest/modules_installing.html) the stdlib module to add the functions, facts, and resources of this standard library to Puppet.
35
37
36
38
If you are authoring a module that depends on stdlib, be sure to [specify dependencies](https://puppet.com/docs/puppet/latest/modules_metadata.html#specifying-dependencies-in-modules) in your metadata.json.
37
39
40
+
<aid="usage"></a>
38
41
## Usage
39
42
40
43
Most of stdlib's features are automatically loaded by Puppet. To use standardized run stages in Puppet, declare this class in your manifest with `include stdlib`.
@@ -61,6 +64,7 @@ node default {
61
64
}
62
65
```
63
66
67
+
<aid="reference"></a>
64
68
## Reference
65
69
66
70
*[Public classes](#public-classes)
@@ -70,6 +74,7 @@ node default {
70
74
*[Facts](#facts)
71
75
*[Functions](#functions)
72
76
77
+
<aid="limitations"></a>
73
78
### Classes
74
79
75
80
#### Public classes
@@ -80,6 +85,7 @@ The `stdlib` class has no parameters.
80
85
81
86
*`stdlib::stages`: Manages a standard set of run stages for Puppet.
82
87
88
+
<aid="definedtypes"></a>
83
89
### Defined types
84
90
85
91
#### `file_line`
@@ -269,6 +275,7 @@ Replaces all lines matched by `match` parameter, even if `line` already exists i
269
275
270
276
Default value: `false`.
271
277
278
+
<aid="datatypes"></a>
272
279
### Data types
273
280
274
281
#### `Stdlib::Absolutepath`
@@ -655,6 +662,7 @@ Match an IPv6 address formatted in the "alternative form" allowing for represent
655
662
656
663
Match an IPv6 address which may contain `::` used to compress zeros as documented in section 2.2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt).
657
664
665
+
<a id="facts"></a>
658
666
### Facts
659
667
660
668
#### `package_provider`
@@ -703,6 +711,7 @@ Determines the root home directory, which depends on your operating system. Gene
703
711
704
712
Returns the default provider Puppet uses to manage services on this system
705
713
714
+
<a id="functions"></a>
706
715
### Functions
707
716
708
717
#### `abs`
@@ -3107,19 +3116,22 @@ A negative value is taken to be "from the end" of the array, for example:
3107
3116
3108
3117
Takes one element from first array given and merges corresponding elements from second array given. This generates a sequence of n-element arrays, where *n* is one more than the count of arguments. For example, `zip(['1','2','3'],['4','5','6'])` results in ["1", "4"], ["2", "5"], ["3", "6"]. *Type*: rvalue.
3109
3118
3119
+
<a id="limitations"></a>
3110
3120
## Limitations
3111
3121
3112
3122
As of Puppet Enterprise 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules.
3113
3123
3114
3124
For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/metadata.json)
3115
3125
3126
+
<a id="development"></a>
3116
3127
## Development
3117
3128
3118
3129
Puppet 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 hardware, software, and deployment configurations that Puppet is intended to serve. 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. For more information, see our [module contribution guide](https://docs.puppet.com/forge/contributing.html).
3119
3130
3120
3131
To report or research a bug with any part of this module, please go to
The list of contributors can be found at: [https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors](https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors).
0 commit comments