prm

README

Puppet Runtime Manager

• Puppet Runtime Manager
  • Overview
  • Installing
    • Unix Systems
    • Windows Systems
  • Requesting a feature
  • Reporting Problems
  • Locally host documentation site
    • Prerequisites
    • Install site
    • Run site
  • Installing Telemetry Free Version
    • Unix Systems
    • Windows Systems

Overview

The Puppet Runtime Manager (PRM) is a tool for validating Puppet content and for running arbitrary development/maintenance tasks against that content.

Check out the docs site for more information.

⚠ PRM is currently in an EXPERIMENTAL phase and feedback is encouraged via prm/discussions and starting a feedback post.

Installing

While PRM is in early release, we provide an archive and a simple script to unpack it. When we move closer to a full release we will add a platform specific installer. Use the install.[ps1|sh] script, depending upon your OS:

Unix Systems

curl -L https://pup.pt/prm/install.sh | sh

Windows Systems

iex "&{ $(irm https://pup.pt/prm/install.ps1); Install-Prm }"

This will install the latest release of PRM to ~/.puppetlabs/prm.

⚠ If you do not use the install script and are extracting the archive yourself, be sure to use the fully qualified path to ~/.puppetlabs/prm on *nix or $HOME/.puppetlabs/prm on Windows when you set your PATH environment variable.

A version of the product, with telemetry functionality disabled, is available too. See here for instructions on how to install it.

Requesting a feature

Open a new feature request in our Github discussion page.

Reporting Problems

If you're having trouble with the experimental PRM tool, please follow these instructions to file an issue on our GitHub repository: https://github.com/puppetlabs/prm/issues/new

Make sure to fill in the information that is requested in the issue template as it will help us investigate the problem more quickly.

Locally host documentation site

The DevX documentation site can be locally hosted and changes made to the markdown files inside of the docs/md/content directory will be visible on the site.

Prerequisites

Essential software that will need to be installed to run the documentation site locally:

• Git version control
• Hugo extended version
• Nodejs and NPM

Install site

To install the documentation site run the following command from the root of this project:

./docs.sh

This will install and run the documentation site. The site can be found at http://localhost:1313/devx. All updates will to the docs/md/content directory will hot reload the site.

To stop the running ctrl + c in the terminal window in which it is running.

Run site

Commands to run the site locally:

# Run without draft pages being displayed
./docs.sh

or

# Run with draft pages being displayed
./docs.sh -D

Installing Telemetry Free Version

We gather telemetry data to provide insights into how our products are being used.

The following data is collected:

• Version of application in use
• OS / platform of the device
• What commands have been invoked (including command args)
• Any errors that occurred when running the application

We understand that there will be some users who prefer to have no telemetry data sent. For those users, we offer a version of PRM with the telemetry functionality disabled.

To install:

Unix Systems

curl -L https://pup.pt/prm/install.sh | sh -s -- --no-telemetry

Windows Systems

iex "&{ $(irm https://pup.pt/prm/install.ps1); Install-Prm -NoTelemetry }"

This will install the latest release of PRM, without telemetry functionality, to ~/.puppetlabs/prm.