From b0220313428660644da9ab0742440e3d10347add Mon Sep 17 00:00:00 2001 From: irenarindos Date: Thu, 21 Mar 2024 15:46:17 +0000 Subject: [PATCH 1/5] backport of commit 5e34440b77b5c21b7e58d41e8802bc10ef7e249c --- .../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 From 749704d16ba72d8c22b5b012f8fd89f30a156597 Mon Sep 17 00:00:00 2001 From: Irena Rindos Date: Fri, 22 Mar 2024 12:13:27 +0000 Subject: [PATCH 2/5] backport of commit 80e3dde4068e131b33fe31ffe1431f068cbf10f8 --- .../configuration/session-recording/create-storage-bucket.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 aa4e66c5dd..34bb991997 100644 --- a/website/content/docs/configuration/session-recording/create-storage-bucket.mdx +++ b/website/content/docs/configuration/session-recording/create-storage-bucket.mdx @@ -34,7 +34,7 @@ transmitted between a user and a target during a single session. As a result, th 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 +Determining how much storage you need to allocate on workers and AWS for recordings depends 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. From 629bf2cfa948c142326f7fc39f809582c8f46701 Mon Sep 17 00:00:00 2001 From: Irena Rindos Date: Fri, 22 Mar 2024 12:13:33 +0000 Subject: [PATCH 3/5] backport of commit 466c79b8ef7cd8286e06d0bfdedbb52b028b9bae --- .../configuration/session-recording/create-storage-bucket.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 34bb991997..35e7c78c17 100644 --- a/website/content/docs/configuration/session-recording/create-storage-bucket.mdx +++ b/website/content/docs/configuration/session-recording/create-storage-bucket.mdx @@ -41,7 +41,7 @@ examples are provided to help with storage estimates: - 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. +When you estimate 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) From 58a46ae2a3a368ab80c15348ef55ff0d39427007 Mon Sep 17 00:00:00 2001 From: Irena Rindos Date: Fri, 22 Mar 2024 12:13:43 +0000 Subject: [PATCH 4/5] backport of commit d17356e1f74cf9d7e317a7add876c11a8967d2a8 --- .../configuration/session-recording/create-storage-bucket.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 35e7c78c17..188662373e 100644 --- a/website/content/docs/configuration/session-recording/create-storage-bucket.mdx +++ b/website/content/docs/configuration/session-recording/create-storage-bucket.mdx @@ -42,7 +42,7 @@ examples are provided to help with storage estimates: - 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 you estimate 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. +Boundary writes the BSR to the worker's local storage while the session is active, and then moves it 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. From ce1432ce08c6a995a34e7bdbd6557de0b8224119 Mon Sep 17 00:00:00 2001 From: Irena Rindos Date: Fri, 22 Mar 2024 12:13:49 +0000 Subject: [PATCH 5/5] backport of commit d36f1e6dd8dba27f6d7eba0fd02f5811c00a7303 --- .../configuration/session-recording/create-storage-bucket.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 188662373e..f5dbca389f 100644 --- a/website/content/docs/configuration/session-recording/create-storage-bucket.mdx +++ b/website/content/docs/configuration/session-recording/create-storage-bucket.mdx @@ -44,7 +44,7 @@ examples are provided to help with storage estimates: When you estimate worker storage requirements, consider the number of concurrent sessions that will be recorded on that worker. Boundary writes the BSR to the worker's local storage while the session is active, and then moves it 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) +When you estimate 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