Getting started


The Puppet Discovery installation file is a lightweight binary or executable for Linux, macOS, or Windows, and once installed, Puppet Discovery consists of a number of Docker containers that require minimal configuration to discover every host, package, and container running on your infrastructure.

Before you begin

Make sure you have read the system requirements and installed Discovery.

To get you on your way to discovering resources running on your infrastructure, the first-time workflow guides you through adding sources and host credentials. This example workflow describes how to add an Amazon Web Services source to discover EC2 instances, enter your SSH host credentials to discover resources, and use the dashboard to view resource attributes discovered on a specific EC2 instance.

  1. Using the admin or viewer username and the password you specified during installation, log in to Puppet Discovery.
  2. Click Start discovering to view the Add your sources page, and then click Amazon Web Services.
  3. To authenticate Puppet Discovery with your AWS account, enter your AWS security credentials, and click Discover.

    The Add your source page appears, displaying your AWS source in the Your Sources cart.

  4. Click Continue to view the Add your host credentials page, and then click SSH private key file.
  5. Add your AWS key pair private key for your hosts that use SSH, and click Configure keys.
  6. Enter your SSH username, assign a scope to each SSH credential, and click Add keys.

    The Add your host credentials page appears, displaying your credential in the Your host credentials cart.

    The discovery process starts to locate your EC2 instances and discover resources on each host.

  7. Click View dashboard.

    The dashboard appears, consisting of dashboard cards that display metrics about your infrastructure.

    For example, the Top cloud instances by region dashboard card displays metrics relating to your discovered EC2 instances.

  8. Click the Top cloud by instances card.

    The Cloud instances by region summary page appears, listing your discovered EC2 instances, the IP address, operating system, and the version of operating system of each instance, as well as the region the instance exists.

  9. To drill down for deeper insights into a host, click the host Name.

    The host details page appears, displaying the attributes, services, the users and groups, packages, tags, and containers associated with the host.

How helpful was this page?
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.