Skip to content

Commit 3eaae8e

Browse files
authored
Merge pull request #312 from miharp/docs/issue-274-kramdown-ial
docs: remove legacy Kramdown topic-type IAL markers (openvox 8.x)
2 parents 1db618e + d6bd621 commit 3eaae8e

17 files changed

Lines changed: 0 additions & 144 deletions

docs/_openvox_8x/cheatsheet_core_types.md

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ Related topics:
2020

2121
* [Type reference](./type.html)
2222

23-
{:.concept}
2423
## The Trifecta
2524

2625
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':
4746

4847
<!--**INSERT PICTURE OF DEPENDENCY GRAPH HERE**-->
4948

50-
{:.concept}
5149
### file
5250

5351
Manages files, directories, and symlinks.
5452

55-
{:.section}
5653
#### Important Attributes
5754

5855
* [`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.
6663
* [`group`](./type.html#file-attribute-group) -- By name or GID.
6764
* [`mode`](./type.html#file-attribute-mode) -- Must be specified exactly. Does the right thing for directories.
6865

69-
{:.section}
7066
#### For Normal Files
7167

7268
* [`source`](./type.html#file-attribute-source) -- Where to download contents for the file. Usually a `puppet:///` URL.
7369
* [`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).
7470

75-
{:.section}
7671
#### For Directories
7772

7873
* [`source`](./type.html#file-attribute-source) -- Where to download contents for the directory, when `recurse => true`.
7974
* [`recurse`](./type.html#file-attribute-recurse) -- Whether to recursively manage files in the directory.
8075
* [`purge`](./type.html#file-attribute-purge) -- Whether unmanaged files in the directory should be deleted, when `recurse => true`.
8176

82-
{:.section}
8377
#### For Symlinks
8478

8579
* [`target`](./type.html#file-attribute-target) -- The symlink target. (Required when `ensure => link`.)
8680

87-
{:.section}
8881
#### Other Notable Attributes
8982

9083
* [`backup`](./type.html#file-attribute-backup)
@@ -95,12 +88,10 @@ Manages files, directories, and symlinks.
9588
* [`recurselimit`](./type.html#file-attribute-recurselimit)
9689
* [`replace`](./type.html#file-attribute-replace)
9790

98-
{:.concept}
9991
### package
10092

10193
Manages software packages.
10294

103-
{:.section}
10495
#### Important Attributes
10596

10697
* [`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.
113104
* [`source`](./type.html#package-attribute-source) -- Where to obtain the package, if your system's packaging tools don't use a repository.
114105
* [`provider`](./type.html#package-attribute-provider) -- Which packaging system to use (e.g. Yum vs. Rubygems), if a system has more than one available.
115106

116-
{:.concept}
117107
### service
118108

119109
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:
124114

125115
* [Relationships](./lang_relationships.html)
126116

127-
{:.section}
128117
#### Important Attributes
129118

130119
* [`name`](./type.html#service-attribute-name) -- The name of the service to run; **defaults to title.**
@@ -135,16 +124,13 @@ Related topics:
135124
* [`hasrestart`](./type.html#service-attribute-hasrestart) -- Whether to use the init script's restart command instead of stop+start. Defaults to false.
136125
* [`hasstatus`](./type.html#service-attribute-hasstatus) -- Whether to use the init script's status command. Defaults to true.
137126

138-
{:.section}
139127
#### Other Notable Attributes
140128

141129
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.
142130

143131

144-
{:.concept}
145132
## Hello World
146133

147-
{:.concept}
148134
### notify
149135

150136
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
153139
notify { 'This message is getting logged on the agent node.': }
154140
```
155141

156-
{:.section}
157142
#### Important Attributes
158143

159144
* [`message`](./type.html#notify-attribute-message) -- **Defaults to title.**
160145

161-
{:.concept}
162146
## Grab bag
163147

164-
{:.concept}
165148
### [exec][]
166149

167150
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.
168151

169-
{:.section}
170152
#### Important Attributes
171153

172154
* [`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.
173155
* [`path`](./type.html#exec-attribute-path) -- Where to look for executables, as a colon-separated list or an array.
174156
* [`returns`](./type.html#exec-attribute-returns) -- Which exit codes indicate success. Defaults to `0`.
175157
* [`environment`](./type.html#exec-attribute-environment) -- An array of environment variables to set (for example, `['MYVAR=somevalue', 'OTHERVAR=othervalue']`).
176158

177-
{:.section}
178159
#### Attributes to Limit When a Command Should Run
179160

180161
* [`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.
181162
* [`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.
182163
* [`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.
183164
* [`unless`](./type.html#exec-attribute-unless) -- The opposite of onlyif.
184165

185-
{:.section}
186166
#### Other Notable Attributes:
187167

188168
[`cwd`](./type.html#exec-attribute-cwd), [`group`](./type.html#exec-attribute-group), [`logoutput`](./type.html#exec-attribute-logoutput), , [`timeout`](./type.html#exec-attribute-timeout), [`tries`](./type.html#exec-attribute-tries), [`try_sleep`](./type.html#exec-attribute-try_sleep), [`user`](./type.html#exec-attribute-user).
189169

190-
{:.concept}
191170
### [user][]
192171

193172
Manages user accounts; mostly used for system users.
@@ -201,7 +180,6 @@ Manages user accounts; mostly used for system users.
201180
managehome => true,
202181
}
203182

204-
{:.section}
205183
#### Important Attributes
206184

207185
* [`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.
216194
* [`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.
217195
* [`shell`](./type.html#user-attribute-shell) -- The user's login shell.
218196

219-
{:.section}
220197
#### Other Notable Attributes
221198

222199
[`comment`](./type.html#user-attribute-comment), [`expiry`](./type.html#user-attribute-expiry), [`membership`](./type.html#user-attribute-membership), [`password`](./type.html#user-attribute-password), [`password_max_age`](./type.html#user-attribute-password_max_age), [`password_min_age`](./type.html#user-attribute-password_min_age), [`purge_ssh_keys`](./type.html#user-attribute-purge_ssh_keys), [`salt`](./type.html#user-attribute-salt).
223200

224-
{:.concept}
225201
### [group][]
226202

227203
Manages groups.
228204

229-
{:.section}
230205
#### Important Attributes
231206

232207
* [`name`](./type.html#group-attribute-name) -- The name of the group; **defaults to title.**

docs/_openvox_8x/cheatsheet_module.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ title: Module cheat sheet
1212
[forge]: https://forge.puppet.com/
1313
[documentation]: ./modules_documentation.html
1414

15-
{:.reference}
1615
## Module cheat sheet
1716

1817
A quick reference to Puppet module terms and concepts.
@@ -29,7 +28,6 @@ Related topics:
2928

3029
**Example Module: `/etc/puppetlabs/puppet/modules/apache`**
3130

32-
{:.section}
3331
### manifests
3432

3533
This directory holds the module's Puppet code.
@@ -73,7 +71,6 @@ class apache::config::ssl {
7371

7472
Subdirectories add intermediate namespaces.
7573

76-
{:.section}
7774
### files
7875

7976
Nodes can download any files in this directory from Puppet's built-in file server.
@@ -106,7 +103,6 @@ file { '/etc/apache2/httpd-ssl.conf':
106103
}
107104
```
108105

109-
{:.section}
110106
### lib
111107

112108
This directory holds Ruby plugins, which can add features to Puppet and Facter.
@@ -120,7 +116,6 @@ A custom function.
120116
apache/lib/facter/apache_confdir.rb**
121117
A custom fact.
122118

123-
{:.section}
124119
### templates
125120

126121
This directory holds ERB templates.

docs/_openvox_8x/config_about_settings.markdown

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ See also:
1919

2020
Settings can be set in the main config file. Puppet's main config file is called `puppet.conf`.
2121

22-
{:.concept}
2322
## Main settings and extra config files
2423

2524
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
2928
- 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.)
3029
- 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.
3130

32-
{:.section}
3331
### Puppet Server configuration
3432

3533
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.
3634

3735
See [Puppet Server: Configuration][puppetserver_config]
3836

39-
{:.concept}
4037
## Settings are loaded on startup
4138

4239
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.
4340

4441
A command or service _only_ reads its settings _once;_ if something needs to be reconfigured, it needs to be restarted or run again.
4542

46-
{:.reference}
4743
## Settings on the command line
4844

4945
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:
5248

5349
`$ sudo puppet agent --test --noop --certname temporary-name.example.com`
5450

55-
{:.reference}
5651
## Basic settings
5752

5853
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.
6560

6661
`--certname "temporary-name.example.com"`
6762

68-
{:.reference}
6963
## Boolean settings
7064

7165
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:
7670

7771
`--no-noop` is equivalent to setting `noop = false` in `puppet.conf`.
7872

79-
{:.reference}
8073
## Default values
8174

8275
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.
8376

8477
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`).
8578

86-
{:.concept}
8779
## Configuring locale settings
8880

8981
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,
9284

9385
For help setting your operating system's locale or adding new locales, consult its documentation. This section covers setting the locale for Puppet services.
9486

95-
{:.task}
9687
### Checking your locale settings on \*nix and macOS
9788

9889
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
117108
sudo set | egrep 'LANG|LC_'
118109
```
119110

120-
{:.task}
121111
### Checking your locale settings on Windows
122112

123113
To check your current locale setting, run the `Get-WinSystemLocale` command from PowerShell.
@@ -131,7 +121,6 @@ LCID Name DisplayName
131121

132122
To check your system's current code page setting, run the `chcp` command.
133123

134-
{:.task}
135124
### Setting your locale on *nix with an environment variable
136125

137126
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
151140

152141
After updating the file, restart the Puppet service to apply the change.
153142

154-
{:.task}
155143
### Setting your locale for the OpenVox agent service on macOS
156144

157145
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
165153

166154
After updating the file, restart the Puppet service to apply the change.
167155

168-
{:.task}
169156
### Setting your locale on Windows
170157

171158
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:
176163
Set-WinSystemLocale en-US
177164
```
178165

179-
{:.task}
180166
### Disabling internationalized strings
181167

182168
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.

docs/_openvox_8x/config_file_auth.markdown

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ Access to Puppet's HTTPS API is configured in `auth.conf`.
3030
>
3131
> 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.
3232
33-
{:.concept}
3433
## Puppet's HTTPS API
3534

3635
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.

docs/_openvox_8x/dirs_codedir.markdown

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ title: "Code and data directory (codedir)"
88

99
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.
1010

11-
{:.concept}
1211
## Location
1312

1413
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
2322

2423
> **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.
2524
26-
{:.section}
2725
### Configuration
2826

2927
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._
3028

31-
{:.concept}
3229
## Interpolation of `$codedir`
3330

3431
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
3835

3936
If you need to set nonstandard values for some settings, this allows you to avoid absolute paths and keep your Puppet-related files together.
4037

41-
{:.concept}
4238
### Contents
4339

4440
Puppet's codedir contains environments, modules, and Hiera data. Its contents are used by OpenVox Server and Puppet apply, but not by OpenVox agent.
4541

4642
Almost everything in the codedir has its own page of documentation.
4743

48-
{:.section}
4944
### Code and Data Directories
5045

5146
* [`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.

docs/_openvox_8x/dirs_confdir.markdown

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ title: "Directories: Config directory (confdir)"
77

88
Puppet's `confdir` is the main directory for Puppet's configuration. It contains config files and SSL data.
99

10-
{:.concept}
1110
## Location
1211

1312
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.)
2423

2524
> **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.
2625
27-
{:.section}
2826
### Configuration
2927

3028
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
3634
`--confdir` whenever you run commands like `puppet module` to ensure they use the same directories as
3735
Puppet Server.
3836

39-
{:.concept}
4037
## Interpolation of `$confdir`
4138

4239
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.
4340

4441
If you need to set nonstandard values for some settings, this allows you to avoid absolute paths and keep your Puppet-related files together.
4542

46-
{:.concept}
4743
## Contents
4844

4945
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.
5248

5349
Items labeled "master only" below can also be present on standalone Puppet apply nodes, since they act as both masters and agents.
5450

55-
{:.section}
5651
### SSL Data
5752

5853
* [`ssl`](./dirs_ssldir.html) --- contains each node's certificate infrastructure. (All nodes.)
5954

60-
{:.section}
6155
### Config files
6256

6357
* [`puppet.conf`](./config_file_main.html) --- Puppet's main config file. (Any node.)

0 commit comments

Comments
 (0)