DocsPuppet Discovery
Configuring Discovery

Configuring Discovery

Sections

After you've installed Puppet Discovery, administer the application by using the CLI, setting override configurations, or disabling analytics data collection.

Command line options

The command line interface (CLI) provides additional administrative and troubleshooting options beyond using the user interface.

macOS/Linux usage:

./puppet-discovery command

Windows usage:

.\puppet-discovery.exe command
CommandDescription
config View and modify the configuration.
delete Deletes and removes the instance of the Puppet Discovery application. It also deletes all Puppet Discovery data.
export Export the Discovery images in a tar file. See Installing in offline mode.
help Displays the help commands.
import Import the Discovery images in a tar file. See Installing in offline mode.
logs Displays Puppet Discovery logs.
mayday Creates a mayday tarball for troubleshooting with the Puppet support team.
open Displays the log in page.
reset Deletes all Puppet Discovery data, and resets the application to a newly installed state.
restart Restarts the Puppet Discovery service and displays the log in page.
start Starts the Puppet Discovery service and displays the log in page.
status Displays the current status of the Puppet Discovery deployment.
stop Stops the Puppet Discovery service.
update Updates the Puppet Discovery application to the latest version. See Updating Discovery.
version Displays the current version of the Puppet Discovery application.

Configuration overrides

After you've installed Puppet Discovery, optimize it for your environment by configuring and tuning settings as needed.

To override a configuration value, run:

Mac OS X/Linux:

./puppet-discovery config set-override key value

Windows:

.\puppet-discovery.exe config set-override key value

The following configuration values can be modified.

KeyDescriptionValue
controller.interval The interval between each discovery run. every 4h
controller.loglevel The logging levels for the controller.


                                        INFO  (default)
DEBUG
WARN
ERROR
FATAL
PANIC
                                    

edge.discoworkers The maximum number of discovery jobs that run in parallel. 512
edge.taskworkers The maximum number of task jobs that run in parallel. 32
edge.workertimeout The time out value, in minutes, for each job. 25
edge.loglevel The logging levels for the edge.


                                        WARN (default)
INFO
DEBUG
ERROR
FATAL
PANIC
                                    

ingress.ipv6enabled Enable IPv6 on ingress. true
pdp.tll The interval, in minutes, checks are made for resources older than the TLL interval. 60
pdp.tllWindow The TLL interval of when resources are deleted.12h

Set analytics data collection

The user interface (UI) automatically collects data about how you use Puppet Discovery. If you want to opt out of providing this data, you can do so, after installing.

What data does Puppet Discovery collect?

When Puppet Discovery starts, and restarts, it collects the following information:
  • Browser name and version.

  • Device type.

  • Form submission events, but not form input data.

  • Geographic data inferred by the IP address.

  • IP address.

  • JavaScript exceptions.

  • Link, button, and form element clicks.

  • Operating system and version.

  • Pageviews.

  • Session durations.

How does sharing this data benefit you?

We use the data to identify organizations that could be affected by a security issue, alert them to the issue, and provide them with steps to take or fixes to download. In addition, the data helps us understand how people use the product, which helps us improve the product to meet your needs.

How does Puppet use the collected data?

The data we collect is one of many methods we use for learning about our customers. The more we know, the better we can address your needs. For example, understanding how you navigate through the web interface can help us optimize the navigation so that you can complete your work faster. And, learning what kinds of data sources you use helps us to prioritize new functionality like increasing how many resources we can discover for those sources.

Opt out after installing

If you have already installed Puppet Discovery, and want to disable data collection, run this command:

macOS/Linux:

./puppet-discovery config opt-out-analytics true

Windows:

.\puppet-discovery.exe config opt-out-analytics true
How helpful was this page?
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.