Configuring the console

After installing Puppet Enterprise, you can change product settings to customize the console's behavior. Many settings can be configured in the console itself.

Configure the PE console and console-services

Configure the behavior of the console and console-services, as needed.

Note: Use the Hiera or pe.conf method to configure non-profile classes, such as puppet_enterprise::api_port and puppet_enterprise::console_services::no_longer_reporting_cutoff.

To configure settings in the console:

  1. Click Node groups, and select the node group that contains the class you want to work with.
  2. On the Classes tab, find the class you want to work with, select the Parameter name from the list and edit its value.
  3. Click Add parameter and commit changes.
  4. On the nodes hosting the primary server and console, run Puppet.

Console and console-services parameters

Use these parameters to customize the behavior of the console and console-services. Parameters that begin with puppet_enterprise::profile can be modified from the console itself. See the configuration methods documents for more information on how to change parameters in the console or Hiera.

Default: "600" (seconds).
Integer specifying how many failed login attempts are allowed on an account before that account is revoked.
Default: "10" (attempts).
Integer representing, in hours, how long a user's generated token is valid for. An administrator generates this token for a user so that they can reset their password.
Default: "24" (hours).
Integer representing, in minutes, how long a user's session can last. The session length is the same for node classification, RBAC, and the console.
Default: "60" (minutes).
Integer representing the maximum allowable period that a console session can be valid. To not expire before the maximum token lifetime, set to '0'.
A value representing the default authentication lifetime for a token. It cannot exceed the rbac_token_maximum_lifetime. This is represented as a numeric value followed by "y" (years), "d" (days), "h" (hours), "m" (minutes), or "s" (seconds). The default is "1h".
A value representing the maximum allowable lifetime for all tokens. This is represented as a numeric value followed by "y" (years), "d" (days), "h" (hours), "m" (minutes), or "s" (seconds). The default is "10y".
Integer representing the port that the console is available on.
Default: [443]
Nginx listen address for the console.
Default: ""
Default: "false"
Default: "false"
Modify these configuration parameters in Hiera or pe.conf, not the console:
SSL port that the node classifier is served on.
Default: [4433]
Default: 3600 (seconds)
The password to log into the console, for example "myconsolepassword".
Default: Specified during installation.

Manage the HTTPS redirect


Customize the HTTPS redirect target URL

By default, the redirect target URL is the same as the FQDN of your primary server, but you can customize this redirect URL.

To change the target URL in the console:
  1. Click Node groups, and select the PE Infrastructure node group.
  2. On the Classes tab, find the puppet_enterprise::profile::console::proxy::http_redirect class, select the server_name parameter from the list, and change its value to the desired server.
  3. Click Add parameter and commit changes.

Disable the HTTPS redirect


  1. Add the following to your default .yaml file with the parameter set to false.
  2. To compile changes, run puppet agent -t on the primary server.

Enable data editing in the console


  1. On your primary server, edit /etc/puppetlabs/puppet/hiera.yaml to add:
    - name: "Classifier Configuration Data"
      data_hash: classifier_data        
    Note: If you enable data editing in the console, add both Set environment and Edit configuration data to groups that set environment or modify class parameters in order for users to make changes.
  2. If your environment is configured for disaster recovery, update hiera.yaml on your replica.

Add custom PQL queries to the console

Add your own PQL queries to the console and quickly access them when running jobs.

  1. On the primary sever, as root, copy the custom_pql_queries.json.example file and remove the example suffix.
  2. Edit the file contents to include your own PQL queries or remove any existing queries.
  3. Refresh the console UI in your browser.
You can now see your custom queries in the PQL drop down options when running jobs.