Files
backstage/plugins/search-backend-node
MT Lewis f6389e9e5d search-backend-node: track document visibility permission by type in IndexBuilder
Tracking permissions by collator ensures that all the documents of a
given type are authorized using the same permission. This is not
critical for result-by-result authorization, but will likely be a
useful constraint when adding in-engine permission filtering to
specific search engines in the future.

Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2022-01-25 13:01:38 +00:00
..
2022-01-13 14:23:13 +00:00

search-backend-node

This plugin is part of a suite of plugins that comprise the Backstage search platform. This particular plugin is responsible for all aspects of the search indexing process, including:

  • Providing connections to search engines where actual document indices live and queries can be made.
  • Defining a mechanism for plugins to expose documents that they'd like to be indexed (called collators).
  • Defining a mechanism for plugins to add extra metadata to documents that the source plugin may not be aware of (known as decorators).
  • A scheduler that, at configurable intervals, compiles documents to be indexed and passes them to a search engine for indexing.
  • A builder class to wire up all of the above.
  • Naturally, types for all of the above.

Documentation on how to develop and improve the search platform is currently centralized in the search plugin README.md.

For a better overview of how the search platform is put together, check the Backstage Search Architecture documentation.