egress

module

v0.6.0 Latest Latest Go to latest Published: Apr 10, 2026 License: BSD-3-Clause

Details

[!WARNING] This repository is under development and is not production ready.

UCL ARC TRE egress service is an internal API which provides a layer on top of a storage backend to track file approvals prior to download.

See Egress service system context for an overview of how this service interracts with other systems and actors.

Install using helm

helm install egress oci://ghcr.io/ucl-arc-tre/charts/egress \
  --version 0.6.0

See the documentation on component architecture and operation flows for details.

Path	Synopsis
cmd
e2e
storage-server command A minimal generic storage server used in e2e tests This wraps the pkg/generic/server handler and exposes the REST API defined in api/storage.yaml on a hard-coded address	A minimal generic storage server used in e2e tests This wraps the pkg/generic/server handler and exposes the REST API defined in api/storage.yaml on a hard-coded address
internal
config
db
db/inmemory
db/rqlite
handler
middleware
openapi Package openapi provides primitives to interact with the openapi HTTP API.	Package openapi provides primitives to interact with the openapi HTTP API.
router
storage
storage/generic Package generic provides primitives to interact with the openapi HTTP API.	Package generic provides primitives to interact with the openapi HTTP API.
storage/s3
types
pkg
generic/server Package server provides primitives to interact with the openapi HTTP API.	Package server provides primitives to interact with the openapi HTTP API.