Puppet Enterprise database maintenance

If PE’s databases become sluggish or begins taking up too much disk space, there are several maintenance tasks that can improve their performance.

Databases in Puppet Enterprise

PE uses PostgreSQL as the backend for its databases.

We recommend that you use PostgreSQL’s native tools to perform database exports and imports. At a minimum, we recommend nightly backups to a remote system, or as dictated by your company policy.

The PE PostgreSQL database includes the following databases:

Database Description
pe-activity Activity data from the Classifier, including who, what and when
pe-classifier Classification data, all Node Group information
pe-puppetdb PuppetDB’s data, including exported resources, catalogs, facts, and reports
pe-rbac RBAC data, including users, permissions, and AD/LDAP info
pe-orchestrator orchestrator data, including details about job runs (users, nodes, and run results)

Optimizing your databases

In some cases you may find your databases are slow or need general performance enhancements. The PostgreSQL vacuum command can help optimize your databases.

  1. To vacuum a particular database, run the following command:

    su - pe-postgres -s /bin/bash -c "vacuumdb -z --verbose <DATABASE NAME>"
    

The available databases are pe-activity, pe-classifier, pe-puppetdb, and pe-rbac.

Complete database backup and restore

You should perform regular backups of your Puppet Enterprise databases. The pg_dumpall command dumps the complete set of PE databases to an SQL file on disk. After you’ve created a back up of your PE databases, you can restore them at any time.

Before beginning, review the following information:

  • All back up and restore commands must be run as the pe-postgres user.

  • It isn’t necessary to stop any PE services to perform these steps.

  1. To back up the entire PE PostgreSQL database, run the following command:

    sudo -u pe-postgres /opt/puppetlabs/server/apps/postgresql/bin/pg_dumpall -c -f <BACKUP_FILE>.sql
    

    Note: The name and location of your .sql can be changed as needed.

  2. To begin the restore, stop all PE services except for pe-postgres. Run the following commands:

    puppet resource service puppet ensure=stopped
    puppet resource service pe-puppetserver ensure=stopped
    puppet resource service pe-puppetdb ensure=stopped
    puppet resource service pe-console-services ensure=stopped
    puppet resource service pe-orchestration-services ensure=stopped
    puppet resource service pe-nginx ensure=stopped
    
  3. When restoring the ‘pe-postgres’ user needs read access to the SQL file created when the database was backed up. Run the following command to perform the restore:

    sudo -u pe-postgres /opt/puppetlabs/server/apps/postgresql/bin/psql < <BACKUP_FILE>.sql
    

    This command will import the complete PE PostgreSQL database backup you created in the procedure above.

  4. Start all PE services. Run the following commands:

    puppet resource service puppet ensure=running
    puppet resource service pe-puppetserver ensure=running
    puppet resource service pe-puppetdb ensure=running
    puppet resource service pe-console-services ensure=running
    puppet resource service pe-orchestration-services ensure=running
    puppet resource service pe-nginx ensure=running
    

Individual database backup and restore

You can perform regular backups of individual Puppet Enterprise databases. The pg_dump command dumps an individual databases to an SQL file on disk, which you can restore at any time.

NOTE: All back up and restore commands must be run as the pe-postgres user.

  1. To backup an individual PE PostgreSQL database, run the following command:

    sudo -u pe-postgres /opt/puppetlabs/server/apps/postgresql/bin/pg_dump -Fc <DATABASE_NAME> -f <BACKUP_FILE>.bin
    

    This command creates a binary dump of the database. The pe-postgres user needs write access to the output destination.

  2. To restore an individual PE PostgreSQL database backup, run the following command:

    sudo -u pe-postgres /opt/puppetlabs/server/apps/postgresql/bin/pg_restore -Cc -d template1 <BACKUP_FILE>.bin
    

    This command will connect to the template1 database and then drop the database indicated in .bin before re-creating that database and connecting to the newly created database to perform the restoration.

    If you omit the -d parameter, pg_restore will output the SQL commands needed to restore a database to the console, but it will not perform the actual restoration.

  3. After restoring that database, you manually fix access privileges for that database. Run the following command:

    puppet infrastructure configure
    

↑ Back to top