From 06a37f605a6c3fc925e774203853ec4e145b7f79 Mon Sep 17 00:00:00 2001 From: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Date: Thu, 17 Aug 2023 15:58:19 -0400 Subject: [PATCH] docs: Add recording storage path to worker config (#3604) --- website/content/docs/configuration/worker/index.mdx | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/website/content/docs/configuration/worker/index.mdx b/website/content/docs/configuration/worker/index.mdx index a17a0a152..ec3470b48 100644 --- a/website/content/docs/configuration/worker/index.mdx +++ b/website/content/docs/configuration/worker/index.mdx @@ -39,6 +39,9 @@ Regardless of registration mechanism, the following fields are supported. worker { public_addr = "5.1.23.198" + # Local storage path required if session recording is enabled + recording_storage_path = "tmp/boundary/" + # Mutually exclusive with hcp_boundary_cluster_id initial_upstreams = [ "10.0.0.1", @@ -82,6 +85,10 @@ worker { `initial_upstreams`. This parameter is currently only valid for workers using the PKI registration method and for workers directly connected to HCP Boundary. +- `recording_storage_path` - A path to the local storage for recorded sessions. + 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. + - `tags` - A map of key-value pairs where values are an array of strings. Most commonly used for [filtering](/boundary/docs/concepts/filtering) targets a worker can proxy via [worker @@ -160,6 +167,9 @@ worker { # Path for worker storage, assuming PKI registration. Must be unique across workers auth_storage_path="/boundary/demo-worker-1" + # Local storage path required if session recording is enabled + recording_storage_path = "tmp/boundary/" + # Workers typically need to reach upstreams on :9201 initial_upstreams = [ "10.0.0.1", @@ -197,3 +207,4 @@ Refer to the [Manage Multi-Hop Sessions with HCP Boundary](/boundary/tutorials/h [pki workers]: /boundary/docs/configuration/worker/pki-worker [target]: /boundary/docs/concepts/domain-model/targets [target worker filters]: /boundary/docs/concepts/filtering/worker-tags#target-worker-filtering +[session recording]: /boundary/docs/configuration/session-recording