Merge pull request #17957 from awanlin/topic/update-devtools-config-readme

Added note about how secrets are displayed
2023-05-30 11:09:14 +02:00
parent 86b195a3cd a47e05268c
commit c42906cf5f
2 changed files with 7 additions and 0 deletions
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-devtools': patch
+---
+
+Added note to README about how secrets are displayed in the Config tab of the DevTools plugin
@@ -16,6 +16,8 @@ Lists helpful information about your current running Backstage instance such as:

 Lists the configuration being used by your current running Backstage instance.

+**Note:** The Config tab uses the configuration schema [defined by each plugin](https://backstage.io/docs/conf/defining) to be able to mask secrets. It does this by checking that the [visibility](https://backstage.io/docs/conf/defining#visibility) has been marked as `secret`. If this is not set then the secret will appear in clear text. To mitigate this it is highly recommended that you enable the [permission framework](https://backstage.io/docs/permissions/overview) and [apply the proper permissions](#permissions)). If you do see secrets in clear text please contact the plugin's author to get the visibility set to secret for the applicable property.
+
 ![Example of Config tab](./docs/devtools-config-tab.png)

 ## Optional Features