Skip to content

Commit 2a1d9ad

Browse files
committed
Fix legacy /puppet/, /pe/, and /facter/ internal links in _openvox_8x
Rewrites /puppet/latest/report.html to /openvox/latest/report.html, removes links to deleted configuration.html and old puppet/3.8 docs, removes PE-only links and {{pe}} references with no OpenVox equivalent. Closes #121 Signed-off-by: Michael Harp <mike@mikeharp.com>
1 parent 75e0dbb commit 2a1d9ad

5 files changed

Lines changed: 12 additions & 21 deletions

File tree

docs/_openvox_8x/lang_template_epp.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ title: "Language: Embedded Puppet (EPP) template syntax"
44
---
55

66
[erb]: ./lang_template_erb.html
7-
[epp]: /puppet/latest/function.html#epp
7+
[epp]: /openvox/latest/function.html#epp
8+
[inline_epp]: /openvox/latest/function.html#inline_epp
89
[ntp]: https://forge.puppetlabs.com/puppetlabs/ntp
9-
[inline_epp]: /puppet/latest/function.html#inlineepp
1010
[functions]: ./lang_functions.html
1111
[hash]: ./lang_data_hash.html
1212
[local scope]: ./lang_scope.html
@@ -16,7 +16,7 @@ title: "Language: Embedded Puppet (EPP) template syntax"
1616
[variable_names]: ./lang_variables.html#naming
1717
[typed]: ./lang_data_type.html
1818

19-
Embedded Puppet (EPP) is a templating language based on the [Puppet language](./lang_summary.html). You can use EPP in Puppet 4 and higher, as well as Puppet 3.5 through 3.8 with the [future parser](/puppet/3.8/experiments_future.html) enabled.
19+
Embedded Puppet (EPP) is a templating language based on the [Puppet language](./lang_summary.html). You can use EPP in Puppet 4 and higher, as well as Puppet 3.5 through 3.8 with the future parser enabled.
2020

2121
Puppet can evaluate EPP templates with the [`epp`][epp] and [`inline_epp`][inline_epp] functions.
2222

@@ -187,7 +187,7 @@ A template works like a [defined type][]:
187187
* When you call the template (with the [`epp`][epp] or [`inline_epp`][inline_epp] functions), you can use parameters to set variables in its local scope.
188188
* Unlike erb templates, epp templates cannot directly access variables in the calling class without namespacing. Fully qualify variables or pass them in as parameters.
189189

