Skip to content

Commit

Permalink
[docs] Cherry pick #3981 to website (#4003) (#4017)
Browse files Browse the repository at this point in the history
* docs: Add enterprise badge (#3981)

* docs: Add enterprise badge

* docs: Add heading-level enterprise alert

* docs: Add some missing tags

* docs: Delete duplicate alert

* docs: Remove stray HCP/ENT tags

* docs: Remove more HCP/ENT tags
  • Loading branch information
Dan-Heath authored Nov 7, 2023
1 parent 0bb38bd commit 1c8e05a
Show file tree
Hide file tree
Showing 27 changed files with 71 additions and 18 deletions.
2 changes: 2 additions & 0 deletions website/content/docs/commands/session-recordings/download.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: |-

# session-recordings download

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

Command: `boundary session-recordings download`

The `boundary session-recordings download` command lets you download a Boundary session recording.
Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/commands/session-recordings/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: |-

# session-recordings

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

Command: `boundary session-recordings`

The `session-recordings` command lets you perform operations on Boundary session recording resources.
Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/commands/session-recordings/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: |-

# session-recordings list

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

Command: `boundary session-recordings list`

The `boundary session-recordings list` command lets you list the Boundary session recordings within a given scope or resource.
Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/commands/session-recordings/read.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: |-

# session-recordings read

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

Command: `boundary session-recordings read`

The `boundary session-recordings read` command lets you read information about a Boundary session recording by providing the ID.
Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/commands/storage-buckets/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: |-

# storage-buckets create

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

Command: `boundary storage-buckets create`

The `boundary storage-buckets create` command lets you create Boundary storage buckets.
Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/commands/storage-buckets/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: |-

# storage-buckets delete

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

Command: `boundary storage-buckets delete`

The `boundary storage-buckets delete` command lets you delete Boundary storage buckets.
Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/commands/storage-buckets/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: |-

# storage-buckets

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

Command: `boundary storage-buckets`

The `storage-buckets` command lets you perform operations on Boundary storage bucket resources.
Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/commands/storage-buckets/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: |-

# storage-buckets list

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

Command: `storage-buckets list`

The `storage-buckets list` command lets you list the storage buckets within a given scope or resource.
Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/commands/storage-buckets/read.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: |-

# storage-buckets read

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

Command: `boundary storage-buckets read`

The `boundary storage-buckets read` command lets you read information about Boundary storage buckets.
Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/commands/storage-buckets/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: |-

# storage-buckets update

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

Command: `boundary storage-buckets update`

The `boundary storage-buckets update` command lets you update Boundary storage buckets by ID.
Expand Down
4 changes: 3 additions & 1 deletion website/content/docs/concepts/credential-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,9 @@ Learn more about [credential brokering](/boundary/tutorials/hcp-getting-started/

Learn more about the [Vault dynamic secrets engine](/vault/docs/secrets).

## Credential injection <sup>HCP/ENT</sup>
## Credential injection

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

Credential injection is the process by which a credential is fetched from a credential store and then passed on to a worker for authentication to a remote machine.
With credential injection, the user never sees the credential required to authenticate to the target.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ The default value is `GET`.
- `vault-http-request-body` - (optional) The body of the HTTP request the library sends to Vault when it requests credentials.
Only valid if `http_method` is set to `POST`.

### Vault SSH certificate credential library attributes <sup>HCP/ENT</sup>
### Vault SSH certificate credential library attributes

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

As of Boundary 0.12.0, you can configure SSH credential injection using [Vault's SSH secrets engine](/vault/docs/secrets/ssh) to create the SSH certificate credentials.
SSH certificate-based authentication extends key-based authentication using digital signatures.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ description: |-
The anatomy of a Boundary session recording
---

# Session recordings <sup>HCP/ENT</sup>
# Session recordings

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

A session recording represents a directory structure of
files in an external object store that together are the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ description: |-
The anatomy of a Boundary storage bucket
---

# Storage buckets <sup>HCP/ENT</sup>
# 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 is used to store the [session recordings][].
The storage bucket represents a bucket in an external object store.
Expand Down
4 changes: 3 additions & 1 deletion website/content/docs/concepts/domain-model/targets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,9 @@ TCP targets have the following additional attribute:
- `default_port` - (required)
The default port to set on this target.

### SSH target attributes <sup>HCP/ENT</sup>
### SSH target attributes

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

SSH targets use injected application credentials to authenticate an SSH session between the client and end host.
Injected credentials allow users to securely connect to remost hosts using SSH, while never being in the possession of a valid credential for that target host.
Expand Down
5 changes: 4 additions & 1 deletion website/content/docs/concepts/filtering/worker-tags.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,10 @@ The `ingress_worker_filter`<sup>HCP/ENT</sup> attribute controls which workers a
This is the worker a client connects to when initiating a connection to a target.


## Vault workers <sup>HCP/ENT</sup>
## Vault workers

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

Tags are used to control which [PKI workers] can manage Vault requests by specifying
a `worker_filter`attribute when configuring [credential stores].

Expand Down
5 changes: 4 additions & 1 deletion website/content/docs/concepts/security/data-encryption.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,10 @@ $ boundary scopes list-key-version-destruction-jobs -scope-id p_A4jfDjZ9jf
Once the job disappears from this list, the associated key version will have
been destroyed and any existing data will have been re-encrypted.

## The `bsr` KMS key <sup>HCP/ENT</sup>
## The `bsr` KMS key

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

The `bsr` KMS key is required for [session recording](/boundary/docs/configuration/session-recording).
If you do not add a `bsr` key to your controller configuration, you will receive an error when you attempt to enable session recording.
The key is used for encrypting data and checking the integrity of recordings.
Expand Down
5 changes: 4 additions & 1 deletion website/content/docs/concepts/workers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,10 @@ with tag “A,” to connect to targets in “Network A.”

![Boundary architecture example showing workers with tags](/img/worker-tags.png)

## Multi-hop sessions <sup>HCP/ENT</sup>
## Multi-hop sessions

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

Most organizations want to provide access to infrastructure without exposing private networks. Many organizations also have complex network topologies requiring
inbound traffic to route through multiple network enclaves in order to reach the target system.
[Multi-hop](/boundary/docs/configuration/worker#multi-hop-worker-capabilities-hcp-ent) sessions allow you to chain together two or more workers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ description: |-
How to create a storage bucket for session recording in Boundary
---

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

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

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,9 @@ description: |-
How to enable session recording on a target in Boundary
---

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

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

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,9 @@ description: |-
An overview of session recording in Boundary
---

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

<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.
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/configuration/worker/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,9 @@ Any other updated values are ignored.
The `SIGTERM` and `SIGINT` signals initiate a graceful shutdown on a worker. The worker waits for any sessions to drain
before shutting down. Workers in a graceful shutdown state do not receive any new work, including session proxying, from the control plane.

## Multi-hop worker capabilities <sup>HCP/ENT</sup>
## Multi-hop worker capabilities

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

Multi-hop capabilities, including multi-hop sessions and Vault private access,
is when a session or Vault credential request goes through more than one worker.
Expand Down
4 changes: 3 additions & 1 deletion website/content/docs/configuration/worker/pki-worker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,9 @@ kms "aead" {
}
```

## Session recording <sup>(HCP/ENT)</sup>
## Session recording

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

[Session recording](/boundary/docs/configuration/session-recording) requires at least one PKI worker with access to local and remote storage.
PKI workers used for session recording require an accessible directory defined by `recording_storage_path` for
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/operations/session-recordings/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ description: |-
How to work with Boundary's recorded sessions
---

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

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

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,9 @@ description: |-
How to find, download, and view Boundary's recorded sessions
---

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

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

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,9 @@ 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 <sup>HCP/ENT</sup>
# How Boundary validates data integrity in the external object store

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

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,9 @@ description: |-
How to validate the integrity of Boundary's recorded sessions
---

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

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

BSR directories are validated based on the contents in the directory.
Boundary cryptographically verifies each individual Boundary Session Recording (BSR) file.
Expand Down

0 comments on commit 1c8e05a

Please sign in to comment.