Configuration options

This version is out of date. For current versions, see Puppet Enterprise support lifecycle.

There are various configuration options for the RBAC service. Each section can exist in its own file or in separate files.

RBAC service configuration

You can configure the RBAC service's settings to adjust the length of user sessions, the number of times a user can attempt to log in, and the length of time a password reset token is valid. You can also define a whitelist of certificates.

These configuration parameters are not required, but when present must be under the rbac section, as in the following example:

rbac: {
  # Duration in hours that a password reset token is viable
  password-reset-expiration: 24
  # Duration in minutes that a session is viable
  session-timeout: 60
  failed-attempts-lockout: 10


When a user doesn't remember their current password, an administrator can generate a token for them to change their password. The duration, in hours, that this generated token is valid can be changed with the password-reset-expiration config parameter. The default value is 24.


This parameter is a positive integer that specifies how long a user's session should last, in minutes. This session is the same across node classifier, RBAC, and the console. The default value is 60.


This parameter is a positive integer that specifies how many failed login attempts are allowed on an account before that account is revoked. The default value is 10.

Note: If you change this value, create a new file or will Puppet reset back to 10 when it next runs. Create the file in an RBAC section of /etc/puppetlabs/console-services/conf.d.


This parameter is a path for specifying the file that contains the names of hosts that are allowed to use RBAC APIs and other downstream component APIs, such as the Node Classifier and the Activity services. This configuration is for the users who want to script interaction with the RBAC service.

Users must connect to the RBAC service with a client certificate that has been specified in this certificate-whitelist file. A successful match of the client certificate and this certificate-whitelist allows access to the RBAC APIs as the api_user. By default, this user is an administrator and has all available permissions.

The certificate whitelist contains, at minimum, the certificate for the nodes PE is installed on (one certificate for a monolithic install, and three certificates for a split install).

RBAC database configuration

Credential information for the RBAC service is stored in a PostgreSQL database.

The configuration information for that database is found in the 'rbac-database' section of the config.

For example:

rbac-database: {
  classname: org.postgresql.Driver
  subprotocol: postgresql
  subname: "//<path-to-host>:5432/perbac"
  user: <username here>
  password: <password here>


Used by the RBAC service for connecting to the database; this option should always be org.postgresql.Driver.


Used by the RBAC service for connecting to the database; this options should always be postgresql.


JDBC connection path used by the RBAC service for connecting to the database. This should be set to the hostname and configured port of the PostgreSQL database. perbac is the database the RBAC service uses to store credentials.


This is the username the RBAC service should use to connect to the PostgreSQL database.


This is the password the RBAC service should use to connect to the PostgreSQL database.

See an issue? Please file a JIRA ticket in our [DOCUMENTATION] project
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.