docs: update view session recordings in ui steps (#3421)

* docs: update view session recordings in ui steps

* docs: add more admin console details

* Apply suggestions from code review

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
pull/3451/head
Cameron Perera 3 years ago committed by GitHub
parent 5ea25ccf2a
commit c8ee312ae2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -13,15 +13,16 @@ The session begins when an authorized user requests access to a target, and it e
When you enable session recording on a target, any user session that connects to the target is automatically recorded.
An administrator can later view the recordings to investigate security issues, review system activity, or perform regular assessments of security policies and procedures.
## Find recorded sessions
Recorded sessions are stored in an external storage bucket that you create.
Storing session recordings in a system external to Boundary means those recordings can be accessed, modified, deleted, and even restored independently of Boundary.
You can view any sessions that Boundary recorded in your storage provider or via the CLI.
You can view a list of all recorded sessions, or if you know the ID of a specific recorded session, you can find any channels associated with that recording.
### Find all recorded sessions
<Tabs>
<Tab heading="CLI">
## Find all recorded sessions
Complete the following steps to find all recorded sessions using the CLI.
@ -34,7 +35,7 @@ Complete the following steps to find all recorded sessions using the CLI.
Boundary displays a list of all recorded sessions by scope.
### Find a specific recorded session by ID
## Find a specific recorded session by ID
If you have the ID of a recorded session, you can use the following command to list the connections and channels associated with a session recording.
@ -42,22 +43,6 @@ If you have the ID of a recorded session, you can use the following command to l
boundary session-recordings read -id <id>
```
## View recorded sessions
You can view recorded sessions in the UI, if you have the proper permissions.
1. Log in to Boundary.
1. Select **Orgs** in the navigation pane.
1. Select the org that contains the target from the recorded session you want to view.
1. Select **Session Recordings** in the navigation pane.
The **Session Recordings** page displays the time, user, target, and duration of the recording.
1. Select **View** next to the recording you want to view.
1. Select **Play** next to the channel recording you want to view.
The recorded session appears in the media plyaer.
You can click the **Play** button to watch the recording.
## Download recorded session channels
You can download a recording of SSH shell or exec sessions for a channel from a recorded session.
@ -78,3 +63,38 @@ Substitute the ID of the channel for **chr_1234567890**:
```bash
boundary session-recordings download -id chr_1234567890
```
</Tab>
<Tab heading="Admin Console">
## Find all recorded sessions
You can find all recorded sessions in the UI from the global scope.
1. Log in to Boundary.
1. Select **Session Recordings** in the navigation pane.
The **Session Recordings** page displays the created time, user, project,
target, and duration of the recording.
## View session recording details
1. Select **View** next to the session recording you want to view.
The details page has information related to the session recording and
links to related inforation like user, target, and storage bucket.
## Play back channel recording
1. Select **Play** next to the channel recording you want to view.
The recorded session appears in the media player.
Click the **Play** button located at the bottom of the media player
to watch the recording.
If a recorded session channel does not support playback, a **View** button
is shown. The playback page displays a message stating that playback
is not supported, but still shows details specific to that channel.
</Tab>
</Tabs>

Loading…
Cancel
Save