Crate bundler

Expand description

§Bundler

An Open Policy Agent (OPA) Bundle Server, supplying permissionalble data from the Diamond Light Source ISPyB database

built_info 🔒: Metadata about the crate, courtesy of built
bundle 🔒: An Open Policy Agent bundle containing permissionables
permissionables 🔒: Permissionable relations from the ISPyB database
require_bearer 🔒: A [tower::Service] which enforces a bearer token requirement

BundleFile 🔒: A wrapper containing a Bundle and the serialzied gzipped archive
BundleSchemaArgs 🔒: Arguments to output the schema with
ServeArgs 🔒: Arguments to run the service with
StaticDataGlob 🔒: Wrapper to ensure that globs passed via the CLI are valid file globs

Cli 🔒: Bundler acts as an Open Policy Agent bundle server, providing permissionable data from the ISPyB database and static data from local files

bundle_endpoint 🔒: Returns the Open Policy Agent bundle in gzipped tar format
bundle_schema 🔒: Outputs the bundle schema as a set of files or to standard output
connect_ispyb 🔒: Creates a connection pool to the ISPyB instance at the provided Url
fallback_endpoint 🔒: Returns a HTTP 404 status code when a non-existant route is queried
fetch_initial_bundle 🔒: Fetches the initial Bundle from ISPyB and any static files, and produces the corresponding BundleFile
health_endpoint 🔒: Returns an HTTP 200 response when requested.
main 🔒
serve 🔒: Runs the service, pulling fresh bundles from ISPyB/local files and serving them via the API
serve_endpoints 🔒: Bind to the provided socket address and serve the application endpoints
setup_telemetry 🔒: Sets up Logging & Tracing using jaeger if available
update_bundle 🔒: Periodically update the bundle with new data from ISPyB and any static files matching the given glob patterns.