Commit Graph
138 Commits
Author SHA1 Message Date
Dan Heath 1f0bad4d48 docs: Session recording updates (#5195) 2024-10-23 16:16:08 -04:00
0bd699c999 Dheath 0.18.0 assembly (#5175)
* docs: TS public beta docs

* docs: Updates

* docs: Move Client Agent sections

* docs: Updates

* docs: Fix typo

* docs: Remove x86

* docs: Add lead in sentence for links

* docs: FAQ updates

* docs: Edits and file name fixes

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com>

* docs: Add alias refresh interval

* docs: Remove recurse only option

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/concepts/transparent-sessions.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/concepts/transparent-sessions.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/concepts/transparent-sessions.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/concepts/transparent-sessions.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/concepts/transparent-sessions.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* docs: Updates from code review

* docs: Update support request

* docs: Fix a typo

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* docs: Delete log example, create tabs

* client-agent: rework configuration docs

The section in the configuration talking about reloading the config
was repetitive and verbose. Combine the different sections into
two separate sections, one for updating general values and
one for reloading values, on MacOS only.

This also removes the specific Log section.

* docs: Minor rewrites

* client-agent: consistently use $ for shell sessions

* aliases: discourage single-word aliases

The use of single-word aliases breaks Transparent Sessions
on Windows, so we should discourage it. See ICU-15255 for more information.

* transparent-sessions: add known issues

Add two new known issues.

* client-agent: add troubleshooting section

* transparent-sessions: emphasize troubleshooting guide

* correct links

I haven't actually validated these links, but they
are now consistent with the rest of the links.

* Review comments

* client-agent: clarify that not all sessions are listed by command

* transparent-session: add known issue regarding Windows installer

* docs: Minor rewrites

* docs: Fix a typo

* docs: Add AssumeRole support

* docs: Add Backblaze support

* docs: Minor revision

* docs: Update MinIO reqs

* docs: Add supported Hitachi version

* docs: Trigger a new build

* docs: Clarify Desktop compatibility with control plane

* Update website/content/docs/enterprise/supported-versions.mdx

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

* docs: Release notes 0.18.0

* docs: Add link to Client Agent docs

* docs: Update ts definition

* docs: Remove stray line

* docs: Fix minor issues with the assembly branch

* docs: Move section

* docs: Add section

* docs: Remove duplicate section

---------

Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com>
Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
2024-10-15 08:21:31 -04:00
Robin Beck 9a0049a5ff Rab create bucket add filters link (#5157)
* adds link to worker filters examples

* adds terraform tabs for minio and s3-compliant storage
2024-10-09 11:38:52 -06:00
vanphan24andDan Heath 7bef893399 Update controller.mdx - public_cluster_addr (#5151)
* Update controller.mdx - public_cluster_addr

Updating public_cluster_addr to indicate that it is used if a load balancer is used for controllers. Also added a note about not including https:// and http:// in the address

* docs: Minor rewrite

* docs: Minor rewrite

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-10-08 17:42:56 -04:00
15d440a90d docs: Clarify credential workflow for SSH target types (#5082)
* docs: Clarify credential workflow for SSH target types

* adds clarifier about brokered creds on SSH targets

* Update website/content/docs/configuration/credential-management/configure-credential-injection.mdx

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

---------

Co-authored-by: stellarsquall <stellarsquall@protonmail.ch>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
2024-09-11 11:10:59 -04:00
Dan Heath c025e44ccb docs: Document recorded session max size (#5025) 2024-08-22 17:12:46 -04:00
bbbe971ed1 docs: Move permissions to config for usage docs (#4962)
* docs: Move permissions to config for usage docs

* docs: Update permissions concepts (#4970)

* docs: Update permissions concepts

* docs: Delete comments

* docs: Structural edits and adding workflow

* docs: Fix wording

* docs: Change guide name, add resource table

* Rab manage roles refactor (#4980)

* refreshes the manage-roles docs

* adds href for common-workflows/manage-roles to configuration/identity-access-management

* docs: Fix a couple typos

* docs: Style updates

* docs: Fix image links, update alt text

* docs: Add more info/next steps sections

* docs: Remove number for single instruction

* fixes screenshot

---------

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

* updates path to resource-table.mdx

* sets aliases scope to Global

* updates aliases scope in resource table

* clarifies assigned scope id

* Update website/redirects.js

Co-authored-by: Michael Li <michael.li@hashicorp.com>

---------

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
Co-authored-by: Robin Beck <stellarsquall@protonmail.ch>
Co-authored-by: Michael Li <michael.li@hashicorp.com>
2024-07-30 17:21:09 -04:00
c4a01eb398 docs: Add S3 compliant storage (#4954)
* docs: Add S3 compliant storage

* docs: remote storage state (#4949)

* docs: remote storage state

document new remote storage state on the worker

* docs: Add link on worker storage page

* docs: Address feedback

* docs: Call out example

* docs: Fix a typo

* Update website/content/docs/configuration/session-recording/create-storage-bucket.mdx

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

* Apply batch of suggestions from code review

Co-authored-by: Hugo <10965479+hugoghx@users.noreply.github.com>

* docs: Clarify support statement

* docs: Revise support statement

---------

Co-authored-by: Elim Tsiagbey <elim.tsiagbey@hashicorp.com>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
Co-authored-by: Hugo <10965479+hugoghx@users.noreply.github.com>
2024-07-30 14:40:28 -04:00
Elim Tsiagbey e76133e148 docs: remote storage state (#4949)
* docs: remote storage state

document new remote storage state on the worker
2024-07-23 12:07:25 -04:00
Dan Heath f7bbe08c0c docs: Explain auth token TTL's impact on OIDC (#4938) 2024-07-18 14:05:29 -04:00
d2c73dd2fc Added sample Terraform code for session recording configuration (#4556)
* added sample terraform code to create storage bucket configuration

* added terraform sample code for target configuration

* Added HCP Boundary Plus as requirement in the note

* added sample TF code to configure a storage policy

* added group attributes to tabs

* added terraform tab for updating a storage policy

* formatting and style guide changes

* docs: Lowercase credential types

* docs: Apply active voice

* docs: Close prefix

---------

Co-authored-by: Robin Beck <stellarsquall@protonmail.ch>
Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-06-27 15:16:33 -04:00
Dan HeathandMichael Li 9d3f3da4df docs: Add bsr purpose key examples (#4785)
* docs: Add bsr purpose key examples

* Apply batch of suggestions from code review

Co-authored-by: Michael Li <michael.li@hashicorp.com>

---------

Co-authored-by: Michael Li <michael.li@hashicorp.com>
2024-05-09 12:32:51 -04:00
Irena Rindos 8b90efcde3 docs: fix broken session recording link (#4777) 2024-05-07 14:38:34 -04:00
Michael Li afd8443cc5 docs: Fix broken link (#4766) 2024-05-03 11:18:44 -04:00
Robin BeckandDan Heath 471f9476e2 Docs 0.16.0 assembly minio (#4708)
* adds configure-worker-storage.mdx

* adds session-recording/storage-providers pages

* migrates worker and provider reqs to new pages

* adds TOC

* update storage requirements to be provider agnostic

* updates requirements with bucket considerations

* creates tabs, adds minio support

* adds minio requirements

* fixes Amazon S3 branding

* style guide fixes for UI tabs

* makes UI tab primary

* removes KMS and adds service account policy

* cleans up service account and region notes

* restricts ListBucket policy

* adds minio API port example

* reformats CLI attributes, fixed typos

* adds Resources section

* adds Resources section with KMS docs link

* docs: Add ENT banners

* docs: Fix links

* docs: Move BSR storage requirements

* docs: Add Requirements sections to old topics

* docs: Add next steps sections

* docs: Minor style edits

* docs: Add NetBSD caveat

* docs: Make NetBSD caveat a note

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-04-30 14:29:24 -04:00
Casey Trahan fe29aae5c0 Update create-storage-bucket.mdx (#4715)
This single incorrectly spaced opening bracket is causing an error in AWS 'invalid policy syntax'.
2024-04-24 14:33:49 -06:00
Dan Heath 9c67029a0a docs: Update KMS purpose field for BSR (#4638) 2024-04-12 15:37:52 -04:00
a79e35da54 Cred store docs days (#4579)
* add a new cred management files

* adding credential management files

* fixed type-os, added ent labels, grouped cli/ui

* added reference links from concepts section and Vault integration section to new cred management pages

* style guide and formatting enhancements

* style guide and formatting enhancements

* fixes internal link

* docs: Updates for styles and standards

* docs: Fix link structure

* docs: Break out brokering/injection procedures

* Apply batch suggestions from code review

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

* docs: Clean up commented out code

* docs: Rename index file per best practices

* docs: Update page description meta content

* docs: Add level 2 headings for organization

---------

Co-authored-by: Robin Beck <stellarsquall@protonmail.ch>
Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
2024-04-11 15:09:05 -04:00
Elim Tsiagbey fae2149990 docs: Local Storage State
- add docs for local storage states
- add docs for `recording_storage_minimum_available_capacity` config field for workers
2024-04-05 16:47:35 -04:00
Damian Debkowski aea473c77b feat: new worker config for minimumAvailableCapacity 2024-04-05 16:45:52 -04:00
Irena RindosandDan Heath 11540f0bdd docs(bsr): bsr storage requirement guidelines (#4553)
* docs(bsr): bsr storage requirement guidelines

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-03-22 08:20:41 -04:00
Dan Heath dbdc75c87e docs: Fix broken link in worker config topic (#4464) 2024-02-28 16:57:53 -05:00
Michael Li 2111e1a5cc doc(kms): Fix typo (#4449) 2024-02-23 16:31:36 -05:00
Yong Zhang 66c7f274bb Fix docs for event filters (#4365) 2024-02-06 12:31:58 -07:00
Adam BouhmadandDan Heath 50de448fee Merge PKI & KMS docs (#4325)
* Merge PKI & KMS docs

* Update worker-configuration.mdx

remove deprecated kms flag

* docs: Fix TOC

* docs: Create redirects

* docs: Fix some broken links

* modify overview page for post 0.15 changes

* Modify data-encryption docs for post 0.15

* modify configure-workers page for post 0.15

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-01-30 20:23:26 -05:00
5dbf57ebfa chore: add storage policy documentation (#4246)
* chore: update create storage bucket readme

* chore: update domain model docs for storage policy

* fix(website): update docs nav data

* docs: Update navigation

* docs: Copy edits

* chore: add resultant set of policy examples

* doc: Update resultant set of policy examples

* docs: Add policies to CLI commands

* docs: Add note about default policy name

* adds configure storage policies usage docs

* updates s3 policies to include the bucket resource itself

* adds commands/policies routes back

* Apply suggestions from code review

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

* adds Manual deletion section

* updates UI step

* adds update storage policies usage doc

* attribute description updates and formatting fixes

* 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>
Co-authored-by: stellarsquall <stellarsquall@protonmail.ch>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
2024-01-30 20:20:43 -05:00
Johan Brandhorst-Satzkorn 77e1f01421 website: correct grammar (#4222) 2024-01-05 07:45:14 -08:00
Johan Brandhorst-Satzkorn 9ce5a14ef0 config: add max_page_size variable
The max_page_size variable lets operators control the size of the
pagination pages. This value configures both the maximum permitted
page size and the default page size when none is explicitly provided.

Operators can tweak this option up or down to increase or reduce
the load on the database during pagination.
2024-01-05 07:43:20 -08:00
3cfc20e6f6 docs: Document API rate limiting (#4111)
* docs: Document API rate limiting

* docs: Fix default setting

* addss rate limiting examples to complete configuration example

* use # for comments for consistency

* Update website/content/docs/api-clients/api.mdx

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

* Apply batch suggestions from code review

Co-authored-by: Michael Li <michael.li@hashicorp.com>

* docs: Updates from review feedback

* docs: Updates from review feedback

* docs: Add new defaults and sub-headings

* Update website/content/docs/api-clients/go-sdk.mdx

Co-authored-by: Timothy Messier <tim.messier@gmail.com>

* docs: Remove remaining comments from code blocks

* docs: Update code blocks

* fixes tabs

* Update website/content/docs/api-clients/api.mdx

Co-authored-by: Michael Li <michael.li@hashicorp.com>

---------

Co-authored-by: stellarsquall <stellarsquall@protonmail.ch>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
Co-authored-by: Michael Li <michael.li@hashicorp.com>
Co-authored-by: Timothy Messier <tim.messier@gmail.com>
2023-12-11 09:52:36 -05:00
Dan HeathandRobin Beck 4cbf468230 docs: Update session recording reqs for HCP (#4088)
* docs: Update session recording reqs for HCP

* docs: Update link

* docs: Add note for HCP Boundary

* docs: Update with proper Note format

* Update website/content/docs/configuration/session-recording/create-storage-bucket.mdx

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

---------

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
2023-12-07 13:29:03 -05:00
Dan Heath 527c383ea3 docs: Fix broken subheading links (#4024) 2023-11-08 15:32:44 -05:00
Dan Heath 22e06eddc8 docs: Add enterprise badge (#3981)
* docs: Add enterprise badge

* docs: Add heading-level enterprise alert

* docs: Add some missing tags
2023-11-03 14:08:06 -04:00
Dan Heath 3cd9c241f9 docs: Update worker auth storage path (#3759) 2023-10-11 15:12:08 -04:00
Dan HeathandAdam Bouhmad c979012638 Dheath hashiconf assembly (#3818)
* docs: Update ldap status

* docs: Add new `remote-command` option

* docs: Update terminology

* docs: Add health check metric

* docs: get rid of blank line

* docs: Add copy edits from review feedback

* docs: Update storage bucket credentials doc

* docs: Add new lines to make code blocks readable

* docs: Edits from code review

* docs: Clarify paragraph on credential rotation

* docs: Update field definition in domain model

* docs: Release notes 0.14.0

* docs: Update LDAP entry

* docs: Revise dynamic credential description

* docs: Add superscripts

* docs: Add worker health metric, reorder items

* docs: Fix typo

* Update website/content/docs/release-notes/v0_14_0.mdx

Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com>

* docs: Updates from code review

* docs: Add default port deprecation

---------

Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com>
2023-10-11 11:32:44 -04:00
Dan Heath 8f27b5dfe5 docs (telemetry): update domain docs 2023-09-22 11:31:42 -04:00
Jeff Mitchell 69bafbd4e0 Mention that SIGHUP affects the database URL (#3612) 2023-09-06 11:57:22 -04:00
Dan Heath 06a37f605a docs: Add recording storage path to worker config (#3604) 2023-08-17 15:58:19 -04:00
Dan Heath 8764badf8c docs: Update session recording configuration (#3548) 2023-08-08 14:55:24 -04:00
Dan Heath 4c61c9631f docs: Add note regarding HCP workers (#3514)
* docs: Add note regarding HCP workers

* docs: Make parameter link

* docs: Reword and move `hcp_boundary_cluster_id`
2023-07-28 11:25:33 -04:00
Dan Heath cbebe0ae2f docs: Clarify storage bucket terminology (#3485)
* docs: Clarify storage bucket terminology

* docs: Additional edits
2023-07-26 11:18:05 -04:00
Michael MiltonandDan Heath b391303a4f docs: BSR KMS Configuration Requirements (#3440)
* add docs for additional config reqs for kms

* Update website/content/docs/configuration/session-recording/create-storage-bucket.mdx

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

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2023-07-14 11:02:20 -04:00
Elim Tsiagbey b10a93d0e8 docs: Session Recording Requirements for Workers (#3414)
* docs: Session Recording Requirements for Workers

Clarify the requirements for Boundary workers used for session recording
2023-07-13 11:59:35 -04:00
Dharini JeevaandDan Heath 45c8a670f3 docs: Update enable session recording on a target (#3412)
* docs: enable session recording on a target

* docs: Minor copy edit to make sentence singular

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2023-07-12 18:15:07 -04:00
Dan Heath 3f4cd53d16 docs: Update headings for new style rule (#3396)
* docs: Update headings for new style rule

* docs: Fix headings - Get started

* docs: Fix headings - Install

* docs: Fix headings - Concepts

* docs: Fix typos

* docs: Fix headings - Configuration

* docs: Fix headings - Operations

* docs: Fix headings - Troubleshoot

* docs: Fix headings - Clients and Develop

* docs: Fix headings - HCP and ENT

* docs: Fix headings - Release notes

* docs: Fix typos

* docs: Fix capitalization in TOC
2023-07-07 14:42:11 -04:00
edorionandDan Heath eb63a339f0 Update enable-session-recording.mdx to link bsr controler config to bsr kms key doc (#3382)
* Update enable-session-recording.mdx

* docs: Minor copy edit

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2023-07-06 14:00:19 -04:00
edorion f22abbb567 Update create-storage-bucket.mdx PKI worker to session recording config (#3381)
link PKI worker link to session recoding config
2023-07-06 13:39:52 -04:00
edorion e4e06e63d9 Update SSH target attributes url typo (#3380)
https://developer.hashicorp.com/boundary/docs/concepts/docmain-model/targets#ssh-target-attributes-hcp-ent should be https://developer.hashicorp.com/boundary/docs/concepts/domain-model/targets#ssh-target-attributes-hcp-ent

(domain not docmain)
2023-07-06 13:35:29 -04:00
Dan Heath 8acc73dc6e docs: Add bsr key to requirements (#3330)
* docs: Add bsr key to requirements

* docs: Rewrite for clarity

* docs: Add bsr key definition to security page
2023-06-14 15:58:24 -04:00
Irena RindosandDan Heath c0538bd074 docs: Update storage bucket worker requirement (#3320)
* docs: Update storage bucket worker requirement

* docs: Minor copy edits

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2023-06-14 11:18:20 -04:00
Dan Heath 2e8cd853a5 docs: Fix display issue with code blocks (#3314) 2023-06-13 05:11:42 -04:00