Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 2.33 KB

README.md

File metadata and controls

63 lines (42 loc) · 2.33 KB
Raw

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

Prerequisites

To get started, you need a running instance of PuppetDB. You can find instructions on how to install it here. The PuppetDB should be configured to allow being accessed from your Backstage instance.

In addition, your Backstage instance need to either have catalog-backend-module-puppetdb plugin installed or you need to ensure your Resource entities have puppet.com/certname annotation set to the PuppetDB node name in some other way.

Installation

  1. Install the plugin with yarn in the root of your Backstage application directory:
yarn --cwd packages/app add @backstage-community/plugin-puppetdb
  1. Import and use the plugin in packages/app/src/App.tsx:
import { PuppetDbPage } from '@backstage-community/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

Screenshots

Main page with the reports list:

Reports list

Events for the specific report:

Events

Logs of the specific report:

Logs