Commit Graph
39 Commits
Author SHA1 Message Date
Dan Heath c01b8df2a3 docs: Clarify need for permissions to search (#4367)
* docs: Clarify need for permissions to search

* docs: List grants
2024-02-09 11:24:56 -05:00
Dan HeathandTodd 2005593dc2 docs: Add client cache documentation (#4244)
* docs: Add client cache documentation

* docs: Update command documentation

* docs: Add management section

* docs: Update commands and examples

* docs: Fix code examples

* docs: Fix typo

* Apply batch of suggestions from code review

Co-authored-by: Todd <github@quaddi.com>

* docs: Updates from review, rewrite add-token

* Apply batch of suggestions from code review

Co-authored-by: Todd <github@quaddi.com>

* docs: Update commands, add-token

* docs: Change keyring name

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

Co-authored-by: Todd <github@quaddi.com>

* docs: Update commands

* Update website/content/docs/commands/search/index.mdx

Co-authored-by: Todd <github@quaddi.com>

---------

Co-authored-by: Todd <github@quaddi.com>
2024-01-30 20:19:19 -05:00
Dan HeathandJohan Brandhorst-Satzkorn cffcc30eda docs: Update API docs (#4209)
* docs: Update API docs

* docs: Update content

* docs: Update content

* docs: Update content

* docs: Fix typos and word choice

* docs: Revisions, add graphic

* Apply batch of suggestions from code review

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

* docs: Deleting unnecessary content

* docs: Clarify deleted items

* docs: Add new limitation

* docs: Remove list tokens section

* docs: Update `list` command pages

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

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

* docs: Remove new options from worker doc

---------

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
2024-01-30 20:18:14 -05: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
ad5ad69d54 [Assembly] Boundary Commands (CLI) docs (#3411)
* Add 'Commands (CLI)' docs

* Update index.mdx

Added Environment variables section

* Add 'connect' sub-folder structure

* Adding listen address and port environment variables

* add connect to the docs navigation

* docs: Add Florin's update to index

* docs: Fix links and typo

* Add front-matter to resolve the PR check issue

* Update postgres.mdx

Boundary helper for POSTGRES

* Completed 'boundary accounts' command docs

* Draft connection option documentatino for kube, http, and rdp (#3455)

* Style updates for consistency

* Clean up using partials

* Add 'ssh' doc & updated style for consistency

* Fix paste error

* Fix the format issue on 'connect ssh' doc

* Add 'auth-methods' command doc (#3520)

* Add the docs for 'logout', 'server', and 'dev' commands (#3524)

* Add the docs for 'logout', 'server', and 'dev' commands

* Update the front matter

* Add auth-tokens and authenticate command docs (#3575)

* Add config command docs (#3576)

* updates to the ssh helper command docs (#3523)

* updates to the ssh helper command docs

* docs: Fix code block

* docs: Add minor copy edits

---------

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

* docs: Add worker commands

* docs: Update workers subcommands (#3598)

* docs: Update worker subcommands

* docs: Update certificate-authority subcommand

* doc: Fix syntax for code refererences

* docs: Add `users` commands (#3599)

* docs: Add `users` commands

* docs: Add more subcommands

* docs: Add `target` commands (#3608)

* Add command docs for 'credential-libraries' (#3610)

* Add 'credential-stores' command docs (#3611)

* Add 'credential-stores' command docs

* Add the output message

* Fix a typo

* Fix a typo

* Update the dummy token value

* docs: Add `storage-bucket` commands - update (#3615)

* docs: Add `sessions` commands (#3616)

* docs: Add `session-recordings` commands (#3617)

* Add 'credentials' command docs (#3619)

* Add 'credentials' command docs

* Fix typos

* docs: Add `scopes` commands (#3620)

* docs: Add `scopes` commands

* docs: Fix typos

* docs: Add `roles` commands (#3621)

* docs: Add `roles` commands

* docs: Add remaining subcommands

* Add 'database' command docs (#3628)

* Add 'database' command docs

* Update the format inconsistency

* docs: Add `managed-groups` commands (#3626)

* docs: Add `managed-groups` commands

* docs: Clarify description

* docs: Add `hosts` commands (#3629)

* docs: Add `host-sets` commands (#3630)

* docs: Add `host-sets` commands

* docs: Copy edits

* docs: Add `host-catalogs` commands (#3632)

* Add 'boundary groups' command docs (#3636)

---------

Co-authored-by: kevin-loehfelm <37027455+kevin-loehfelm@users.noreply.github.com>
Co-authored-by: kevin-loehfelm <kevin.loehfelm@hashicorp.com>
Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
Co-authored-by: Florin Cătălin Țiucra-Popa <106736683+FlorinTP@users.noreply.github.com>
Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com>
2023-09-12 14:37:31 -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
Hugo 22ecf95449 docs: Explain -format json behaviour on boundary authenticate cmd (#3202) 2023-05-04 16:29:08 +01:00
eea5e80fa2 Update documentation with new authenticate usage on the CLI (#2865)
* docs: update deploy-and-login getting started guide with new authenticate usage

* docs: update api-clients/cli.mdx to remove login-name flag when using authenticate

* docs: update common-workflows/manage-users-groups.mdx to remove login-name flag when using authenticate

* docs: update common-workflows/workflow-ssh-proxycommand.mdx with new short form usage of authenticate command when using the primary auth method in the global scope

* docs: update oss/installing/no-gen-resources.mdx to remove login-name usage in authenticate command

* docs: update oss/installing/run-and-login.mdx with short form usage of boundary authenticate

* docs: fix tabs

* docs: fix numbering

* Apply batch of suggestions from code review

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

* docs: fix code blocks

* fixes code blocks

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
Co-authored-by: stellarsquall <stellarsquall@protonmail.ch>
2023-02-07 10:40:31 -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
Hugo Vieira 1f9063e042 docs(target): Introduce direct address targets and explain tradeoffs 2023-01-09 15:39:55 +00:00
Johan Brandhorst-SatzkornandYoko Hyakuna 5dc7e7f55c doc: Add link to generated API docs on API page (#2460)
* doc: Add link to generated API docs on API page

This makes it easier to find the generated API docs from the API
description page.

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

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

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2022-09-16 12:02:15 -04:00
Jeff Mitchell f494a9b80a Update website with new password rules taken into account (#2330)
* Update website with new password rules taken into account

* Remove the prompt examples as it messes up copying
2022-08-09 17:46:25 -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
Lili Cosic d2602584ab docs: Add full example for using recovery KMS workflow (#1888) 2022-03-29 18:18:33 -07:00
xka5h 237f0c5704 updated CLI connection options, including addr (#1884) 2022-03-03 14:15:18 -08:00
Jeff Mitchell e9a8ede0d6 Move wrapper package back to SDK (#1511)
TF uses this, so SDK is a decent place for it. It doesn't create
dependencies between it and API.
2021-09-08 12:15:42 -04:00
Jeff Mitchell 081de3cf79 Migrate sdk/recovery to api/ and sdk/wrapper to internal (#1507)
* `recovery` is only used by the API (and the main module, for decryption)
* `wrapper` is only used by the CLI right now

Moving these brings them closer to the code that uses them, and makes
the SDK package a bit more clear in terms of functionality.
2021-09-07 22:13:19 -04:00
df35699c4e Integrate with Vault to retrieve and manage per session credentials (#1308)
* Fix down migrations

* Udpates due to merge

* Sentinel values only have to be greater than 0

* Create credential related sdk structs and methods.

* Post merge interface updating.

* Removing scratch code that was not cleaned up.

* updates

* Convert client certificate and client certificate keys into pem blocks and validate.

* Add newline at end of file.

* Faster check for "s" at the end of a resource name when generating from templates.

* make fmt

* updates

* Add dynamic credentials to a session

* Refactor: move contents of file

* updates

* Updates

* Add InvalidDynamicCredential error

* Assign credentials

* Allow updating client certificates seperate from the client certificate key.

* Replace application purpose string with enum value

* PR feedback / fix go test .

* Delete dead code

* Use common view

* Refactor: extract interface and rename method

* Refactor: move code to eliminate privPurpLibrary

* Add comment to requestMap

* Refactor: do not export methods on an unexported struct

* Update internal/db/schema/migrations/postgres/10/03_vault_credential.up.sql

Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com>

* Add comments to credential Purpose constants

* Reorder switch statements to handle errors first

* PR feedback

* update

* fix merge

* Organizing the scheduler code and extract the individual store creation test helper function.

* Run 'make fmt'

* Create certificate when creating store.  Allow vault address to be passed in as option

* Refactor: rename database views and associated structs

This change renames two database views and associated go structs to use
a consistent naming pattern. Views ending in 'private' contain encrypted
credentials needed for connecting to Vault. Views ending in 'public'
mirror the 'private' views but do not include any encrypted values.

This change does not include any changes to functionality or behavior.

* Adding SAD target operations for credential libraries to the SDK.

* Add status field and enumeration table for credential status

* Refactor: rename Status to TokenStatus

* Add status to vault credentials

* Creating the template for the CLI and helper functions.

* Add private database view for vault credentials

* Add scope_id to view and cleanup TODO comment

* Reformat embedded sql queries

* Add vault client helpers

* updates

* white space

* Add LookupLease test

* CLI commands for Store work.  Renamed fields in proto w/ vault prefix.

* Test issue credentials with client TLS

* Add additional checks to vault ping

* Add an error for vault token capabilities and create a VaultToken error kind

* Add support for working with Vault policies

* Use Vault 1.7.2 for testing

* Add testing helper for creating a vault client with a non-root token

* Fix Vault renew lease test

The Vault renew lease endpoint accepts an optional duration parameter
for requesting the number of seconds to extend the lease by. However,
Vault is not required to honor this request.

* Add a var for the required capabilities of a boundary Vault token

* Enhance the test helper for adding a policy to Vault

* Allow the test role in postgresql to revoke credentials

* Remove out of date comments

* Enhance Vault test helpers for the database secrets engine

* Reformat comments

* Add a method for getting the capabilities of the current Vault token

* Add revoke lease to internal Vault client

* Reformat: combine err return line with check for nil line

* Remove redundant checks in test code

Remove checks in test code that are redundant with checks in the test
harness.

* Refactor CreateToken test helper to return the secret and the token

* Fix build failures caused by signature change in vault.CreateToken

* Fix Vault version and Vault API link in comments

* ran `make gen` after merging from mgaffney-vault.

* Remove Vault prefix from attribute fields in API, create a base CLI option for adding field prefixes. format now uses that prefix for error reporting.

* Template now allows attaching attribute field prefixes.

* Credential store uses PrefixAttributeFieldErrorsWithSubactionPrefix.

* Fixing naming of vault flags and helper flags.

* Updating more references to generated api methods.

* Make the capabilities String method more readable

* Add comment outlining PrintApiError usage of Options.

* Refactor test to move declarations closer to first use

* Fix comment

* Implement revoke method on vault repository

* Tests now verify certs, CA, and tokens, addresses can be updated in a store.

* Added test for creating store with pk/cert in same field.

* Allo updating certificates seperate from private key.  Only contact backing vault service when updating token.

* Fixing bad tests and removing unused code.

* Adding tests for various ways of updating tokens.

* Add private credential

* Add token revocation job and cred renewal/revocation job

* Regen after merge.

* Fixing field mask related merge error.

* Create Library CLI. Removes vault prefix from path. Adds a WithoutCleanup testOption for vault.

* Set all credentials to revoked when a token is revoked

* Fixing missed renaming update.

* fix copy/paste error.

* Fixing code generation errors after merge.

* make gen after merge.

* Update internal/cmd/commands/credentialstorescmd/vault_funcs.go

Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com>

* Update internal/cmd/commands/credentialstorescmd/vault_funcs.go

Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com>

* Update internal/cmd/commands/credentialstorescmd/vault_funcs.go

Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com>

* Refactor: move migrations from 10 to 12

* Removing logic from transaction.

* wrapping client errors in the calling op for CredentialStore's client() method.

* Redact token

* redact client key

* updates

* Add trigger to revoke credentials when session is canceled or terminated

* Fixing some help text for some flags.

* Add ability to load values from files (file://) or environment variables (env://).

* Updating comments

* fix bad merge

* feedback

* Adding issued credentials to sessions.

* Error on capabilities

* updates

* Expose NewVaulTestServer

* Add godoc

* Adding generated SessionCredential struct for API.

* Progress on building handler test for Authorize Session.

* feedback

* Update policies

* Add 'revoke' as a status for Vault Tokens

* Add delete_time to vault credential store

* Create dynamic credentials at session creation time.

* Tests pass with credentials attached to AuthorizedSession result.

* Only call issue if there are credentials to issue.

* Fixing output only issues. Adding type to credential library.

* Fix test to clear un/pw generated.  confirm generated un/pw changes from 1 authorize session call to another.

* Update lookupTokenError

* Add delete_time to private credential store

* Refactor: move private store to separate file

* Fixing tests for AuthorizeSession and verifying error cases.

* Only create the credential repo if there are credentials to issue.

* Rename Library field to CredentialLibrary.

* Fixing missing change of Library to CredentialLibrary.

* Removing Default SDK functions for fields which are required and update CLI to match.

* Replace resource specific id variables with "id" and the input parmater for paths to be just a single string and the resource name as it should show up in the path.

* Soft delete vault credential stores

* Prevent new SQL functions from silently overwriting existing functions

* Rename "Hmac" to "HMAC" in the human readable cli response table.

* Fix tests

* Add vault database cleanup jobs

* Add ability to set the token period in the vault test harness

* updates

* Add not_null_columns func test

* remove unused struct

* Up no output timeout

* Validate current vault token on addr update

* Fix client cert change test

* add cert test

* Update revocation job where

* Fix comment

* Use Vault's default port in CLI help strings

* Remove down migrations

* Increase migration file numbers by 1

* Run make migrations

* Move migrations from 12 to 10

* Increase Circle CI timeout for acceptance tests

* Fix spelling mistake in error messages

* ASD cmds for Target and returning credentials to AuthSession request (#1338)

* Add Add/Set/Remove commands for libraries on Targets.  Return credentials on AuthorizeSession request.

Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com>

Co-authored-by: Louis Ruch <louisruch@gmail.com>
Co-authored-by: Todd Knight <T.Alan.Knight@gmail.com>
Co-authored-by: Jeff Mitchell <jeffrey.mitchell@gmail.com>
2021-06-22 22:26:26 -04:00
Susmitha Girumala 0b819d248e Update desktop guide for Windows (#1292)
* Add Windows screenshots to desktop guide
2021-06-08 09:51:15 -07:00
Jeff Mitchell 7ee8ddba6a True up some spelling 2021-05-14 16:26:25 -04:00
Jeff Mitchell 4690225c1e Update delete action behavior and JSON format output (#1155)
This PR changes delete behavior:

* On success, a 204 is returned rather than a 200 with an empty JSON object
* The CLI now passes through the 404 error if encountered instead of swallowing it

It also updates formatting for JSON to use the response body, which means that the item (or items) in the JSON format are actually the format across the wire, instead of being reinterpreted by unmarshaling into the Go SDK and then remarshaling.
2021-04-26 20:38:55 -04:00
NoahMundahl 2455445d16 website: minor edits to "Installing" pages and "Go SDK" page (#1139) 2021-04-26 10:37:50 -04:00
Susmitha Girumala bdea6e16b3 docs:desktop: Remove beta notification in getting started guide (#1128) 2021-04-15 10:44:29 -04:00
John Reese c096157cf9 Fix spelling errors found in the documentation (#1073) 2021-04-08 12:14:36 -04:00
Bryce Kalow bd8cc5464e feat(website): migrates nav data format and updates docs pages (#1049)
* migrates nav data format and updates docs pages

* removes sidebar_title from content files

* updates api docs to work with new format
2021-04-05 13:04:57 -04:00
Susmitha Girumala aa2054d684 Update desktop guide to beta release (#993) 2021-03-11 10:50:37 -05:00
Jeff Malnick 02fabe21c5 docs: add brew install instructions (#951) 2021-02-24 11:02:47 -08:00
Jeff Mitchell 341e7aff0d CLI Generation (#953) 2021-02-23 19:06:39 -05:00
Jeff Malnick 54ba53e894 docs: update link to releases page for DT client download (#944) 2021-02-17 10:28:17 -08:00
Pete Pacent db6b54d260 Update desktop.mdx (#938)
Add disclaimer for desktop client doc and releases link
2021-02-16 10:17:36 -08:00
Jeff Malnick b8fe4083c1 Add initial Desktop docs (#930)
* docs: initial desktop docs
2021-02-12 15:38:41 -08:00
Jeff Mitchell 09b865ab28 Add pass cred storage support (#731)
* Add `pass` cred storage support

Make it the default on non-Windows/macOS

Document the token storage behavior
2020-10-21 09:00:17 -04:00
Paul Jones 7fda3765fe Correct module imports in examples (#680) 2020-10-14 13:09:53 -04:00
e69e1a0978 Final doc polish (#663)
* docs: fix the output in creating org roles and remove the TF configurations not used by each section

* Fixing dead link and cli output typo

* Fixing lots of dead links

* Fixing getting started links

Co-authored-by: Jeff Malnick <malnick@gmail.com>
Co-authored-by: Pete Pacent <ppacent@hashicorp.com>
Co-authored-by: Jeff Mitchell <jeffrey.mitchell@gmail.com>
2020-10-13 13:12:30 -07:00
Jeff Mitchell 7129971e56 Update website docs to mostly move organization -> org (#652) 2020-10-13 10:47:32 -04:00
Jeff Mitchell 54be0f1d7a Put a bit more color around the null explanation in the CLI docs 2020-10-12 16:33:22 -04:00
Jeff Mitchell 7268380335 Add information about 'null' to CLI docs 2020-10-12 16:25:14 -04:00
Jeff Mitchell d6e6553a4e Update Authentication Method -> Auth Method 2020-10-12 16:19:13 -04:00
Jeff Mitchell e162f9f183 Consolidate client/API information to a new section (#630) 2020-10-12 14:46:17 -04:00