paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 39 Packages Projects Releases Wiki Activity

Address review comments

Browse Source 
Signed-off-by: Tomas Dabasinskas <tomas@dabasinskas.net>
This commit is contained in:
Tomas Dabasinskas
2023-04-06 16:54:12 +03:00
parent c2a1ed21ce
commit bb41dd5560
3 changed files with 23 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/puppetdb/README.md
+21 -2
View File
@@ -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)