forked from voxpupuli/puppet-lldpd
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfile.README.html
161 lines (118 loc) · 5.31 KB
/
file.README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
File: README
— Documentation by YARD 0.9.10
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
pathId = "";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="file_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index</a> »
<span class="title">File: README</span>
</div>
<div id="search">
<a class="full_list_link" id="puppet_class_list_link"
href="puppet_class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><div id='filecontents'><h1>puppet-lldpd</h1>
<p><a href="https://travis-ci.org/voxpupuli/puppet-lldpd"><img src="https://travis-ci.org/voxpupuli/puppet-lldpd.svg?branch=master" alt="Build Status"></a>
<a href="https://forge.puppetlabs.com/puppet/lldpd"><img src="https://img.shields.io/puppetforge/v/puppet/lldpd.svg" alt="Puppet Forge"></a>
<a href="https://forge.puppetlabs.com/puppet/lldpd"><img src="https://img.shields.io/puppetforge/dt/puppet/lldpd.svg" alt="Puppet Forge - downloads"></a>
<a href="https://forge.puppetlabs.com/puppet/lldpd"><img src="https://img.shields.io/puppetforge/e/puppet/lldpd.svg" alt="Puppet Forge - endorsement"></a>
<a href="https://forge.puppetlabs.com/puppet/lldpd"><img src="https://img.shields.io/puppetforge/f/puppet/lldpd.svg" alt="Puppet Forge - scores"></a>
<a href="https://voxpupuli.org/puppet-lldpd"><img src="https://img.shields.io/badge/yard-docs-blue.svg" alt="Yard Docs"></a>
<a href="LICENSE"><img src="https://img.shields.io/github/license/voxpupuli/puppet-lldpd.svg" alt="AGPL v3 License"></a></p>
<h2>Table of Contents</h2>
<ol>
<li><a href="#overview">Overview</a></li>
<li><a href="#setup">Setup</a></li>
<li><a href="#support">Support</a></li>
<li><a href="#development">Development</a></li>
<li><a href="#authors">Authors</a></li>
</ol>
<hr>
<h2>Overview</h2>
<p>LLDP stands for Link Layer Discovery Protocol. This module manages the LLDP
implementation from <a href="https://vincentbernat.github.io/lldpd/">Vincent Bernat</a>.
<a href="https://github.com/puppetlabs/puppet-strings#puppet-strings">puppet-strings</a>
docs are available in <a href="/docs">/docs</a>. They are generated before each release.
This module configures the upstream repo if necessary. The LLDP requires a
daemon, which will be started. the command line client has support for json
output. This is used to create a structured fact. It is updated automatically
with a systemd timer (or a cronjob on legacy systems).</p>
<h2>Setup</h2>
<p>This is very easy:</p>
<pre class="code puppet"><code class="puppet">include lldpd
</code></pre>
<p>You can disable the repo management:</p>
<pre class="code puppet"><code class="puppet">class{'lldpd':
manage_repo => false,
}
</code></pre>
<h2>Support</h2>
<p>This module supports the installation on:</p>
<ul>
<li>Archlinux</li>
<li>CentOS 6</li>
<li>CentOS 7</li>
<li>Fedora 25</li>
<li>Fedora 26</li>
<li>Fedora 27</li>
<li>Debian 8</li>
<li>Debian 9</li>
<li>Ubuntu 14.04</li>
<li>Ubuntu 16.04</li>
<li>Virtuozzo Linux 6</li>
<li>Parallels Cloud Server Bare Metal 5</li>
<li>FreeBSD</li>
</ul>
<p>The fact is present on all Operating Systems except for FreeBSD. Docker
acceptance tests work for CentOS 6 and 7. Vagrant acceptance tests work for
Fedora 25. Other nodesets are currently not present. The module requires at
least Puppet 4.9.4 (this is the first version with proper data-in-modules
support).</p>
<h2>Development</h2>
<p>This project contains tests for <a href="http://rspec-puppet.com/">rspec-puppet</a>.</p>
<p>Quickstart to run all linter and unit tests:</p>
<pre class="code bash"><code class="bash">bundle install --path .vendor/ --without system_tests --without development --without release
bundle exec rake test
</code></pre>
<p>For acceptance tests:</p>
<pre class="code bash"><code class="bash">bundle install --path .vendor/ --with system_tests --without development --without release
BEAKER_debug=true PUPPET_INSTALL_TYPE=agent bundle exec rake beaker:fedora-25-x64
BEAKER_debug=true PUPPET_INSTALL_TYPE=agent bundle exec rake acceptance BEAKER_set=docker/centos-7
</code></pre>
<h2>Authors</h2>
<p>puppet-lldpd is maintained by <a href="https://voxpupuli.org">Vox Pupuli</a>, it was written by <a href="https://github.com/bastelfreak">Tim 'bastelfreak' Meusel</a>.</p>
</div></div>
<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>
</div>
</body>
</html>