1
1
# node_manager [ ![ Build Status] ( https://travis-ci.org/WhatsARanjit/prosvcs-node_manager.svg )] ( https://travis-ci.org/WhatsARanjit/prosvcs-node_manager )
2
2
3
3
#### Table of Contents
4
+
4
5
1 . [ Overview] ( #overview )
5
6
1 . [ Requirements] ( #requirements )
6
7
1 . [ Types] ( #types )
@@ -16,19 +17,21 @@ Create and manage Node Manager API endpoints as resources.
16
17
17
18
## Module State
18
19
19
- NOTE: This module is a Professional Service side project and is currently unmaintained.
20
+ NOTE: This module is a Professional Service side project and is currently unmaintained.
20
21
It is not supported and may not function as expected.
21
22
22
- ## Requirements:
23
+ ## Requirements
23
24
24
- - * nix operating system
25
- - Puppet >= 3.7.1
26
- - [ puppetclassify] ( https://github.com/puppetlabs/puppet-classify ) gem
27
- - [ puppetlabs/pe_gem module] ( https://forge.puppetlabs.com/puppetlabs/pe_gem )
28
- - NOTE: new ` https ` provider which doesn't need gem dependency at [ HTTPS.md] ( HTTPS.md )
25
+ * \ * nix operating system
26
+ * Puppet >= 3.7.1
27
+ * [ puppetclassify] ( https://github.com/puppetlabs/puppet-classify ) gem
28
+ * [ puppetlabs/pe_gem module] ( https://forge.puppetlabs.com/puppetlabs/pe_gem )
29
+ * NOTE: new ` https ` provider which doesn't need gem dependency at [ HTTPS.md] ( HTTPS.md )
29
30
30
31
## Classes
32
+
31
33
### Node_manager
34
+
32
35
The node_manager class facilitates the deployment of the puppetclassify gem
33
36
simply include node_manager in your node definition or add it to the pe_master node group
34
37
@@ -39,10 +42,12 @@ simply include node_manager in your node definition or add it to the pe_master n
39
42
Node_groups will autorequire parent node_groups.
40
43
41
44
Enumerate all node groups:
42
- * ` puppet resource node_group ` <br />
45
+
46
+ * ` puppet resource node_group `
43
47
44
48
Example output for ` puppet resource node_group 'PE MCollective' `
45
- ```
49
+
50
+ ``` puppet
46
51
node_group { 'PE MCollective':
47
52
ensure => 'present',
48
53
classes => {'puppet_enterprise::profile::mcollective::agent' => {}},
@@ -56,45 +61,63 @@ node_group { 'PE MCollective':
56
61
57
62
#### Node_group parameters
58
63
59
- * ` classes ` <br />
60
- Classes that are assigned to the node in hash format. Elements of the hash
61
- are class parameters. Default (empty hash): ` {} `
64
+ * ` classes `
65
+
66
+ Classes that are assigned to the node in hash format. Elements of the hash are class parameters.
67
+
68
+ Default (empty hash): ` {} `
69
+
70
+ * ` environment `
71
+
72
+ Environment selected for this node group.
73
+
74
+ Default: ` production `
75
+
76
+ * ` name `
77
+
78
+ (namevar) Node group's name.
79
+
80
+ * ` id `
62
81
63
- * ` environment ` <br />
64
- Environment selected for this node group. Default: ` production `
82
+ Universal ID for the group. This attribute is read-only.
65
83
66
- * ` name ` <br />
67
- (namevar) Node group's name.
84
+ * ` override_environment `
68
85
69
- * ` id ` <br />
70
- Universal ID for the group. This attribute is read-only.
86
+ Whether or not this group's environment ment setting overrides all other other environments.
71
87
72
- * ` override_environment ` <br />
73
- Whether or not this group's environment ment setting overrides
74
- all other other environments. Default: ` false `
88
+ Default: ` false `
75
89
76
- * ` parent ` <br />
77
- The UID for the data group. Can be specified by group name or
78
- UID. Default: ` default `
90
+ * ` parent `
79
91
80
- * ` rules ` <br />
81
- An array of classification rules. Default (empty array): ` [] `
92
+ The UID for the data group. Can be specified by group name or UID.
93
+
94
+ Default: ` default `
95
+
96
+ * ` rules `
97
+
98
+ An array of classification rules.
99
+
100
+ Default (empty array): ` [] `
82
101
83
102
### Puppet_environment
84
103
85
104
Enumerate all puppet environments:
86
- * ` puppet resource puppet_environment ` <br />
105
+
106
+ * ` puppet resource puppet_environment `
87
107
88
108
Example output for ` puppet resource puppet_environment production `
89
- ```
109
+
110
+ ``` puppet
90
111
puppet_environment { 'production':
91
112
ensure => 'present',
92
113
}
93
114
```
115
+
94
116
#### Puppet_environment parameters
95
117
96
- * ` name ` <br />
97
- (namevar) Name of the Puppet environment on disk, i.e. the directory name in ` $environmentpath ` .
118
+ * ` name `
119
+
120
+ (namevar) Name of the Puppet environment on disk, i.e. the directory name in ` $environmentpath ` .
98
121
99
122
## Functions
100
123
@@ -104,7 +127,7 @@ Retrieve all or one node_group and its data.
104
127
105
128
` node_groups() ` will return:
106
129
107
- ```
130
+ ``` puppet
108
131
{
109
132
"default"=>{
110
133
"environment_trumps"=>false,
@@ -131,7 +154,7 @@ Retrieve all or one node_group and its data.
131
154
132
155
` node_groups('default') ` will return:
133
156
134
- ```
157
+ ``` puppet
135
158
{
136
159
"default"=>{
137
160
"environment_trumps"=>false,
@@ -148,11 +171,14 @@ Retrieve all or one node_group and its data.
148
171
_ Type:_ rvalue
149
172
150
173
## Things to do
151
- - Remove ` puppetclassify ` dependency
152
- - Get feedback on ` https ` provider, new [ HTTPS.md] ( HTTPS.md )
174
+
175
+ * Remove ` puppetclassify ` dependency
176
+ * Get feedback on ` https ` provider, new [ HTTPS.md] ( HTTPS.md )
153
177
154
178
## Maintainers
179
+
155
180
This repositority is largely the work of some Puppet community members.
156
181
It is not officially maintained by Puppet, or any individual in
157
- particular. Issues should be opened in Github. Questions should be directed
182
+ particular. Issues should be opened in Github. Questions should be directed
158
183
at the individuals responsible for committing that particular code.
184
+
0 commit comments