Skip to content

Commit

Permalink
Merge pull request #3998 from hashicorp/backport/dheath-ent-nav-badge…
Browse files Browse the repository at this point in the history
…/marginally-national-squid

This pull request was automerged via backport-assistant
  • Loading branch information
hc-github-team-secure-boundary authored Nov 3, 2023
2 parents 85b7549 + deec8b1 commit 48fc0ac
Show file tree
Hide file tree
Showing 10 changed files with 53 additions and 8 deletions.
6 changes: 6 additions & 0 deletions website/content/docs/concepts/auditing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ Further, security teams seek to prevent incidents and proactively identify poten

## Session recording

<EnterpriseAlert product="boundary">This feature requires <a href="https://www.hashicorp.com/products/boundary">HCP Boundary or Boundary Enterprise</a></EnterpriseAlert>

Boundary provides auditing capabilities via [session recording](/boundary/docs/concepts/domain-model/session-recordings).
In Boundary, a session represents a set of connections between a user and a host from a target.
The session begins when an authorized user requests access to a target, and it ends when that access is terminated.
Expand Down Expand Up @@ -72,6 +74,8 @@ Boundary emits audit events for actions performed by users. Here are **some** of

## Storage buckets

<EnterpriseAlert product="boundary">This feature requires <a href="https://www.hashicorp.com/products/boundary">HCP Boundary or Boundary Enterprise</a></EnterpriseAlert>

A resource known as a [storage bucket](/boundary/docs/concepts/domain-model/storage-buckets) is used to store the recorded sessions.
The storage bucket represents a bucket in an external object store.
At this time, the only supported storage for storage buckets is AWS S3.
Expand All @@ -92,6 +96,8 @@ Any session recording metadata that is attached to the storage bucket is deleted

## BSR directory structure

<EnterpriseAlert product="boundary">This feature requires <a href="https://www.hashicorp.com/products/boundary">HCP Boundary or Boundary Enterprise</a></EnterpriseAlert>

The BSR (Boundary Session Recording) defines a hierarchical directory structure of files and a binary file format.
It contains all the data transmitted between a user and a target during a single session.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: |-
How to create a storage bucket for session recording in Boundary
---

# Create a storage bucket
# Create a storage bucket <sup>HCP/ENT</sup>

As of Boundary 0.13.0, you can record and audit user sessions.
A Boundary resource known as a [storage bucket](/boundary/docs/concepts/domain-model/storage-buckets) is used to store the recorded sessions.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: |-
How to enable session recording on a target in Boundary
---

# Enable session recording on a target
# Enable session recording on a target <sup>HCP/ENT</sup>

You must enable session recording for any targets that you want to record sessions on.
When you [create a storage bucket](/boundary/docs/configuration/session-recording/create-storage-bucket), Boundary provides you with an ID.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: |-
An overview of session recording in Boundary
---

# Overview
# Overview <sup>HCP/ENT</sup>

Boundary provides auditing capabilities via session recording.
In Boundary, a session represents a set of connections between a user and a host from a target.
Expand Down
4 changes: 3 additions & 1 deletion website/content/docs/operations/session-recordings/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ description: |-
How to work with Boundary's recorded sessions
---

# Recorded sessions operations
# Recorded sessions operations <sup>HCP/ENT</sup>

<EnterpriseAlert product="boundary" />

Boundary provides [auditing](/boundary/docs/concepts/auditing) capabilities via [session recording](/boundary/docs/configuration/session-recording).
In Boundary, a session represents a set of connections between a user and a host from a target.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: |-
How to find, download, and view Boundary's recorded sessions
---

# Find and view recorded sessions
# Find and view recorded sessions <sup>HCP/ENT</sup>

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ page_title: Validate the data integrity in the external object store
description: |-
How Boundary validates the data integrity of recorded sessions in the external object store
---
# How Boundary validates data integrity in the external object store
# How Boundary validates data integrity in the external object store <sup>HCP/ENT</sup>

When a Boundary worker uploads a BSR file to AWS S3 through the Boundary AWS plugin, the plugin calculates the SHA256 checksum of the contents of the BSR file and attaches this information to the object that is uploaded to S3.
The SHA256 checksum value attached to the S3 object is returned to the Boundary worker.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: |-
How to validate the integrity of Boundary's recorded sessions
---

# Validate the integrity of session recordings
# Validate the integrity of session recordings <sup>HCP/ENT</sup>

BSR directories are validated based on the contents in the directory.
Boundary cryptographically verifies each individual Boundary Session Recording (BSR) file.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: |-

# Troubleshoot session recordings

<EnterpriseAlert product="boundary">This feature requires <a href="https://www.hashicorp.com/products/boundary">HCP Boundary or Boundary Enterprise</a></EnterpriseAlert>

Refer to the following for information about how to troubleshoot recorded sessions.

## Known bugs
Expand Down
37 changes: 36 additions & 1 deletion website/data/docs-nav-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -264,10 +264,20 @@
},
{
"title": "Session recordings",
"badge": {
"text": "HCP/ENT",
"type": "outlined",
"color": "neutral"
},
"path": "concepts/domain-model/session-recordings"
},
{
"title": "Storage buckets",
"badge": {
"text": "HCP/ENT",
"type": "outlined",
"color": "neutral"
},
"path": "concepts/domain-model/storage-buckets"
},
{
Expand Down Expand Up @@ -391,6 +401,11 @@
},
{
"title": "Session recordings",
"badge": {
"text": "HCP/ENT",
"type": "outlined",
"color": "neutral"
},
"routes": [
{
"title": "Overview",
Expand Down Expand Up @@ -454,6 +469,11 @@
},
{
"title": "Session recordings",
"badge": {
"text": "HCP/ENT",
"type": "outlined",
"color": "neutral"
},
"routes": [
{
"title": "Overview",
Expand Down Expand Up @@ -488,7 +508,12 @@
},
{
"title": "Recorded sessions",
"path": "troubleshoot/troubleshoot-recorded-sessions"
"path": "troubleshoot/troubleshoot-recorded-sessions",
"badge": {
"text": "HCP/ENT",
"type": "outlined",
"color": "neutral"
}
}
]
},
Expand Down Expand Up @@ -1084,6 +1109,11 @@
},
{
"title": "session-recordings",
"badge": {
"text": "HCP/ENT",
"type": "outlined",
"color": "neutral"
},
"routes": [
{
"title": "Overview",
Expand Down Expand Up @@ -1126,6 +1156,11 @@
},
{
"title": "storage-buckets",
"badge": {
"text": "HCP/ENT",
"type": "outlined",
"color": "neutral"
},
"routes": [
{
"title": "Overview",
Expand Down

0 comments on commit 48fc0ac

Please sign in to comment.