You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/content/docs/configuration/session-recording/configure-worker-storage.mdx
+46Lines changed: 46 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,6 +51,52 @@ The possible storage states determined by the `recording_storage_minimum_availab
51
51
52
52
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.
53
53
54
+
## Remote storage state
55
+
56
+
The workers that you configure for session recording storage must have access to the external object store. Workers report permission states back to Boundary, depending on the availability of the external object store.
57
+
Boundary uses the permission states to determine what actions the worker can perform on the configured external storage.
58
+
59
+
Workers can have the following permission states:
60
+
61
+
-`read`: The worker can read from the external storage. It can also play back recorded sessions, if the permission state is `ok`.
62
+
-`write`: The worker can write to the external storage. It can also record sessions, if the permission state is `ok`.
63
+
-`delete`: The worker can delete data from the external storage. It can also clean up recorded sessions, if the permission state is `ok`.
64
+
65
+
Boundary uses the permission states to determine the remote storage state of a worker. The worker can have the following remote storage states:
66
+
-`available`: All permission states are healthy. The worker has the required access to the external storage.
67
+
-`error`: One or more of the permission sates are not healthy. Workers may not be able to perform certain actions on the external storage.
68
+
69
+
Boundary periodically checks the states of any workers that use the external storage, and then reports them back to the controller.
70
+
71
+
You can check the remote storage state of a worker using the `boundary worker read -id $WORKER_ID` command.
72
+
73
+
```
74
+
Worker information:
75
+
Active Connection Count: 0
76
+
Address: 0.0.0.0:9202
77
+
Created Time: Tue, 04 Jun 2024 13:52:27 PDT
78
+
ID: w_RPfBj239to
79
+
Last Status Time: 2024-06-04 20:55:35.589282 +0000 UTC
80
+
Local Storage State: available
81
+
Remote Storage State:
82
+
sb_fhde575e:
83
+
Status: available
84
+
Permissions:
85
+
Write: ok
86
+
Read: ok
87
+
Delete: ok
88
+
sb_jksdgh4:
89
+
Status: error
90
+
Permissions:
91
+
Write: error
92
+
Read: ok
93
+
Delete: ok
94
+
Release Version: Boundary v0.17.0+ent
95
+
Type: pki
96
+
Updated Time: Tue, 04 Jun 2024 13:55:35 PDT
97
+
Version: 1
98
+
```
99
+
54
100
## Example configuration
55
101
56
102
Refer to the following example configuration to configure workers for session recording storage:
0 commit comments