190-
This means templates can use short names to access global variables (like `$os` or `$trusted`) and their own local variables, but must use qualified names (like `$ntp::tinker`) to access variables from any class. (With one exception for `inline_epp`; [see below](#special-scope-rule-for-inlineepp).)
190+
This means templates can use short names to access global variables (like `$os` or `$trusted`) and their own local variables, but must use qualified names (like `$ntp::tinker`) to access variables from any class. (With one exception for `inline_epp`; [see below](#special-scope-rule-for-inline_epp).)
191191

192192
### Parameters
193193

docs/_openvox_8x/metaparameter.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -302,6 +302,4 @@ Multiple tags can be specified as an array:
302302
}
303303

304304
Tags are useful for things like applying a subset of a host's configuration
305-
with [the `tags` setting](/puppet/latest/configuration.html#tags)
306-
(e.g. `puppet agent --test --tags bootstrap`).
307-
305+
with the `tags` setting (e.g. `puppet agent --test --tags bootstrap`).

docs/_openvox_8x/nodes_ldap.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ title: "The LDAP Node Classifier"
55

66
[class parameters]: ./lang_classes.html#class-parameters-and-variables
77
[hiera]: ./hiera_intro.html
8-
[rp]: {{pe}}/r_n_p_intro.html
98
[custom hiera backend]: ./hiera_custom_backends.html
109
[environment]: ./environments.html
1110
[node definitions]: ./lang_node_definitions.html
@@ -29,11 +28,11 @@ There are some benefits to storing node data in LDAP instead of using [node defi
2928
- All attributes on the LDAP nodes are assigned as variables in the Puppet configuration, just like facts.
3029
- It is straightforward for other applications to modify LDAP data to configure nodes (for example, as part of a deployment process), which is easier to support than generating Puppet code.
3130

32-
**However.** This LDAP integration was written for a very different world, before Puppet had [class parameters][] or [data lookup with Hiera][hiera], and before modern best practices like [the roles and profiles method][RP] were developed. Dinosaurs walked the earth, and you configured your Puppet classes by setting top-scope variables in the node definition.
31+
**However.** This LDAP integration was written for a very different world, before Puppet had [class parameters][] or [data lookup with Hiera][hiera], and before modern best practices like the roles and profiles method were developed. Dinosaurs walked the earth, and you configured your Puppet classes by setting top-scope variables in the node definition.
3332

3433
You can probably still use this effectively, but please consider the following:
3534

36-
* With an antique interface like this, [the roles and profiles method][RP] is even more of a best practice than it is elsewhere. Since LDAP attributes can't configure class parameters, they're not suited for building full configurations out of component modules, so you should be hiding most of your complexity with wrapper classes, doing data lookup via Hiera, and only using LDAP to assign role classes.
35+
* With an antique interface like this, the roles and profiles method is even more of a best practice than it is elsewhere. Since LDAP attributes can't configure class parameters, they're not suited for building full configurations out of component modules, so you should be hiding most of your complexity with wrapper classes, doing data lookup via Hiera, and only using LDAP to assign role classes.
3736
* Depending on where that LDAP data is coming from, it might make more sense to go right to the source and write a [custom Hiera backend][] that can access your business's configuration data. In fact, writing an LDAP-based Hiera backend might make more sense than using this rigid 0.2x-era interface.
3837

3938
## Prerequisites

docs/_openvox_8x/reporting_about.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@ layout: default
33
title: "About reporting"
44
---
55

6-
[report]: /puppet/latest/configuration.html#report
7-
[reports]: /puppet/latest/configuration.html#reports
8-
[reportdir]: /puppet/latest/configuration.html#reportdir
96
[puppet.conf]: ./config_file_main.html
107

118
Puppet creates a report about its actions and your infrastructure each time it applies a catalog during a Puppet run. You can create and use report processors to generate insightful information or alerts from
@@ -26,18 +23,18 @@ That external service can then provide a way to view the processed report.
2623

2724
## Configuring reporting
2825

29-
A Puppet agent sends reports by default. You can turn off reporting by changing the [`report`][report] setting in an agent's [`puppet.conf`][puppet.conf].
26+
A Puppet agent sends reports by default. You can turn off reporting by changing the `report` setting in an agent's [`puppet.conf`][puppet.conf].
3027

31-
On Puppet master servers (and nodes running Puppet apply), you can configure enabled report processors as a comma-separated list in the [`reports`][reports] setting. The default `reports` value is 'store',
32-
which stores them in the configured [`reportdir`][reportdir]. You can also turn off reports entirely by setting `reports` to 'none'.
28+
On Puppet master servers (and nodes running Puppet apply), you can configure enabled report processors as a comma-separated list in the `reports` setting. The default `reports` value is 'store',
29+
which stores them in the configured `reportdir`. You can also turn off reports entirely by setting `reports` to 'none'.
3330

3431
## Practical reporting for beginners
3532

36-
Puppet's reporting features are powerful, but there are simple ways to work with them. Puppet Enterprise includes [helpful reporting tools]({{pe}}/CM_reports.html) in the console. [PuppetDB](/openvoxdb/latest/),
33+
Puppet's reporting features are powerful, but there are simple ways to work with them. [PuppetDB](/openvoxdb/latest/),
3734
with [its report processor enabled](/openvoxdb/latest/connect_puppet_master.html#enabling-report-storage), can interface with third-party tools such as [Puppetboard](https://github.com/puppet-community/puppetboard)
3835
or [PuppetExplorer](https://github.com/spotify/puppetexplorer).
3936

40-
Puppet has several basic built-in [report processors](/puppet/latest/report.html). For example, the `http` processor sends YAML dumps of reports via POST requests to a designated URL, while `log` saves received
37+
Puppet has several basic built-in [report processors](/openvox/latest/report.html). For example, the `http` processor sends YAML dumps of reports via POST requests to a designated URL, while `log` saves received
4138
logs to a local log file.
4239

4340
Certain Puppet modules --- for instance, [`tagmail`](https://forge.puppetlabs.com/puppetlabs/tagmail) --- add additional report processors. Each module has its own requirements, such as Ruby gems, operating

docs/_openvox_8x/static_catalogs.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,6 @@ title: "Static catalogs"
2525

2626
[Puppet Server]: /openvox-server/latest/
2727
[`puppetserver.conf`]: /openvox-server/latest/config_file_puppetserver.html
28-
[Application Orchestration]: {{pe}}/app_orchestration_overview.html
29-
[file sync]: {{pe}}/cmgmt_filesync.html
30-
[Code Manager]: {{pe}}/code_mgr.html
3128
[`code_content`]: /openvox-server/latest/
3229
Puppet 4.4 and Puppet Server 2.3 introduced a new feature for [catalog compilation][catalogs]: **static catalogs**.
3330

0 commit comments

Comments
 (0)