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: docs/_openvox_8x/cheatsheet_core_types.md
-25Lines changed: 0 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,6 @@ Related topics:
20
20
21
21
*[Type reference](./type.html)
22
22
23
-
{:.concept}
24
23
## The Trifecta
25
24
26
25
Package/file/service: Learn it, live it, love it. Even if this is the only Puppet you know, you can still get a whole lot done.
@@ -47,12 +46,10 @@ service { 'sshd':
47
46
48
47
<!--**INSERT PICTURE OF DEPENDENCY GRAPH HERE**-->
49
48
50
-
{:.concept}
51
49
### file
52
50
53
51
Manages files, directories, and symlinks.
54
52
55
-
{:.section}
56
53
#### Important Attributes
57
54
58
55
*[`ensure`](./type.html#file-attribute-ensure) -- Whether the file should exist, and what it should be. Allowed values:
@@ -66,25 +63,21 @@ Manages files, directories, and symlinks.
66
63
*[`group`](./type.html#file-attribute-group) -- By name or GID.
67
64
*[`mode`](./type.html#file-attribute-mode) -- Must be specified exactly. Does the right thing for directories.
68
65
69
-
{:.section}
70
66
#### For Normal Files
71
67
72
68
*[`source`](./type.html#file-attribute-source) -- Where to download contents for the file. Usually a `puppet:///` URL.
73
69
*[`content`](./type.html#file-attribute-content) -- The file's desired contents, as a string. Most useful when paired with [templates](./lang_template.html), but you can also use the output of the [file function](./function.html#file).
74
70
75
-
{:.section}
76
71
#### For Directories
77
72
78
73
*[`source`](./type.html#file-attribute-source) -- Where to download contents for the directory, when `recurse => true`.
79
74
*[`recurse`](./type.html#file-attribute-recurse) -- Whether to recursively manage files in the directory.
80
75
*[`purge`](./type.html#file-attribute-purge) -- Whether unmanaged files in the directory should be deleted, when `recurse => true`.
81
76
82
-
{:.section}
83
77
#### For Symlinks
84
78
85
79
*[`target`](./type.html#file-attribute-target) -- The symlink target. (Required when `ensure => link`.)
86
80
87
-
{:.section}
88
81
#### Other Notable Attributes
89
82
90
83
*[`backup`](./type.html#file-attribute-backup)
@@ -95,12 +88,10 @@ Manages files, directories, and symlinks.
*[`name`](./type.html#package-attribute-name) -- The name of the package, as known to your packaging system; **defaults to title.**
@@ -113,7 +104,6 @@ Manages software packages.
113
104
*[`source`](./type.html#package-attribute-source) -- Where to obtain the package, if your system's packaging tools don't use a repository.
114
105
*[`provider`](./type.html#package-attribute-provider) -- Which packaging system to use (e.g. Yum vs. Rubygems), if a system has more than one available.
115
106
116
-
{:.concept}
117
107
### service
118
108
119
109
Manages services running on the node. Like with packages, some platforms have better tools than others, so read up.
@@ -124,7 +114,6 @@ Related topics:
124
114
125
115
*[Relationships](./lang_relationships.html)
126
116
127
-
{:.section}
128
117
#### Important Attributes
129
118
130
119
*[`name`](./type.html#service-attribute-name) -- The name of the service to run; **defaults to title.**
@@ -135,16 +124,13 @@ Related topics:
135
124
*[`hasrestart`](./type.html#service-attribute-hasrestart) -- Whether to use the init script's restart command instead of stop+start. Defaults to false.
136
125
*[`hasstatus`](./type.html#service-attribute-hasstatus) -- Whether to use the init script's status command. Defaults to true.
137
126
138
-
{:.section}
139
127
#### Other Notable Attributes
140
128
141
129
If a service has a bad init script, you can work around it and manage almost anything using the [`status`](./type.html#service-attribute-status), [`start`](./type.html#service-attribute-start), [`stop`](./type.html#service-attribute-stop), [`restart`](./type.html#service-attribute-restart), [`pattern`](./type.html#service-attribute-pattern), and [`binary`](./type.html#service-attribute-binary) attributes.
142
130
143
131
144
-
{:.concept}
145
132
## Hello World
146
133
147
-
{:.concept}
148
134
### notify
149
135
150
136
Logs an arbitrary message, at the `notice` log level. This appears in the POSIX syslog or Windows Event Log on the OpenVox agent node and is also logged in reports.
@@ -153,41 +139,34 @@ Logs an arbitrary message, at the `notice` log level. This appears in the POSIX
153
139
notify { 'This message is getting logged on the agent node.': }
154
140
```
155
141
156
-
{:.section}
157
142
#### Important Attributes
158
143
159
144
*[`message`](./type.html#notify-attribute-message) -- **Defaults to title.**
160
145
161
-
{:.concept}
162
146
## Grab bag
163
147
164
-
{:.concept}
165
148
### [exec][]
166
149
167
150
Executes an arbitrary command on the agent node. When using execs, you must either make sure the command can be safely run multiple times, or specify that it should only run under certain conditions.
168
151
169
-
{:.section}
170
152
#### Important Attributes
171
153
172
154
*[`command`](./type.html#exec-attribute-command) -- The command to run; **defaults to title.** If this isn't a fully-qualified path, use the `path` attribute.
173
155
*[`path`](./type.html#exec-attribute-path) -- Where to look for executables, as a colon-separated list or an array.
174
156
*[`returns`](./type.html#exec-attribute-returns) -- Which exit codes indicate success. Defaults to `0`.
175
157
*[`environment`](./type.html#exec-attribute-environment) -- An array of environment variables to set (for example, `['MYVAR=somevalue', 'OTHERVAR=othervalue']`).
176
158
177
-
{:.section}
178
159
#### Attributes to Limit When a Command Should Run
179
160
180
161
*[`creates`](./type.html#exec-attribute-creates) -- A file to look for before running the command. The command only runs if the file doesn’t exist.
181
162
*[`refreshonly`](./type.html#exec-attribute-refreshonly) -- If `true`, the command only run if a resource it subscribes to (or a resource which notifies it) has changed.
182
163
*[`onlyif`](./type.html#exec-attribute-onlyif) -- A command or array of commands; if any have a non-zero return value, the command won't run.
183
164
*[`unless`](./type.html#exec-attribute-unless) -- The opposite of onlyif.
Manages user accounts; mostly used for system users.
@@ -201,7 +180,6 @@ Manages user accounts; mostly used for system users.
201
180
managehome => true,
202
181
}
203
182
204
-
{:.section}
205
183
#### Important Attributes
206
184
207
185
*[`name`](./type.html#user-attribute-name) -- The name of the user; **defaults to title.**
@@ -216,17 +194,14 @@ Manages user accounts; mostly used for system users.
216
194
*[`managehome`](./type.html#user-attribute-managehome) -- Whether to manage the home directory when managing the user; if you don't set this to true, you'll need to create the user's home directory manually.
217
195
*[`shell`](./type.html#user-attribute-shell) -- The user's login shell.
Copy file name to clipboardExpand all lines: docs/_openvox_8x/config_about_settings.markdown
-14Lines changed: 0 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,6 @@ See also:
19
19
20
20
Settings can be set in the main config file. Puppet's main config file is called `puppet.conf`.
21
21
22
-
{:.concept}
23
22
## Main settings and extra config files
24
23
25
24
When we mention "settings" in the context of Puppet, we usually mean the main settings. These are the settings that are listed in the configuration reference. They are valid in `puppet.conf` and available for use on the command line. These settings configure nearly all of Puppet's core features.
@@ -29,21 +28,18 @@ However, there are also about nine extra configuration files --- things like `au
29
28
- The main settings only support a few types of values. Some things just can't be configured without complex data structures, so they needed separate files. (Authorization rules and custom CSR attributes are in this category.)
30
29
- Puppet currently doesn't allow extensions to add new settings to `puppet.conf`. This means some settings that _should_ be main settings (like the PuppetDB server) can't be.
31
30
32
-
{:.section}
33
31
### Puppet Server configuration
34
32
35
33
Puppet Server honors almost all settings in `puppet.conf` and should pick them up automatically. However, for some tasks, such as configuring the webserver or an external Certificate Authority, there are Puppet Server-specific configuration files and settings.
36
34
37
35
See [Puppet Server: Configuration][puppetserver_config]
38
36
39
-
{:.concept}
40
37
## Settings are loaded on startup
41
38
42
39
When any Puppet command or service starts up, it gets values for all of its settings. Any of these settings could change the way that command or service behaves.
43
40
44
41
A command or service _only_ reads its settings _once;_ if something needs to be reconfigured, it needs to be restarted or run again.
45
42
46
-
{:.reference}
47
43
## Settings on the command line
48
44
49
45
Settings from the command line have top priority, and **always override settings from the config file.** When a Puppet command or service is started, you can specify any setting as a command line option.
@@ -52,7 +48,6 @@ Settings require two hyphens and the name of the setting on the command line:
For most settings, you specify the option and follow it with a value. An equals sign between the two (`=`) is optional, and you can optionally put values in quotes.
@@ -65,7 +60,6 @@ All three of these are equivalent to setting `certname = temporary-name.example.
65
60
66
61
`--certname "temporary-name.example.com"`
67
62
68
-
{:.reference}
69
63
## Boolean settings
70
64
71
65
Settings whose only valid values are `true` and `false`, use a shorter format. Specifying the option alone sets the setting to `true`, or prefixing the option with `no-` sets it to false.
@@ -76,14 +70,12 @@ This means:
76
70
77
71
`--no-noop` is equivalent to setting `noop = false` in `puppet.conf`.
78
72
79
-
{:.reference}
80
73
## Default values
81
74
82
75
If a setting isn't specified on the command line or in `puppet.conf`, it falls back to a default value. Default values for all settings are listed in the configuration reference.
83
76
84
77
Some default values are based on other settings --- when this is the case, the default is shown using the other setting as a variable (similar to `$ssldir/certs`).
85
78
86
-
{:.concept}
87
79
## Configuring locale settings
88
80
89
81
Puppet 5.1 added support for locale-specific strings in output, and it detects your locale from your system configuration. This provides localized strings, report messages, and log messages for the locale's language when available.
@@ -92,7 +84,6 @@ Upon startup, Puppet looks for a set of environment variables on \*nix systems,
92
84
93
85
For help setting your operating system's locale or adding new locales, consult its documentation. This section covers setting the locale for Puppet services.
94
86
95
-
{:.task}
96
87
### Checking your locale settings on \*nix and macOS
97
88
98
89
To check your current locale settings, run the `locale` command. This outputs the settings used by your current shell.
@@ -117,7 +108,6 @@ To check the current status of environment variables that might conflict with or
117
108
sudo set | egrep 'LANG|LC_'
118
109
```
119
110
120
-
{:.task}
121
111
### Checking your locale settings on Windows
122
112
123
113
To check your current locale setting, run the `Get-WinSystemLocale` command from PowerShell.
@@ -131,7 +121,6 @@ LCID Name DisplayName
131
121
132
122
To check your system's current code page setting, run the `chcp` command.
133
123
134
-
{:.task}
135
124
### Setting your locale on *nix with an environment variable
136
125
137
126
You can use environment variables to set your locale for processes started on the command line. For most Linux distributions, set the `LANG` variable to your preferred locale, and the `LANGUAGE` variable to an empty string. On SLES, also set the `LC_ALL` variable to an empty string.
@@ -151,7 +140,6 @@ To set the locale for the OpenVox agent service, you can add these `export` stat
151
140
152
141
After updating the file, restart the Puppet service to apply the change.
153
142
154
-
{:.task}
155
143
### Setting your locale for the OpenVox agent service on macOS
156
144
157
145
To set the locale for the OpenVox agent service on macOS, update the `LANG` setting in the `/Library/LaunchDaemons/com.puppetlabs.puppet.plist` file.
@@ -165,7 +153,6 @@ To set the locale for the OpenVox agent service on macOS, update the `LANG` sett
165
153
166
154
After updating the file, restart the Puppet service to apply the change.
167
155
168
-
{:.task}
169
156
### Setting your locale on Windows
170
157
171
158
On Windows, Puppet uses the `LANG` environment variable if it is set. If not, it uses the configured region, as set in the Administrator tab of the Region control panel.
@@ -176,7 +163,6 @@ On Windows 10, you can use PowerShell to set the system locale:
176
163
Set-WinSystemLocale en-US
177
164
```
178
165
179
-
{:.task}
180
166
### Disabling internationalized strings
181
167
182
168
Puppet 5.3.2 added the optional Boolean `disable_i18n` setting, which you can configure in `puppet.conf`. If set to `true`, Puppet disables localized strings in log messages, reports, and parts of the command-line interface. This can improve performance when using Puppet modules, especially if [environment caching](./configuration.html#environment_timeout) is disabled, and even if you don't need localized strings or the modules aren't localized. This setting is `false` by default in open source Puppet.
Copy file name to clipboardExpand all lines: docs/_openvox_8x/config_file_auth.markdown
-1Lines changed: 0 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,6 @@ Access to Puppet's HTTPS API is configured in `auth.conf`.
30
30
>
31
31
> The default location of the new `auth.conf` is `/etc/puppetlabs/puppetserver/conf.d/auth.conf`. See [the Puppet Server `auth.conf` docs][server_auth_conf] for details.
32
32
33
-
{:.concept}
34
33
## Puppet's HTTPS API
35
34
36
35
The OpenVox agent service requests configurations over HTTPS, and the OpenVox Server application provides several HTTPS endpoints to support this. (For example, requesting a catalog uses a different endpoint than submitting a report.) There are also a few endpoints that aren't used by OpenVox agent.
Copy file name to clipboardExpand all lines: docs/_openvox_8x/dirs_codedir.markdown
-5Lines changed: 0 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,6 @@ title: "Code and data directory (codedir)"
8
8
9
9
Puppet's `codedir` is the main directory for Puppet code and data. It contains environments (which contain your manifests and modules), a global modules directory for all environments, and your Hiera data.
10
10
11
-
{:.concept}
12
11
## Location
13
12
14
13
Puppet's codedir can be found at one of the following locations:
@@ -23,12 +22,10 @@ The system codedir is what you usually want to use, since you will usually run P
23
22
24
23
> **Note:** When OpenVox Server is running as a Rack application, the `config.ru` file must explicitly set `--codedir` to the system codedir. The example `config.ru` file provided with the Puppet source does this.
25
24
26
-
{:.section}
27
25
### Configuration
28
26
29
27
The location of the codedir can be configured in puppet.conf with [the `codedir` setting][codedir], but note that Puppet Server doesn't use that setting; it has its own `jruby-puppet.master-code-dir` setting [in puppetserver.conf][puppetserver_conf]. If you're using a non-default codedir, _you must change both settings._
30
28
31
-
{:.concept}
32
29
## Interpolation of `$codedir`
33
30
34
31
Since the value of the codedir is discovered before other settings, you can safely reference it (with the `$codedir` variable) in the value of any other setting in puppet.conf:
@@ -38,14 +35,12 @@ Since the value of the codedir is discovered before other settings, you can safe
38
35
39
36
If you need to set nonstandard values for some settings, this allows you to avoid absolute paths and keep your Puppet-related files together.
40
37
41
-
{:.concept}
42
38
### Contents
43
39
44
40
Puppet's codedir contains environments, modules, and Hiera data. Its contents are used by OpenVox Server and Puppet apply, but not by OpenVox agent.
45
41
46
42
Almost everything in the codedir has its own page of documentation.
47
43
48
-
{:.section}
49
44
### Code and Data Directories
50
45
51
46
*[`environments`](./environments_creating.html) --- contains alternate versions of the `modules` and `manifests` directories, to allow code changes to be tested on smaller sets of nodes before entering production.
Puppet's `confdir` is the main directory for Puppet's configuration. It contains config files and SSL data.
9
9
10
-
{:.concept}
11
10
## Location
12
11
13
12
Puppet's confdir can be found at one of the following locations:
@@ -24,7 +23,6 @@ to use the same confdir as OpenVox agent or OpenVox Server.)
24
23
25
24
> **Note:** When OpenVox Server is running as a Rack application, the `config.ru` file must explicitly set `--confdir` to the system confdir. The example `config.ru` file provided with the Puppet source does this.
26
25
27
-
{:.section}
28
26
### Configuration
29
27
30
28
Puppet's confdir can be specified on the command line with the `--confdir` option, but it can't be set
@@ -36,14 +34,12 @@ to configure its confdir. Note that if you're using a non-default confdir, you m
36
34
`--confdir` whenever you run commands like `puppet module` to ensure they use the same directories as
37
35
Puppet Server.
38
36
39
-
{:.concept}
40
37
## Interpolation of `$confdir`
41
38
42
39
Since the value of the confdir is discovered before other settings, you can safely reference it (with the `$confdir` variable) in the value of any other setting in puppet.conf.
43
40
44
41
If you need to set nonstandard values for some settings, this allows you to avoid absolute paths and keep your Puppet-related files together.
45
42
46
-
{:.concept}
47
43
## Contents
48
44
49
45
Puppet's confdir contains several config files and the SSL data. Their locations can be changed with settings, but most users should use the default layout.
@@ -52,12 +48,10 @@ Almost everything in the confdir has its own page of documentation.
52
48
53
49
Items labeled "master only" below can also be present on standalone Puppet apply nodes, since they act as both masters and agents.
54
50
55
-
{:.section}
56
51
### SSL Data
57
52
58
53
*[`ssl`](./dirs_ssldir.html) --- contains each node's certificate infrastructure. (All nodes.)
59
54
60
-
{:.section}
61
55
### Config files
62
56
63
57
*[`puppet.conf`](./config_file_main.html) --- Puppet's main config file. (Any node.)
0 commit comments