Skip to content

Commit bb04a67

Browse files
miharpclaude
andcommitted
Fix plugins_in_modules: update product names, links, and layout
- Add layout: default frontmatter - Replace Puppet Server/agent with OpenVox Server/agent - Fix {{facter}} broken links to point to /openfact/latest/ - Fix /guides/custom_types.html and /guides/custom_functions.html to local pages - Remove stale Puppet 5.3.4 pluginsync note - Replace "master" with "primary server" in locale reference - Remove {:.concept} markers - Replace "Puppet loads" with "OpenVox loads" Signed-off-by: Michael Harp <mike@mikeharp.com> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent e910cca commit bb04a67

1 file changed

Lines changed: 14 additions & 21 deletions

File tree

docs/_openvox_8x/plugins_in_modules.markdown

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,40 @@
11
---
2+
layout: default
23
title: Plug-ins in Modules
34
---
45

56
[modules]: ./modules_fundamentals.html
67
[environment]: ./environments.html
78
[modulepath]: ./dirs_modulepath.html
8-
[external facts]: {{facter}}/custom_facts.html#external-facts
9+
[external facts]: /openfact/latest/custom_facts.html#external-facts
910
[vardir]: ./dirs_vardir.html
10-
[custom facts]: {{facter}}/custom_facts.html
11-
[custom resource types and providers]: /guides/custom_types.html
12-
[ruby_functions]: /guides/custom_functions.html
11+
[custom facts]: /openfact/latest/custom_facts.html
12+
[custom resource types and providers]: ./custom_types.html
13+
[ruby_functions]: ./functions_ruby_overview.html
1314
[puppet_functions]: ./lang_write_functions_in_puppet.html
1415
[custom augeas lenses]: https://github.com/hercules-team/augeas/wiki/Create-a-lens-from-bottom-to-top
1516

16-
Puppet supports several kinds of **plug-ins,** which can be distributed in modules. These plug-ins enable new features for managing your nodes. Plug-ins are often included in modules downloaded from the Puppet Forge, and you can also develop your own.
17+
OpenVox supports several kinds of **plug-ins,** which can be distributed in modules. These plug-ins enable new features for managing your nodes. Plug-ins are often included in modules downloaded from the Puppet Forge, and you can also develop your own.
1718

18-
{:.concept}
1919
## Installing plug-ins
2020

2121
Plug-ins are automatically enabled when you install the module that contains them. You don't have to do anything else: once a module is installed in an environment's modulepath, its plug-ins are available when managing nodes in that environment.
2222

23-
{:.concept}
2423
### Auto-download of agent-side plug-ins (pluginsync)
2524

26-
Some plug-ins are used by Puppet Server, which can load them directly from modules. But other plug-ins (facts, custom resource types and providers) are used by Puppet agent, which doesn't have direct access to the server's modules.
25+
Some plug-ins are used by OpenVox Server, which can load them directly from modules. But other plug-ins (facts, custom resource types and providers) are used by OpenVox agent, which doesn't have direct access to the server's modules.
2726

28-
To enable this, Puppet agent automatically downloads plug-ins from the server at the start of each agent run. Those plug-ins are then available during the run.
27+
To enable this, OpenVox agent automatically downloads plug-ins from the server at the start of each agent run. Those plug-ins are then available during the run.
2928

30-
Puppet agent syncs plug-in files from _every_ module in its environment's modulepath, regardless of whether that node uses any classes from a given module, as well as any translations available for each module regardless of the agent's or master's locale.
29+
OpenVox agent syncs plug-in files from _every_ module in its environment's modulepath, regardless of whether that node uses any classes from a given module, as well as any translations available for each module regardless of the agent's or primary server's locale.
3130

3231
In other words, even if you don't declare any classes from the `stdlib` module, nodes will still use `stdlib`'s custom facts. Also, even if your agent's locale is set to en-US, if the module has translations for other locales, the agent will download all of those translations.
3332

