backstage/plugins/puppetdb

PuppetDB Plugin

A frontend plugin to integrate PuppetDB with Backstage. When combined with the catalog-backend-module-puppetdb plugin, this frontend plugin allows viewing PuppetDB reports, including their logs and events, of Backstage resource entities.

Getting started

To get started, you need a running instance of PuppetDB. You can find instructions on how to install it here.

Installation

1. Install the plugin with yarn in the root of your Backstage application directory:

yarn --cwd packages/app add @backstage/plugin-puppetdb

1. Import and use the plugin in packages/app/src/App.tsx:

import { PuppetDbPage } from '@backstage/plugin-puppetdb';

const routes = (
  <FlatRoutes>
    {/* ...other routes */}
    <Route path="/puppetdb" element={<PuppetDbPage />} />
  </FlatRoutes>
);

Configuration

1. Configure puppetdb proxy. As this plugin uses the Backstage proxy to securely communicate with PuppetDB API, add the following to your app-config.yaml to enable this configuration:

proxy:
  '/puppetdb':
    target: https://your.puppetdb.instance.com