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 ce59531d1..40ad46bf2 100644 --- a/website/content/docs/configuration/session-recording/create-storage-bucket.mdx +++ b/website/content/docs/configuration/session-recording/create-storage-bucket.mdx @@ -151,6 +151,10 @@ and how long a BSR will be retained in the storage bucket. [Session recording](/boundary/docs/configuration/session-recording) requires that you [configure at least one worker for local storage](/boundary/docs/configuration/session-recording/create-storage-bucket#boundary-workers-requirements). The worker that you configure for storage must: + +You cannot use an HCP managed worker for the local storage. HCP Boundary users must configure a self-managed worker to enable session recording. + + - Have access to the AWS S3 storage bucket - Have an accessible directory defined by `recording_storage_path` for storing session recordings while they are in progress. On session closure, Boundary moves the local session recording to remote storage and deletes the local copy. - For HCP Boundary, refer to the [Self-managed worker configuration](/hcp/docs/boundary/self-managed-workers/session-recording) documentation. @@ -158,9 +162,26 @@ The worker that you configure for storage must: - Have available disk space defined by `recording_storage_minimum_available_capacity`. If you do not configure the minimum available storage capacity, Boundary uses the default value of 500MiB. - Run Darwin, Windows, or Linux. The following binaries are not supported for session recording: NetBSD, OpenBSD, Solaris. - -You cannot use an HCP managed worker for the local storage. HCP Boundary users must configure a self-managed worker to enable session recording. - +#### Local storage + +Workers require sufficient local disk space in the `recording_storage_path` to store session recordings while they are in progress. Local disk space is also required for session recording playback. + +The `recording_storage_minimum_available_capacity` vaule defines the minimum available disk space that must be available on the worker for session recording and session recording playback. +This threshold determines the local storage state of the worker. +The possible storage states based on the `recording_storage_minimum_available_capacity` are: +- `Available`: The worker is above the storage threshold and is available to proxy sessions that are enabled with session recording. + +- `Low storage`: The worker is below the storage threshold. Existing sessions can continue without interruption, but new sessions that are enabled with session recording cannot be proxied. The worker is not available to record new sessions or play back existing recordings. + +- `Critically low storage`: The worker is below half the storage threshold. Existing sessions that are enabled with session recording will be forcefully closed. The worker is not available to record new sessions or play back existing recordings. + +- `Out of storage`: The worker is out of local disk space. It is not available to record new sessions or play back existing recordings. The worker is in a unrecoverable state. An administrator must intervene to remedy the issue. + +- `Not configured`: The worker does not have a `recording_storage_path` configured. + +- `Unknown`: The default local storage state of a worker. This state indicates that the local storage state of a worker is not yet known. Older workers (< 0.16.0) will be in this state. + +If a worker is in an unhealthy local storage state, Boundary does not allow new session recordings or session recording playback until the worker is in an `available` local storage state. Refer to the following example configuration: @@ -173,6 +194,8 @@ recording_storage_minimum_available_capacity="500MB" } ``` +### Create a storage bucket + Complete the following steps to create a storage bucket in Boundary for session recording: diff --git a/website/content/docs/configuration/worker/index.mdx b/website/content/docs/configuration/worker/index.mdx index 5fab781e8..24aff48b9 100644 --- a/website/content/docs/configuration/worker/index.mdx +++ b/website/content/docs/configuration/worker/index.mdx @@ -87,13 +87,14 @@ worker { Session recordings are stored in the local storage while they are in progress. When the session is complete, Boundary moves the local session recording to remote storage and deletes the local copy. -- `recording_storage_minimum_available_capacity` - A value measured in bytes that is used for defining the local storage state - of the worker. Boundary compares this value with the available local disk space found in the `recording_storage_path`. +- `recording_storage_minimum_available_capacity` - A value measured in bytes that defines the worker's local storage state. + Boundary compares this value with the available local disk space found in the `recording_storage_path` to determine if a worker can be used for session recording operations. + The supported suffixes are kb, kib, mb, mib, gb, gib, tb, tib, which are not case sensitive. Example: 2GB, 2gb, 2GiB, 2gib. The possible storage states based on the `recording_storage_minimum_available_capacity` are: - - Available - The worker is above the storage threshold and can proxy sessions that are enabled with session recording. - - Low storage - The worker is below the storage threshold. Existing sessions can continue without interruption, but new sessions that are enabled with session recording will not be proxied. - - Critically low storage - The worker is below half the storage threshold. Existing sessions that are enabled with session recording will be forcefully closed. - - Out of storage - The worker is out of local disk space. The worker is in a unrecoverable state. An administrator must intervene to remedy the issue. + - Available - The worker is above the storage threshold and is available to proxy sessions that are enabled with session recording. + - Low storage - The worker is below the storage threshold. Existing sessions can continue without interruption, but new sessions that are enabled with session recording cannot be proxied. The worker is not available to record new sessions or play back existing recordings. + - Critically low storage - The worker is below half the storage threshold. Existing sessions that are enabled with session recording will be forcefully closed. The worker is not available to record new sessions or play back existing recordings. + - Out of storage - The worker is out of local disk space. It is not available to record new sessions or play back existing recordings. The worker is in a unrecoverable state. An administrator must intervene to remedy the issue. - Not configured - The worker does not have a local storage path configured. - Unknown - The default local storage state of a worker. This state indicates that the local storage state of a worker is not yet known. diff --git a/website/content/docs/configuration/worker/worker-configuration.mdx b/website/content/docs/configuration/worker/worker-configuration.mdx index 0baf3ad87..65bdbd1f2 100644 --- a/website/content/docs/configuration/worker/worker-configuration.mdx +++ b/website/content/docs/configuration/worker/worker-configuration.mdx @@ -199,6 +199,8 @@ kms "aead" { [Session recording](/boundary/docs/configuration/session-recording) requires at least one Worker with access to local and remote storage. Workers used for session recording require an accessible directory defined by `recording_storage_path` for storing in-progress session recordings. On session closure, a local session recording is moved to remote storage and deleted locally. +The `recording_storage_minimum_available_capacity` value determines the minimum amount of storage space that is required for workers to perform session recording operations. If a worker is at or below the storage threshold, Boundary does not use the worker to record sessions or play back recordings. + Development example: ```hcl @@ -206,6 +208,7 @@ worker { auth_storage_path="/var/lib/boundary" initial_upstreams = ["10.0.0.1"] recording_storage_path="/local/storage/directory" + recording_storage_minimum_available_capacity="500MB" } ```