34-
> **Note:** Puppet 5.3.4 added pluginsync of module translations. Agents running Puppet 5.3.4 or newer that connect to masters running older versions of Puppet do not automatically download translations.
35-
36-
{:.concept}
3733
### Technical details of pluginsync
3834

3935
Pluginsync takes advantage of the same file serving features used by the `file` resource type.
4036

41-
Puppet Server creates special file server mount points for pluginsync, and populates them with the aggregate contents of certain subdirectories of modules. Before doing an agent run, Puppet agent recursively manages the contents of those mount points into cache directories on disk. The agent performs the following functions:
37+
OpenVox Server creates special file server mount points for pluginsync, and populates them with the aggregate contents of certain subdirectories of modules. Before doing an agent run, OpenVox agent recursively manages the contents of those mount points into cache directories on disk. The agent performs the following functions:
4238

4339
1. Sends GET requests to `/puppet/v3/file_metadatas/<MOUNT POINT>`,
4440
2. Compares the resulting checksums and ownership info to local files,
@@ -54,12 +50,11 @@ Plug-in type | Module subdirectory | Mount point | Agent directory
5450
Ruby plug-ins | `<MODULE>/lib` | `plugins` | `<VARDIR>/lib`
5551
Translations | `<MODULE>/locales` | `locales` | `<VARDIR>/locales`
5652

57-
(`<VARDIR>` is Puppet agent's [cache directory][vardir], which is located at `/var/opt/puppetlabs/puppet/cache`, `%PROGRAMDATA%\PuppetLabs\puppet\cache`, or `~/.puppetlabs/opt/puppet/cache`.)
53+
(`<VARDIR>` is OpenVox agent's [cache directory][vardir], which is located at `/var/opt/puppetlabs/puppet/cache`, `%PROGRAMDATA%\PuppetLabs\puppet\cache`, or `~/.puppetlabs/opt/puppet/cache`.)
5854

59-
{:.concept}
6055
## Types of plug-ins
6156

62-
Puppet supports several kinds of plug-ins:
57+
OpenVox supports several kinds of plug-ins:
6358

6459
* [Custom facts][] (written in Ruby).
6560
* [External facts][] (executable scripts or static data).
@@ -69,9 +64,8 @@ Puppet supports several kinds of plug-ins:
6964
* [Custom Augeas lenses][].
7065
* Miscellaneous utility Ruby code used by other plug-ins.
7166

72-
Facts and Augeas lenses are used solely by Puppet agent. Functions are used solely by Puppet Server. Resource types and providers are used by both. (Note that Puppet apply acts as both agent and server.)
67+
Facts and Augeas lenses are used solely by OpenVox agent. Functions are used solely by OpenVox Server. Resource types and providers are used by both. (Note that Puppet apply acts as both agent and server.)
7368

74-
{:.concept}
7569
## Adding plug-ins to a module
7670

7771
To add plug-ins to a module, put them in the following directories:
@@ -115,12 +109,11 @@ To illustrate, a module that included every type of plug-in would have a directo
115109
- `datacenter.py` (an executable script that returns fact data.)
116110
- `locales`
117111

118-
{:.concept}
119112
## Issues with server-side plug-ins
120113

121114
If you encounter problems with conflicting versions of the same plug-in in different environments, you can fix these issues as described below.
122115

123-
Environments aren't completely isolated for certain kinds of plug-ins. If a plug-in of the same name exists in different versions in multiple environments, Puppet loads the plug-in from the first environment to use that plug-in, then continues to use that version of the plug-in for all subsequent environments.
116+
Environments aren't completely isolated for certain kinds of plug-ins. If a plug-in of the same name exists in different versions in multiple environments, OpenVox loads the plug-in from the first environment to use that plug-in, then continues to use that version of the plug-in for all subsequent environments.
124117

125118
This issue can occur with the following plug-in types:
126119

0 commit comments

Comments
 (0)