Commit Graph
192 Commits
Author SHA1 Message Date
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
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
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 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
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
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
Dan Heath f7bbe08c0c docs: Explain auth token TTL's impact on OIDC (#4938) 2024-07-18 14:05:29 -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
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
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
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
f978993724 docs: Aliases overview, domain model, CLI docs (#4705) (#4751)
* docs: Aliases overview, domain model, CLI docs (#4705)

* docs: Aliases overview and domain model

* docs: Add new topics to TOC

* docs: Updates

* docs: Update CLI topics, add usage

* docs: Edits to value description

* docs: Add how-to for creating new target

* docs: Add procedure to update existing alias from CLI

* docs: Update targets domain model topic

* Apply batch suggestions from code review

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

* docs: Fix spelling

* docs: Remove ferry references

* docs: Remove note about aliases not working with generic commands

* docs: Updates to naming conventions

* switches Tabs order and adds tab groups

* fixes shell-session line breaks

* Apply batch of suggestions from code review

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

* docs: Delete redundant sentence

* docs: Fix jump links

---------

Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com>
Co-authored-by: Todd <github@quaddi.com>
Co-authored-by: Robin Beck <stellarsquall@protonmail.ch>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

* rerun tests

---------

Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com>
Co-authored-by: Todd <github@quaddi.com>
Co-authored-by: Robin Beck <stellarsquall@protonmail.ch>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
2024-04-30 14:31:48 -04:00
Robin Beck c5fdea2f16 fixes broken tutorial link (#4695) 2024-04-22 14:47:56 -06:00
vanphan24 c3fc80becf Update worker-tags.mdx to remove Enterprise tag on Vault worker filter (#4652)
Vault worker filters are not an Enterprise feature, so we're removing it.
2024-04-17 13:28:37 -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
1a33cb7199 made worker filter examples more promenent with different example types (#4589)
* made worker filter examples more promenent with different example types

* adds terraform tabs

* updates notes to use Note, Tip, and Warning elements

* deletes old screenshots

* docs: Minor edits

* docs: Make example explanations consistent

* clarifies boundary_credential_store_vault comments

---------

Co-authored-by: Robin Beck <stellarsquall@protonmail.ch>
Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-04-11 14:57:04 -04:00
Irena RindosandDan Heath b908e7b9da docs(bsr): explain bsr data chunks (#4554)
* docs(bsr): explain bsr data chunks
---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-04-08 11:59:25 -04:00
Irena Rindos 46a16b91e5 docs(bsr): explain BSR files in detail (#4546)
* docs(bsr): explain BSR files in detail
2024-03-20 15:47:13 -04:00
Jeff Mitchell 4542eef22b Add templating coalesce function (#4492) 2024-03-15 10:33:10 -04:00
Irena RindosandDan Heath 8c7bccdd98 docs: update session recording link (#4495)
* docs: update session recording link

* docs: Update link

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-03-07 15:50:54 -05:00
Irena RindosandDan Heath 39a0c0d833 docs(worker): add information about worker status and health (#4487)
* docs(worker): add information about worker status and health
---------
Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2024-03-07 08:04:08 -05:00
Yong Zhang 66c7f274bb Fix docs for event filters (#4365) 2024-02-06 12:31:58 -07:00
Dan Heathandstellarsquall d311563612 docs: Add multiple grant scopes commands (#4317)
* docs: Add multiple grant scopes commands

* fixes example role ID

* removes statements about each scope requiring its own role

---------

Co-authored-by: stellarsquall <stellarsquall@protonmail.ch>
2024-01-31 10:34:22 -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
Michael Li 95ad3eab48 docs: Update resource table format (#3432) 2024-01-26 14:32:01 -05:00
Louis Ruch 7921ce22fd test(grant): Use ID to validate version check (#4274)
* test(grant): Use ID to validate version check

* Update docs from id to ids

* Remove 'id' in 0.16.0
2024-01-25 13:27:22 -05:00
Jeff Mitchell 253d79116c Swap id field in grants to ids since that's now standardized (#4250)
* Swap id field in grants to ids since that's now standardized

* Fix some tests I missed

* Update generated resource table
2024-01-17 23:54:49 -08:00
Louis Ruch f26243e9af feat(recording): Delete Session Recording 2024-01-16 13:53:44 -08:00
Damian Debkowski b7739cd214 chore: generated files 2024-01-16 13:53:44 -08:00
e49a84ce9c docs: Add connection workflow docs (#4034)
* docs: Add connection workflow docs

* docs: Update HCP connect to target topic

* docs: Update Overview topic and nav

* docs: Break out exec flag topic

* docs: Updates to connect helpers topic

* docs: Update exec flag and proxycommand topics

* docs: Fix broken link

* docs: Update meta content and get started topics

* docs: Redirect deleted proxycommand topic

* docs: Add links for HCP and self-managed tutorials

* docs: Add multi-hop

* adds CodeTabs and windows instructions

* Update website/content/docs/concepts/connection-workflows/workflow-ssh-proxycommand.mdx

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

* removes windows workflow

---------

Co-authored-by: stellarsquall <stellarsquall@protonmail.ch>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
2023-12-13 13:58:10 -05:00
Dan Heath 5ff8d4e1c1 docs: Clarify projects' purpose (#4049)
* docs: Clarify projects' purpose

* docs: Update meta content

* docs: Add more context
2023-12-12 15:22:41 -05:00
Dan Heath caab9b0669 docs: Add OIDC prompt attribute (#4068)
* docs: Add OIDC prompt attribute

* docs: Clarify support for multiple prompts

* docs: Add disclaimer about differences by provider

* docs: Feedback from review
2023-12-01 11:24:48 -05:00
Dan Heath edc6e52a3f docs: Fix broken link (#4035)
* docs: Fix broken link

* docs: Fix a typo

* docs: Fix two more broken links
2023-11-13 15:04:12 -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
dani c89777de41 Expose Valid Principals for Vault SSH Signed Certs (#3791)
* allow additional valid principals when creating vault ssh signed cert cred lib

* add additional_valid_principals field to credential libraries documentation page
2023-10-24 12:44:51 -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
Adam BouhmadandDan Heath 35a8fa62cf Update Vault Credential Library Docs with additional options (#3739)
* Update Vault Credential Library Docs with additional Options

* Update credential-libraries.mdx

* docs: Minor copy edits

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2023-09-19 11:55:00 -04:00
Danny KnightsandDan Heath 0f05b19e04 SSH and TCP definition for Targets (#3513)
* Added detail to targets.mdx around target type in relation to whether using injected credentials, i.e. setting type to ssh or tcp

* Update website/content/docs/concepts/domain-model/targets.mdx

* Update website/content/docs/concepts/domain-model/targets.mdx

* docs: Update target type info, add requirements

* docs: Revise SSH credential text

* docs: Clarify reference to SSH

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2023-09-14 11:10:42 -04:00
JimandDan Heath dbda7e3e7a docs (auth/ldap): add new fields maximum_page_size, dereference_aliases (#3700)
Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2023-09-11 16:01:14 -04:00