Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bodgit/puppet-portmap

Puppet Module for managing the RPC port mapper
https://github.com/bodgit/puppet-portmap

portmap puppet

Last synced: 1 day ago
JSON representation

Puppet Module for managing the RPC port mapper

Awesome Lists containing this project

README

        

# portmap

[![Build Status](https://img.shields.io/github/workflow/status/bodgit/puppet-portmap/Test)](https://github.com/bodgit/puppet-portmap/actions?query=workflow%3ATest)
[![Codecov](https://img.shields.io/codecov/c/github/bodgit/puppet-portmap)](https://codecov.io/gh/bodgit/puppet-portmap)
[![Puppet Forge version](http://img.shields.io/puppetforge/v/bodgit/portmap)](https://forge.puppetlabs.com/bodgit/portmap)
[![Puppet Forge downloads](https://img.shields.io/puppetforge/dt/bodgit/portmap)](https://forge.puppetlabs.com/bodgit/portmap)
[![Puppet Forge - PDK version](https://img.shields.io/puppetforge/pdk-version/bodgit/portmap)](https://forge.puppetlabs.com/bodgit/portmap)

#### Table of Contents

1. [Description](#description)
2. [Setup - The basics of getting started with portmap](#setup)
* [Beginning with portmap](#beginning-with-portmap)
3. [Usage - Configuration options and additional functionality](#usage)
4. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)

## Description

This module manages the RPC port mapper.

RHEL/CentOS, Ubuntu, Debian and OpenBSD are supported using Puppet 5 or
later.

## Setup

### Beginning with portmap

In the very simplest case, you can just include the following:

```puppet
include portmap
```

## Usage

The port mapper exposes no configuration options so the above example is all
that is necessary.

## Reference

The reference documentation is generated with
[puppet-strings](https://github.com/puppetlabs/puppet-strings) and the latest
version of the documentation is hosted at
[https://bodgit.github.io/puppet-portmap/](https://bodgit.github.io/puppet-portmap/)
and available also in the [REFERENCE.md](https://github.com/bodgit/puppet-portmap/blob/main/REFERENCE.md).

## Limitations

This module has been built on and tested against Puppet 5 and higher.

The module has been tested on:

* Red Hat/CentOS Enterprise Linux 6/7/8
* Ubuntu 16.04/18.04/20.04
* Debian 9/10
* OpenBSD 6.9

## Development

The module relies on [PDK](https://puppet.com/docs/pdk/1.x/pdk.html) and has
both [rspec-puppet](http://rspec-puppet.com) and
[Litmus](https://github.com/puppetlabs/puppet_litmus) tests. Run them
with:

```
$ bundle exec rake spec
$ bundle exec rake litmus:*
```

Please log issues or pull requests at
[github](https://github.com/bodgit/puppet-portmap).