From 1cb55c667ec63d1688baf52750057f057870c601 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Mon, 21 Mar 2022 14:12:28 +0100 Subject: [PATCH] add readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- contrib/catalog/README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 contrib/catalog/README.md diff --git a/contrib/catalog/README.md b/contrib/catalog/README.md new file mode 100644 index 0000000000..e02760cdb0 --- /dev/null +++ b/contrib/catalog/README.md @@ -0,0 +1,27 @@ +# Catalog Contrib + +This directory contains various community contributions related to [the Backstage catalog](https://backstage.io/docs/features/software-catalog/software-catalog-overview). + +There is no guarantee of correctness or fitness of purpose of these +contributions, but we hope that they are helpful to someone! + +Installation instructions are generally in the doc comment on top of each class. + +## ImmediateEntityProvider + +Sometimes we get requests for the ability to POST/PUT entities directly to the +catalog, instead of its regular mode of operation where it pulls data from +authoritative sources itself. + +The core product does not intend to support this use case, since it comes with a +number of caveats. However, this entity provider demonstrates how to build a +very basic version of such functionality yourself. It does not offer any +protection from misuse, but can serve as a good starting point to build out such +a provider yourself, fit for your particular needs. + +## LoadTestingEntityProvider + +This is a trivial little test bed entity provider that lets you make huge batch +operations and get some timings back. It also tries to clean up after itself +when it's done. This can be useful if you are working on optimizing the catalog +itself, or on processors or similar that you add to it.