Commit Graph
527 Commits
Author SHA1 Message Date
69fc3a47d0 docs: add ssh host key error to known issues (#5250)
* docs: ssh error due to change in host key

* style: remove trailing whitespace

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

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

* docs: rephrase  message

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

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

---------

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-11-20 09:12:30 -05:00
Dan HeathandYoko Hyakuna 53e77e313a docs: Update meta content - Getting started (#5214)
* docs: Update meta content - Getting started

* Update website/content/docs/getting-started/dev-mode/connect-to-dev-target.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

* Update website/content/docs/getting-started/index.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

---------

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2024-11-14 13:57:25 -05:00
Dan Heath 3d6a629c97 docs: Update meta content - Install (#5218) 2024-11-14 13:48:59 -05:00
Dan Heath 9ac1129289 docs: Update meta content - Overview (#5203)
* docs: Update meta content - Overview

* docs: Delete extra line

* docs: Remove newlines
2024-11-14 13:46:30 -05:00
Johan Brandhorst-SatzkornandDan Heath 680bb02af9 docs/client-agent: clarify use of override_upstream_dns_servers (#5220)
* docs/client-agent: clarify use of override_upstream_dns_servers

The override_upstream_dns_servers option is recommended whenever
a user needs to override the DNS servers discovered from the system.
However, if a user supplies a DNS server that is only useable while
connected to a specific network, it will break the internet in
cases where it is not able to resolve these DNS servers.
Encourage users to supply both the VPN servers and the default
DNS servers.

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

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

* Update website/content/docs/api-clients/client-agent.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>
2024-10-30 13:59:50 -07:00
Johan Brandhorst-SatzkornandDan Heath 5a071442b5 Clarify client agent config reload docs (#5213)
* docs/client-agent: clarify configuration reload on MacOS

The previous configuration was known to confuse at least one reader.
It's easy to just copy the first command you see and run it, so
make that the non-destructive reload command.

* docs/client-agent: correct log level config example

* Update website/content/docs/api-clients/client-agent.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>
2024-10-29 09:58:38 -07:00
Dan Heath 1f0bad4d48 docs: Session recording updates (#5195) 2024-10-23 16:16:08 -04:00
Irena Rindos a862dc1691 chore(docs): clarify that storage policies must be attached in order to take effect (#5191) 2024-10-21 16:50:47 -04:00
Dan Heath 72e6ea8da0 docs: Clarify need to reload or restart Client Agent on Mac (#5183)
* docs: Clarify need to reload or restart Client Agent on Mac

* docs: Wake up Vercel

* docs: Use full name of client
2024-10-17 18:36:05 -04:00
Johan Brandhorst-Satzkorn 2d72d2488e Client agent docs updates (#5180)
* docs/client-agent: indent PAN docs correctly

Identifying the primary network interface is a sub-heading under the
PAN troubleshooting section.

* docs/transparent-sessions: add known issue around containers/VMs

VMs/containers that do not have access to the local network cannot
use aliases through transparent sessions.
2024-10-17 15:30:29 -04:00
Dan Heath 456f447167 docs: Update installer download link (#5176)
* docs: Update installer download link

* docs: Add absolute path
2024-10-15 11:22:28 -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
Danny KnightsandDan Heath d580fbb84a Added new remove the requirement for inbound network rules section (#5010)
* Added new remove the requirement for inbound network rules section

* docs: Fix typo

* Update website/content/docs/concepts/connection-workflows/multi-hop.mdx

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

* Update website/content/docs/concepts/connection-workflows/multi-hop.mdx

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

* Update website/content/docs/concepts/connection-workflows/multi-hop.mdx

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

* Update website/content/docs/concepts/connection-workflows/multi-hop.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>
2024-10-09 16:33:47 -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
vanphan24andDan Heath 778e09ba5e Update multi-hop.mdx (#5153)
* Update multi-hop.mdx

added blurb about using HCP-managed workers for outbound-only scenarios.

* Update multi-hop.mdx

misspelled "intermediary"

* docs: Minor rewrite

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-10-08 17:04:42 -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 81690c30ff docs: Add link to Postgres HA (#5080)
* docs: Add link to Postgres HA

* docs: Add new section to HA topic

* docs: Trigger a new build
2024-09-09 14:25:02 -04:00
Dan Heath a77d04edbb docs: Update session recording docs with asciicast info (#5072)
* docs: Update session recording docs with asciicast info

* docs: Remove mention of warnings
2024-09-05 12:09:04 -04:00
8ee9057960 docs: Update release notes (#5030)
* docs: Update release notes

* docs: Rephrase item

* docs: Add Important changes table to 0.17.1

* docs: Add info about wget and health checks

* docs: Fix typos

* docs: Minor rewrite

* code block fixes, style guide enhancements, metadata description refresh

* docs: Update location of wget binary

* docs: Fix bulleted list

* Update website/content/docs/operations/health.mdx

Co-authored-by: Sorawis Nilparuk (Bo) <sorawis.nilparuk@hashicorp.com>

* docs: Updates based on feedback

---------

Co-authored-by: stellarsquall <stellarsquall@protonmail.ch>
Co-authored-by: Sorawis Nilparuk (Bo) <sorawis.nilparuk@hashicorp.com>
2024-08-22 17:14:39 -04:00
Dan Heath c025e44ccb docs: Document recorded session max size (#5025) 2024-08-22 17:12:46 -04:00
Dan Heath 3dfe4ac111 docs: Fix broken anchor link in Credential management (#4998)
* docs: Fix broken anchor link in Credential management

* docs: Update link titles
2024-08-06 15:12:33 -04:00
Dan Heath 9805a7357c docs: Update link in 0.17.0 release notes (#4985) 2024-07-31 19:03:13 -04:00
Dan Heath 7ebc851f56 docs: Release notes 07-31 (#4978)
* docs: Release notes 07-31

* docs: Updates based on feedback
2024-07-30 17:21:25 -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
Dan Heath 490e23cfa6 docs: Add Desktop fix to known issues 0.15.x and 0.16.x (#4976) 2024-07-30 15:26:20 -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
Robin BeckandDan Heath efc6f54e98 Worker tags tabbed workflows (#4952)
* adds UI and CLI tags workflow in tabbed format

* adds /ui folder to improve organization, adds worker tags images

* adds tip for terraform workflows

* docs: Style updates

* docs: Fix broken image

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-07-29 15:45:09 -06:00
Dan Heath 06141b4f72 docs: Clarify aliases and scopes (#4966)
* docs: Clarify aliases and scopes

* docs: trigger a new build
2024-07-24 14:47:49 -04:00
Dan Heath d4e9bc02ae docs: Update roles in permissions concept (#4958)
* docs: Update roles in permissions concept

* docs: Revise intro paragraph
2024-07-24 11:05:22 -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
Lukas-Siegle 85f98a4a67 Update set-grant-scopes.mdx (#4953)
Update docs
2024-07-23 08:27:52 -04:00
Dan Heath f7bbe08c0c docs: Explain auth token TTL's impact on OIDC (#4938) 2024-07-18 14:05:29 -04:00
Dan HeathandRobin Beck 92b2d4490e docs: Document billing command (#4915)
* docs: Document billing command

* docs: Edits

* docs: Clarify inclusive/exclusive date format

* Apply batch of suggestions from code review

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

* docs: Minor edit

---------

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
2024-06-28 14:27:59 -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
Irena RindosandDan Heath 7e36f32e52 update tls docs to include controller led (#4905)
* update tls docs to include controller led

* docs: Minor style edits

* docs: Minor edits

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-06-27 11:43:39 -04:00
cb948018f9 Update style on core workflow image and light/dark theme (#4567)
* Update style on core workflow image and light/dark theme
Update style on how boundary works image and light/dark theme
Remove redundant image

* docs: Fix typo

---------

Co-authored-by: Robin Beck <stellarsquall@protonmail.ch>
Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-06-26 14:46:19 -04:00
Dan HeathandMichael Li 5df46b1b35 docs: Release notes for 0.16.2 (#4898)
* docs: Release notes for 0.16.2

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

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

---------

Co-authored-by: Michael Li <michael.li@hashicorp.com>
2024-06-18 12:45:47 -04:00
Johan Brandhorst-SatzkornandJeff Mitchell c6f3c375f3 api: remove deprecated grant_scope_id field (#4886)
* api: remove deprecated grant_scope_id field

The grant_scope_id field was deprecated in 0.15.0, so we can remove
it for 0.17.0.

* Fix tests

* Fix more tests

* Remove an option and some related code that stuck around

* Fix bats tests

---------

Co-authored-by: Jeff Mitchell <jeffrey.mitchell@gmail.com>
2024-06-17 12:09:33 -07:00
029ab627e2 Rab update filtering managed groups (#4821)
* renames managed groups filtering page, adds LDAP support

* updates managed groups filtering links and tutorials links

* Update website/content/docs/concepts/filtering/managed-groups.mdx

Co-authored-by: Jim <jlambert@hashicorp.com>

* docs: Edits

---------

Co-authored-by: Jim <jlambert@hashicorp.com>
Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-06-06 13:15:42 -06:00
Robin Beck 84ae33994a changes sync_interval_seconds default to 600 (#4823) 2024-06-05 13:54:57 -04:00
Daniel GreeningerandDan Heath 4f3c109eb5 docs: multi-hop error message linked to duplicate controller names (#4874)
* multi-hop error message linked to duplicate controller names

* docs: Minor edits

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-06-04 15:25:42 -04:00
Dan Heath 2541a3c398 docs: Revise requirements for SSH targets (#4866)
* docs: Revise requirements for SSH targets

* docs: Minor edit
2024-06-03 14:09:25 -04:00
Dan Heath 97d749fa26 docs: Clarify credentials and SSH targets (#4863)
* docs: Clarify credentials and SSH targets

* Trigger build
2024-06-03 12:08:37 -04:00
Dan Heath 4fd49f00f6 docs: Update release notes for 0.16.1 (#4838)
* docs: Update release notes for 0.16.1

* docs: Specify fix is for self-managed versions

* docs: Minor rewrites for clarity and style

* docs: Minor rewrites for sentence length
2024-05-30 16:14:07 -04:00
Johan Brandhorst-SatzkornandRobin Beck e64443c66f Rename daemon CLI command to cache (#4808)
* internal/cmd/wrapper: add deprecation wrapper

The deprecation wrapper can be used to display a warning to callers
when a command is deprecated.

* all: rename daemon to cache

Rename the boundary daemon command to boundary cache. This
avoids confusion with future client/daemons.

* changes daemon to cache in nav

---------

Co-authored-by: Robin Beck <stellarsquall@protonmail.ch>
2024-05-22 11:11:48 -07:00
Todd 5a06e4fe66 Auto generate the permissions pages. (#4786)
* Auto generate the permissions pages.

* Add add- set- remove- auto descriptions. Hide scope line when no scope provided

* Document the resource info struct
2024-05-10 12:49:48 -07: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
Dan HeathandRobin Beck 1420d182d6 docs: Update session-recordings CLI doc (#4775)
* docs: Update session-recordings CLI doc

* fixes id example

---------

Co-authored-by: Robin Beck <stellarsquall@protonmail.ch>
2024-05-08 13:56:19 -04:00
Irena Rindos 8b90efcde3 docs: fix broken session recording link (#4777) 2024-05-07 14:38:34 -04:00