Commit Graph
112 Commits
Author SHA1 Message Date
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
2179af63cb Hashidays Docs (#3313)
docs: add 0.13 feature docs

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
Co-authored-by: Jeff Malnick <malnick@gmail.com>
Co-authored-by: Michael Li <michael.li@hashicorp.com>
Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com>
Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
Co-authored-by: XingLu Wang <95828202+xingluw@users.noreply.github.com>
Co-authored-by: Jeff Mitchell <jeffrey.mitchell@gmail.com>
2023-06-12 23:53:27 -07:00
XingLu WangandDan Heath 1628fcf01f Worker docs cleanup for 0.13 (#3292)
* Worker docs cleanup

* Apply suggestions from code review

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

* Update pki-worker.mdx

* Update website/content/docs/configuration/worker/pki-worker.mdx

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2023-06-06 15:14:31 -07:00
Johan Brandhorst-Satzkorn 59f78ac1f8 config: allow wasm execution under UI CSP
The wasm-unsafe-eval option is necessary for the asciinema
player on the Admin UI
2023-05-31 12:18:24 +00:00
Irena Rindos 736cde3584 Update references to deprecated controllers field (#3212) 2023-05-09 13:51:42 -04:00
Irena RindosandDan Heath b4a8032649 docs: Update website to include SIGHUP, SIGTERM, and SIGINT behaviour (#3140)
* docs: Update website to include SIGHUP, SIGTERM, and SIGINT behaviour

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2023-04-03 15:58:45 -04:00
Jeff Mitchell 163ce184b8 KMS-PKI Workers (#3101)
This adds a new mechanism for worker authentication that uses the
third-party arbitration of the original KMS flow by leveraging
recently-added capabilities in nodeenrollment to support a registration
wrapper. This allows for workers to be registered to the system with
just a name and a matching wrapper, while at the same time allowing
these workers to be used for private Vault access and multi-hop as they
contain per-worker encryption keys and support rotation.

Nodes using this mode will generate and rotate credentials in-memory
(using another recently added nodeenrollment capability) so will have a
new set of keys on every startup. This has the side effect of ensuring
that there is never a conflict or re-use of these credentials.

Note that the normal test worker flow was using the now-deprecated KMS
method; there is still a test that uses this (explicitly) but all other
tests using test workers that did not specify a specific PKI flow now
actually use this mechanism. This means there is fairly decent test
coverage in a general sense, plus the specific tests updated/added for
this feature.

This also adds a new KMS type that can be used to have
distinct KMSes for upstream authentication vs. accepting from
downstream.
2023-03-30 16:20:28 -04:00
Dan Heath d1e30af9ce docs: Add links to new tutorials (#3106)
* docs: Add links to new tutorials

* docs: Make heading plural

* docs: Small rewrite to force a commit
2023-03-23 13:56:13 -04:00
Dan Heath d7049e4e79 docs: Update main branch with 0.12.0 revisions (#2975)
* docs: Add HCP only to heading

* docs: Add worker requirements

* docs: Fix heading format and hierarchy

* docs: Fix headings format

* docs: Update feature name using "sessions"

* docs: Fix heading hierarchy

* docs: Fix headings format

* docs: Fix spacing in title
2023-02-16 13:37:25 -05:00
Jeff Mitchell d15af1d5f3 Remove incorrect assertion that public_addr can be a go-sockaddr template 2023-02-09 14:19:06 -05:00
Todd f7030513c1 Update documentation to encourage using "hcp_boundary_cluster_id" (#2940) 2023-02-08 13:38:13 -08:00
d41ef25a27 docs: Update multi-hop docs (#2806)
* docs: Update multi-hop docs

* Apply batch of suggestions from code review

Co-authored-by: Kendall Strautman <36613477+kendallstrautman@users.noreply.github.com>
Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com>

* docs: Fix spelling

Co-authored-by: Kendall Strautman <36613477+kendallstrautman@users.noreply.github.com>
Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com>
2023-01-24 09:15:52 -05:00
Ashlee M Boyer e6be6431b2 docs: Migrate link formats (#2777)
* Adding docs-content-check-legacy-links-format workflow

* Adding test-link-rewrites workflow

* Migrating links to new format
2023-01-20 15:17:34 -08:00
d15bd5507e Multihop workers doc (#2772)
Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
Co-authored-by: XingLu Wang <95828202+xingluw@users.noreply.github.com>
2023-01-13 08:18:03 -05:00
Jeff Malnick 07a823c520 docs: update GCP KMS docs with environment variable usage (#2690) 2022-12-07 16:36:48 -05:00
Danielle 5f8d292ea1 Inject Custom Response Headers By Status (#2587)
* add custom ResponseWriter struct to inject custom response headers based on status code

* docs

* upgrade listenerutil

* fix config tests

* replace all instances of "data:*" with "data:" to reflect changes to listenerutil

* swapping strings.HasPrefix in favor of mux.Handler for ui request matching

* set ui path as const

* add custom response headers to changelog
2022-12-01 13:15:53 -05:00
Johan Brandhorst-SatzkornandDan Heath df02501dcc Create new "previous-root" key purpose for root key migrations (#2639) (#2648)
* Update go-kms-wrapping dependency

* Apply changes suggested by Jeff

* Fix listener test

* Add note about config fix to CHANGELOG

* Review comments

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

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
2022-11-24 20:07:37 -05:00
Yoko Hyakuna fa619b0910 Address reported bugs (#2449) 2022-09-13 19:48:06 -04:00
Louis Ruch 5812a42ba3 feat(scheduler): set intervals from config (#2443) 2022-09-13 10:01:49 -07:00
Irena Rindos cee5ff7599 Minor documentation fixes for controller-led (#2432)
* Minor documentation fixes
2022-09-08 10:15:47 -04:00
Jeff MitchellandIrena Rindos 01fb949d0b Add controller-led worker auth flow (#2413)
This adds an action to the API that allows pulling out an activation
token that can be given to a worker in its config (directly or via env
or file). The worker can pass this along with its normal request in
place of its normal nonce and the server will automatically accept it.

Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com>
2022-09-02 14:32:41 -04:00
Irena Rindos 547e7a5970 docs(workers): add documentation for pki worker cred encryption (#2397)
* docs(workers): add documentation for pki worker cred encryption
2022-08-26 13:08:18 -04:00
Jeff Mitchell 30ede3b137 Fix various website issues (#2344)
I found some invalid links and some missing KMS information; this fixes
those.
2022-08-09 17:56:29 -04:00
Mark Lewis 6d5abba2e5 Update common.mdx (#2099)
typo
2022-07-20 15:33:49 -04:00
Mark Lewis 80b2dbe862 Update overview.mdx (#2098)
Fix missing bracket
2022-07-20 15:33:27 -04:00
Loann LeandRobin Beck d5633952db Boundary documentation: content cleanup in prep for devdot migration (#2249)
* cleaning up docs

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

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

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

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

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

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

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

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

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

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

* Update website/content/docs/configuration/worker/pki-worker.mdx

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

* Update website/content/docs/getting-started/deploy-and-login.mdx

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

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
2022-07-12 13:29:35 -06:00
Timothy Messier fd5d15af27 feat(config): Add database config options for idle connection management (#2176)
This adds two new config options for the `database` stanza:

- `max_idle_connections`
- `max_idle_time`

These correspond to settings for the underlying `sql.DB` instance. They
can be used to have finer control over the controller's database
connection pool. For example this can be used to mitigate the high
connection overhead when connecting to postgres by setting a high
`max_idle_connections` and either setting `max_idle_time` to zero or to
a high duration.

Alternatively, if using a connection pool like pgpool-II or pgbouncer,
`max_idle_connections` can be set to 0.

See:
    https://pkg.go.dev/database/sql#DB.SetMaxIdleConns
    https://pkg.go.dev/database/sql#DB.SetConnMaxIdleTime
    https://www.pgpool.net/mediawiki/index.php/Main_Page
    https://www.pgbouncer.org/
2022-07-05 15:25:55 -04:00