Allow me to RE-introduce the DevTools plugin! 馃О #17393
Conversation
Changed Packages
|
|
@adamdmharvey @sennyeya @regicsolutions @efenner-cambia @webark just a heads up that I moved PR #1642 to my work account and moved it to ready so that I can more easily get it merged in. Thanks a ton for your patience, just a bit longer as I work though getting this reviewed now 馃殌 |
|
Uffizzi Preview |
There was a problem hiding this comment.
Posted this to my internal team, I think this could really help us, so eager to see this one through! 馃憦馃徎
One thing I'm not clear about is the permissioning? I see the file defining it, but I don't see any instructions in a README or anything about how to set it? Maybe I missed it? i.e. how would an adopter configure the permissions to limit this route? oof, yeah missed it. it's complicated :) not your doing, but we've just not implemented any permissions yet so a lot to dig into, but something we can do.
There was a problem hiding this comment.
Looks great, @awanlin !
Re: the @packageDocumentation, with them set, it'll flesh out the microsite's API Reference index here: https://backstage.io/docs/reference/
So having something so they're not blank is just a nice way to better elevate them.
Thanks, look forward to trying this one out!! 馃憦馃徎
|
This looks great! Is it possible to configure any external dependency through the config? Looking forward to test it 馃榿 |
Yes you can configure them using the config, there details on how to do that are in the frontend The idea is really around dependencies that your Backstage instance might need to connect to not something more global. We used this to help us identify firewall issues connection to services/APIs we needed to be able to pull data from. If we got reports of something not working we could also check here to quickly validate what's going on |
There was a problem hiding this comment.
Hey 馃憢 thanks for this @awanlin! Really well written plugin 馃憤
Some higher level comments, but it's looking pretty good to me.
| } | ||
|
|
||
| public async listConfig(): Promise<ConfigInfo> { | ||
| /* eslint-disable-next-line no-restricted-syntax */ |
There was a problem hiding this comment.
@Rugvip is this the best way to grab all the configs and omit secrets or is there an easier way?
There was a problem hiding this comment.
There were a couple of comments about this in the initial Draft PR:
.../devtools/src/components/Content/ExternalDependenciesContent/ExternalDependenciesContent.tsx
Show resolved
Hide resolved
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
awanlin
force-pushed
the
topic/re-introduce-devtools-plugin
branch
from
715648b
to
155cfab
Compare
|
Thanks for the initial review @benjdlambert, ready for another look when you have time 馃憤 |
|
Thank you for contributing to Backstage! The changes in this pull request will be part of the |
Hey, I just made a Pull Request!
Allow me to RE-introduce the DevTools plugin - another handy tool to add to your Backstage 馃О ! This will close #9737 and hopefully open a world of new features to help Backstage Adopters who run the Ops side of things 馃槈
Note: I've moved this to my work account so that I can more easily get this merged in; the previous Draft PR is #14642
The plugin offers the following features:
Lists info about your current Backstage instance - OS, NodeJS version, Backstage version and packages:
Lists the config being used by your current Backstage instance:
There's also an optional tab where you can list connectivity with External Dependencies:
The plugin has also been designed so you can customize the tabs - remove them, add them, and/or create your own.
Support for the permissions framework is included in an open way so that you can control this as best fits your needs. There is detailed guidance in the plugin's
README.mdon this topic.鉁旓笍 Checklist
Signed-off-byline in the message. (more info)