Git Product home page Git Product logo

puppet-lldpd's Introduction

puppet-lldpd

Build Status Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores Yard Docs AGPL v3 License

Table of Contents


Overview

LLDP stands for Link Layer Discovery Protocol. This module manages the LLDP implementation from Vincent Bernat. puppet-strings docs are available in /docs. 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).

Setup

This is very easy:

include lldpd

You can disable the repo management:

class{'lldpd':
  manage_repo => false,
}

Support

This module supports the installation on:

  • Archlinux
  • CentOS 6
  • CentOS 7
  • Fedora 25
  • Fedora 26
  • Fedora 27
  • Debian 8
  • Debian 9
  • Ubuntu 14.04
  • Ubuntu 16.04
  • Ubuntu 18.04
  • Virtuozzo Linux 6
  • Parallels Cloud Server Bare Metal 5
  • FreeBSD 11

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

Reference

The main class provides an interface that can be used. It can be configured via the upcoming parameters. All other classes are internal and can't be accessed directly.

$manage_facts

This is a boolean, it defaults to true on all systems except for the CentOS family (see limitations. If true, the module will provide a script to run lldpctl and save the output as json as structured fact. A systemd timer or a cronjob will be deployed to execute the script periodically. This decouples the fact generation from the actual facter/puppet.

$manage_service

Boolean, if true, the module will enable the service. Defaults to true.

$manage_repo

Boolean, if true, the module will setup the upstream repository. Defaults to true on Debian and CentOS family.

$manage_jq

Boolean. jq is a dependency needed for the fact generation. This module can install it. Defaults to true on all systems except for CentOS. See also limitations.

$repourl

String, part of the upstream repository URL. The module provides sane defaults for all repositories. There should be no need to set this parameter.

$gpgkeyfingerprint

String. The ID from the key that's used to sign the packages. Currently only used for the apt repo.

$ensure

String, allowed values are present, absent and latest. This sets the status of the lldpd package.

Limitations

The facts require jq to work. The installation can be configured with $manage_jq. This is disabled on CentOS machines. You can install it on CentOS if you configure the EPEL repository.

Development

This project contains tests for rspec-puppet.

Quickstart to run all linter and unit tests:

bundle install --path .vendor/ --without system_tests --without development --without release
bundle exec rake test

For acceptance tests:

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

Authors

puppet-lldpd is maintained by Vox Pupuli, it was written by Tim 'bastelfreak' Meusel.

puppet-lldpd's People

Contributors

bastelfreak avatar ekohl avatar juniorsysadmin avatar kengelhardt-godaddy avatar llowder avatar tragiccode avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.