From 5e34440b77b5c21b7e58d41e8802bc10ef7e249c Mon Sep 17 00:00:00 2001 From: irenarindos Date: Thu, 21 Mar 2024 11:46:17 -0400 Subject: [PATCH] docs(bsr): bsr storage requirement guidelines --- .../create-storage-bucket.mdx | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/website/content/docs/configuration/session-recording/create-storage-bucket.mdx b/website/content/docs/configuration/session-recording/create-storage-bucket.mdx index 9f675f8cad..aa4e66c5dd 100644 --- a/website/content/docs/configuration/session-recording/create-storage-bucket.mdx +++ b/website/content/docs/configuration/session-recording/create-storage-bucket.mdx @@ -27,6 +27,26 @@ Before you can create a storage bucket in Boundary, you must ensure that your en Session recording requires specific configuration for both the external store and the Boundary worker. At this time, the only supported storage is AWS S3. +### Storage requirements + +A [BSR](/boundary/docs/concepts/auditing/#bsr-directory-structure) (Boundary Session Recording) captures all the data +transmitted between a user and a target during a single session. As a result, the size of a BSR is dependent on user +activity. At a minimum, a BSR for a session with one connection requires 8KB of space for its files- this is the +overhead for BSR keys, checksums, metadata, etc. + +Determining how much storage you need to allocate on workers and AWS for recordings will depend on user activity, but the following two +examples are provided to help with storage estimates: + +- For a minute of simple shell activity, a BSR can be around 20KB in size. The storage requirements for 1,000 such sessions would be 20MB. + +- Sending 50MB of data results in a BSR around 50.1MB in size. The storage requirements for 1,000 such sessions would be 50.1 GB. + +When determining worker storage requirements, consider the number of concurrent sessions that will be recorded on that worker. +A BSR is written to the worker's local storage while the session is active, and then moved to the remote storage bucket when the session is closed. + +When determining AWS storage requirements, consider your [storage policy](/boundary/docs/concepts/domain-model/storage-policy) +and how long a BSR will be retained in the storage bucket. + ### AWS requirements - An AWS S3 storage bucket