Commit Graph
53 Commits
Author SHA1 Message Date
Dan Heath d49b7ae629 docs: Restructure table of contents (#3230)
* docs: Restructure table of contents

* docs: Copy edits to Develop/Get started sections

* docs: Add index to HCP Boundary section

* docs: Move OSS/Install section to top-level

* docs: Move Concepts above Configuration
2023-05-26 13:11:43 -04:00
Irena Rindos 736cde3584 Update references to deprecated controllers field (#3212) 2023-05-09 13:51:42 -04:00
Hugo 22ecf95449 docs: Explain -format json behaviour on boundary authenticate cmd (#3202) 2023-05-04 16:29:08 +01:00
Dan Heath fc2bf00838 docs: Update Getting Started guide, direct address (#2855)
* docs: Update Getting Started guide, direct address

* docs: Delete unused image

* docs: Resize image

* docs: Resize image
2023-02-14 12:47:06 -05: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
Ashlee M Boyer f3e23f485f Removing empty link (#2785) 2023-01-12 18:51:24 -05:00
Dan Heath 72410cfa97 Update Boundary network requirements (#2609) 2022-11-15 16:50:46 -05:00
Robin BeckandAshlee M Boyer c20445754e Docs deploy and login updates (#2574)
* replaces all references to Origin URL with Cluster URL

* fixes content headers

* removes reference to Beta

* removes content duplicated by dev-portal page subtitle

* updates style for code snippet copy-paste values

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

Use h1 header

Co-authored-by: Ashlee M Boyer <43934258+ashleemboyer@users.noreply.github.com>

* fixes headers

Co-authored-by: Ashlee M Boyer <43934258+ashleemboyer@users.noreply.github.com>
2022-10-28 12:49:36 -06:00
PPacent d2572a343c Fixing dead link for OSS getting started
Fixing dead link for OSS getting starte
2022-10-19 21:12:25 -07:00
Robin Beck 5a7cb5c181 Docs: getting started edits (#2521)
* getting started content updates

* updates screenshot
2022-10-05 09:24:21 -06:00
06370867c7 website: content updates for developer (#2426)
* chore(website/nav-data): sup to badge
```
            "badge": {
              "text": "OSS Only",
              "type": "outlined",
              "color": "neutral"
            }
```

* update previews to render developer UI

* Apply suggestions from code review

* update redirects

Co-authored-by: Kevin Wang <kwangsan@gmail.com>
Co-authored-by: HashiBot <62622282+hashibot-web@users.noreply.github.com>
2022-09-15 10:27:10 -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
Robin Beck 674b9627af adds architecture overview diagram (#2258) 2022-07-15 10:37:07 -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
Robin Beck 0ff4be119e updates learn links (#2230) 2022-06-23 12:06:39 -06:00
c05fa66096 Hashiconf docs changes (#2178)
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

Co-authored-by: XingLu Wang <95828202+xingluw@users.noreply.github.com>

Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>

Co-authored-by: Jeff Mitchell <jeffrey.mitchell@gmail.com>

Co-authored-by: irenarindos <irena.rindos@gmail.com>

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

Co-authored-by: Louis Ruch <louisruch@gmail.com>

Co-authored-by: XingLu Wang <xinglu.wang@hashicorp.com>

Co-authored-by: XingLu Wang <95828202+xingluw@users.noreply.github.com>
2022-06-22 02:37:49 -04:00
Robin BeckandHugo 860a053ba8 Docs: Update connect-to-target page with target-name example (#1887)
* added boundary connect -target-name example

* removes some passive and ableist language

* Apply suggestions from code review

add rewrite suggestions from @hugoamvieira

Co-authored-by: Hugo <hugoamvieira@users.noreply.github.com>

* update Using Connect Helpers copy

Co-authored-by: Hugo <hugoamvieira@users.noreply.github.com>
2022-03-10 11:26:48 -07:00
Robin Beck aab46370aa Docs: redirect Desktop install links to Learn (#1556)
* point install Desktop redirect to Learn

* hide /api-concepts/desktop and redirect to Learn

* add permanent redirect for /api-clients/desktop to Learn
2021-09-23 11:23:06 -06:00
Taylor Dolezal 248e1f36b5 Update next steps in connect to target documentation (#1439) 2021-08-09 08:12:31 -07: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
Carlos Alcaide Corvo aea1da77b6 Bump @types/node to latest release of v15 (#1296)
* Bump @types/node to latest release of v14

* Bump major version to v15
2021-06-11 09:41:17 -07:00
Jeff Mitchell 59939e768c Re-add information about passing args and templated values in args 2021-04-14 17:35:07 -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
Jeff MitchellandLouis Ruch bb4e0f5c01 Update getting started to clarify CLI usage (#975)
Co-authored-by: Louis Ruch <louisruch@gmail.com>
2021-03-03 13:29:17 -05:00
Jeff Mitchell 72aa110f72 CLI JSON updates (#962)
See Changelog for details.
2021-02-25 12:43:17 -05:00
Jeff Malnick 02fabe21c5 docs: add brew install instructions (#951) 2021-02-24 11:02:47 -08:00
Susmitha Girumala 3c33d05c96 docs: Add desktop client videos (#947)
* Add desktop client videos

* docs: refactor desktop video style

* docs: add wrapper for tabs to load videos correctly

* docs: add desktop video to homepage
2021-02-18 14:12:51 -05:00
Manuel Aude Morales 07eb7ddc62 Update run-and-login.mdx (#833)
Fix typo.
2020-12-17 10:08:42 -05:00
Jeff Mitchell b809d3f12a Add kube connect subcommand (#816) 2020-12-14 16:52:11 -05:00
Byungjin Park (BJ) e8e6249ec1 Fix typo in production.mdx (#728) 2020-10-19 07:55:12 -07:00
Jeff MalnickandJeff Mitchell 685b7c1e63 docs: add details on not saving token to system key manager (#698)
* docs: add details on not saving token to system key manager in getting started; use tabs to clean up the getting started flow

* Add more information

Co-authored-by: Jeff Mitchell <jeffrey.mitchell@gmail.com>
2020-10-15 15:30:06 -07:00
Radek Simko dcdcdf1e48 docs: Fix a typo & broken link (#678) 2020-10-14 21:01:32 -04:00
Jeff Escalante 1bdc56e359 remove 'TODO' in code example (#674) 2020-10-14 08:46:00 -07: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 a982fc9437 Remove proxy proto documentation for now (#606)
We haven't tested it with the new lib yet. We can add this back whenever
we get to testing it.
2020-10-10 13:42:04 -04:00
Randall MoreyandSusmitha Girumala b1eead187c step-by-step admin console instructions with videos (#583)
* docs:  update step-by-step instructions in common workflows and add video placeholders for forthcoming clickthroughs

* docs: Link clickthrough videos to "Getting started > Run and Login" and "Common Workflows" sections

* style: make video a comfortable viewing size and visually distinguish from background

* docs: Fix "frist" typo to "first" under "Manage Scopes"

Co-authored-by: Susmitha Girumala <susmitha@hashicorp.com>
2020-10-09 15:01:51 -07:00
Jeff Malnick 83a93a57dc docs: add next steps for getting started (#577) 2020-10-08 14:27:30 -04:00
Radek Simko b96a96b108 Fix typo (p*r*oduction) (#478) 2020-09-28 16:21:21 -04:00
Jeff Malnick e37aabac15 docs: use $ to denote a command for consistency with other product docs (#468) 2020-09-25 23:17:42 -07:00
Jeff Malnick de700cea87 docs: move developing UI to developing Boundary section (#467) 2020-09-25 23:07:31 -07:00
Jeff Malnick 43aa4618e0 docs: fix page headers and use curl for connect example (#466) 2020-09-25 23:02:15 -07:00
Jeff Mitchell 50af2cebb3 Update getting started docs 2020-09-25 20:14:18 -04:00
Jeff Mitchell ba216f894b Update docs and default address 2020-09-25 19:38:53 -04:00
Jeff Mitchell bec3d702fb Add -database-url to dev mode (#459)
Create default dev mode login name of "admin" and password of "password"
2020-09-25 17:36:47 -04:00
Jeff Malnick f1a49b0444 docs: add developing section and move building docs there (#456) 2020-09-25 14:11:04 -07:00
Jeff Malnick be4dc8264d docs: minor docs fixes (#451) 2020-09-25 13:53:36 -07:00
Jeff Malnick 0203cbf30f docs: fix header for getting started (#446) 2020-09-25 11:19:02 -07:00