diff --git a/.changeset/itchy-bulldogs-hunt.md b/.changeset/itchy-bulldogs-hunt.md index 1e5a8a81d4..9dbc81ab21 100644 --- a/.changeset/itchy-bulldogs-hunt.md +++ b/.changeset/itchy-bulldogs-hunt.md @@ -2,4 +2,4 @@ '@backstage/plugin-puppetdb': patch --- -Initial version of PuppetDB plugin. +Initial version of [PuppetDB plugin](https://github.com/backstage/backstage/blob/master/plugins/puppetdb/README.md). diff --git a/microsite/data/plugins/puppetdb.yaml b/microsite/data/plugins/puppetdb.yaml index 6cbc1cf422..e56fb20a6d 100644 --- a/microsite/data/plugins/puppetdb.yaml +++ b/microsite/data/plugins/puppetdb.yaml @@ -5,7 +5,7 @@ authorUrl: https://github.com/tdabasinskas category: Configuration Management description: Visualize resource information and Puppet facts from PuppetDB. documentation: https://github.com/backstage/backstage/blob/master/plugins/puppetdb/README.md -iconUrl: https://avatars.githubusercontent.com/u/234268?s=200&v=4 +iconUrl: https://upload.wikimedia.org/wikipedia/commons/thumb/9/97/Puppet_boxes_logo.svg/800px-Puppet_boxes_logo.svg.png npmPackageName: '@backstage/plugin-puppetdb' tags: - puppet diff --git a/plugins/puppetdb/README.md b/plugins/puppetdb/README.md index 45349d518e..c4fa06b874 100644 --- a/plugins/puppetdb/README.md +++ b/plugins/puppetdb/README.md @@ -4,12 +4,17 @@ A frontend plugin to integrate PuppetDB with Backstage. When combined with the [catalog-backend-module-puppetdb](https://github.com/backstage/backstage/blob/master/plugins/catalog-backend-module-puppetdb/README.md) plugin, this frontend plugin allows viewing PuppetDB reports, including their logs and events, of Backstage resource entities. -![Reports list](https://raw.githubusercontent.com/backstage/backstage/42b65232e763d3e39e2e641b105d2ad469db7a59/plugins/puppetdb/assets/Reports.png) - ## Getting started +### Prerequisites + To get started, you need a running instance of PuppetDB. You can find instructions on how to install it [here](https://www.puppet.com/docs/puppetdb/7/install_via_module.html). +The PuppetDB [should be configured](https://www.puppet.com/docs/puppetdb/7/configure.html#host) to allow being accessed from your Backstage instance. + +In addition, your Backstage instance need to either have +[catalog-backend-module-puppetdb](https://github.com/backstage/backstage/blob/master/plugins/catalog-backend-module-puppetdb/README.md) 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 @@ -42,3 +47,17 @@ proxy: '/puppetdb': target: https://your.puppetdb.instance.com ``` + +## Screenshots + +#### Main page with the reports list: + +![Reports list](https://raw.githubusercontent.com/backstage/backstage/42b65232e763d3e39e2e641b105d2ad469db7a59/plugins/puppetdb/assets/Reports.png) + +#### Events for the specific report: + +![Events](https://raw.githubusercontent.com/backstage/backstage/1b39e86db17f139dc995f02daca4896533e53eb0/plugins/puppetdb/assets/Events.png) + +#### Logs of the specific report: + +![Logs](https://raw.githubusercontent.com/backstage/backstage/1b39e86db17f139dc995f02daca4896533e53eb0/plugins/puppetdb/assets/Logs.png)