Puppet Discovery is a software application service that forages across a wide range of data sources, and provides visualizations to give you a comprehensive understanding about the state of your heterogeneous infrastructure.

Analyze real-time data on the Puppet Discovery dashboard, and take action to enable intelligent management of your entire infrastructure, from on-premises servers to EC2 instances. Drill down in the dashboard to view detailed inventories for each server or container, locate specific package versions, or install a Puppet agent to improve your server management.

The dashboard analytics include:

  • Percentage of servers that are on-premises, AWS, or managed by Puppet

  • Total number of unique packages, containers, or Docker hosts

  • Percentage of Linux versus Windows machines

  • Top seven containers by image, or servers by operating system

Getting started

To get started with Discovery:

  • Download and run the install script.

  • Add data sources to forage, and the credentials to access those sources.

  • Explore the dashboard.

Note: This is tech preview documentation and might contain inaccuracies. The capabilities it describes are also tech preview. Because they are still under development, Puppet doesn't guarantee the stability of the capabilities.

System Requirements

Before you install Puppet Discovery, ensure your system meets these requirements. 

Operating systems

Puppet Discovery can be installed on these operating systems:
Operating systemVersionsPrerequisites
Mac OS X 10.10, 11, 12.VirtualBox.

Windows

10.Hyper-V, and Windows Management Framework 5.0 or 5.1.
LinuxVirtualBox.
Puppet Discovery can forage data on these operating systems:
Operating SystemVersions

CentOS

6 or higher
Debian7 or higher
Red Hat Enterprise Linux6 or higher
SUSE Linux Enterprise Server12
Ubuntu14.04, 16.04
Windows Server 2008 or higher

Hardware

Puppet Discovery requires:
Disk space20.0 GB
Memory4.0 GB
CPUs2

Browsers

Puppet Discovery supports these browsers:

  • Google Chrome

  • Apple Safari

  • Mozilla Firefox

  • Microsoft Edge

Installing

Puppet Discovery runs on a small Kubernetes cluster that you install on a workstation. The installation process takes between five and ten minutes.

  1. Download the Puppet Discovery script and install:
    Mac/Linux:
    curl -Lo puppet-discovery.sh http://pup.pt/puppet-discovery && chmod +x ./puppet-discovery.sh && ./puppet-discovery.sh install
    Windows (as administrator):
    Set-ExecutionPolicy Bypass -Scope Process; Invoke-WebRequest -Uri 'http://pup.pt/puppet-discovery-windows' -OutFile .\puppet-discovery.ps1
    .\puppet-discovery.ps1 install
  2. To view the list of available commands, run the help command:
    Mac OS X/Linux
    ./puppet-discovery.sh help
    Windows (as administrator):
    .\puppet-discovery.ps1 help
  3. To open Puppet Discovery in your browser, run the open command:
    Mac OS X/Linux:
    ./puppet-discovery.sh open
    Windows (as administrator):
    .\puppet-discovery.ps1 open
  4. To uninstall Puppet Discovery, run the uninstall command:
    Mac OS X/Linux:
    ./puppet-discovery.sh uninstall
    Windows (as administrator):
    .\puppet-discovery.ps1 uninstall

Configuring

Puppet Discovery forages data from multiple data sources to display a rich data set on the dashboard, providing you with a complete picture of your whole infrastructure.

To configure Puppet Discovery, add your data sources and the corresponding credentials. Discovery requires root user credentials for Linux sources, and Administrator credentials for Windows sources.

  1. On the Welcome screen, click Let's start.
  2. On the Connect to infrastructure screen, enter a unique and descriptive name for your data source.
  3. Select your data source.

    To identify your server data sources, enter the IP address or fully qualified domain name (FQDN) of each server you want to forage.

    To authenticate Puppet Discovery with your AWS account, enter your AWS access key ID and secret access key.

  4. Click Add.
  5. On the Add your credential screen, enter a unique and descriptive name for your credential.
  6. To forage the servers you previously listed, enter your SSH key or WinRM credentials.
  7. Click Connect.

The Puppet Discovery dashboard appears, displaying your infrastructure data. Drill down in each dashboard card to see details about your infrastructure, start and stop services, and optionally install Puppet agent on nodes.

Back to top