Commit Graph

1475 Commits

Author SHA1 Message Date
Sarah Chavis
a2de4c75cd
[Docs] Client count doc updates for ACME update in 1.14 (#21541)
Co-authored-by: Alexander Scheel <alex.scheel@hashicorp.com>
Co-authored-by: Brian Shumate <brianshumate@users.noreply.github.com>
2023-07-07 08:32:31 -04:00
Steven Clark
1a2eaf0de3
Add remediation steps to the PKI health-check docs (#21364)
* Add remediation steps to the PKI health-check docs

* Apply suggestions from code review

Co-authored-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Implement PR feedback

* Apply suggestions from code review

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

---------

Co-authored-by: Alexander Scheel <alex.scheel@hashicorp.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-07-06 19:38:51 -04:00
Anton Averchenkov
f4f0412b6a
[docs] Convert titles to sentense case (#21426)
* Convert documentation titles to sentense case

* Docker, Google, Foundry, Cloud proper case
2023-06-30 19:22:07 -04:00
Tom Proctor
1ffc56cb42
Docs: Updates for vault-mssql-ekm-provider-enterprise release v0.2.1 (#21529) 2023-06-30 18:00:44 +00:00
Sarah Chavis
282b4a0738
Correct typos in 1.14.0 release notes (#21499) 2023-06-28 17:20:05 +00:00
Yoko Hyakuna
81a5e2ee65
[Docs] Add namespace naming restriction (#21493)
* Add naming restriction

* Update website/content/docs/enterprise/namespaces.mdx

Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com>

* Use sentence case for heading

---------

Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com>
2023-06-28 08:57:28 -07:00
Yoko Hyakuna
9f741af664
Update the tutorial link to point to the default collection link (#21490) 2023-06-27 14:34:52 -07:00
Angel Garbarino
936fb74a18
Add UI safari login screen known issue (#21489)
* add known issue to docs

* update to correct pattern

* fix

* Update website/content/partials/known-issues/ui-safari-login-screen.mdx

Co-authored-by: Chelsea Shaw <82459713+hashishaw@users.noreply.github.com>

* Update website/content/partials/ui-safari-login-screen.mdx

Co-authored-by: Chelsea Shaw <82459713+hashishaw@users.noreply.github.com>

---------

Co-authored-by: Chelsea Shaw <82459713+hashishaw@users.noreply.github.com>
2023-06-27 21:20:06 +00:00
Yoko Hyakuna
bcd7083d94
Add a step to revert the configuration (#21480) 2023-06-27 11:37:04 -07:00
Max Bowsher
43ae739971
Refactor identity/mfa/method/* endpoints to fix bad OpenAPI (#20879)
* Refactor `identity/mfa/method/*` endpoints to fix bad OpenAPI

There is a problem with how the `identity/mfa/method/*` endpoints are
defined, resulting in incorrect OpenAPI generation.

I raised hashicorp/vault-client-go#180 to track a consequence, and
opened #20873 which explains the problem and adds a log message to
detect it.

This PR is now the fix.

It's actually quite an interesting problem, that has come about through
some particular implementation choices, in Vault's first/only case where
REST API objects are created by writing to the collection URL, and have
their ID allocated by the server, instead of the client.

The triggering cause of the malfunction was trying to have a single
framework.Path struct instance which optionally includes or excludes the
method_id path parameter, and also another framework.Path struct
instance handling list operations.

The fix is to simplify the path regexes, and have one framework.Path
which handles the method_id being present, and one that handles it being
absent.

The diff is somewhat large, because the affected code had been
copy/pasted four times (TOTP, Okta, Duo, PingID) - so I took the
opportunity to fix the duplication, creating appropriate helper methods
so that the quadruplicated code could be re-unified.

* Revise documentation

This update refactors how the documentation presents these endpoints to
users, both for clarity, and to align with the new structure of the
code.

From a user perspective, it clears up some unclear presentation of when
the `method_id` parameter should and should not be present, adds
a missing description of the response to create requests, and changes
the `method_id` parameter name to be used consistently (rather than `id`
in some cases, unlike the actual code/OpenAPI).

* Fix incorrect acronym (review fix)

* Accept suggestion of tweaked grammar in documentation

Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com>

* Add changelog

---------

Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com>
2023-06-23 13:32:41 -04:00
Jason O'Donnell
a71cdb6165
Add known issue about update_primary_addrs panic (#21443)
* add known issue about update_primary_addrs panic

* Fix partial

* Fix render
2023-06-23 11:51:35 -04:00
Shubham P
e3dad5b6da
add loopback4-vault in node.js client libraries (#21008) 2023-06-22 13:23:01 -07:00
Doug Knight
5d13092b03
docs: clarify external auth method considerations (#21301)
Signed-off-by: Doug Knight <doug.knight@karmix.org>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-06-22 19:31:20 +00:00
Rowan Smith
c7db2d61b0
[Docs] ldap auth add VAULT_LDAP_PASSWORD environment variable (#21407)
Add VAULT_LDAP_PASSWORD environment variable
2023-06-22 11:31:26 -07:00
Violet Hynes
8e40823fe1
Some small KV API docs improvements (#21395) 2023-06-22 13:39:47 -04:00
Meggie
416dff8765
Update upgrade-to-1.14.x.mdx (#21389)
Add information about Docker retirement.
2023-06-22 17:25:06 +00:00
Yoko Hyakuna
58b6cb1c42
[Docs] Add cross-links to related tutorials (#21405)
* Add cross-links to related tutorials

* Add additional tutorial links
2023-06-22 08:27:00 -07:00
Alexander Scheel
15aee2e0ba
Fix re-migration of existing CA bundles (#21316)
* Fix re-migration of existing version 1 storage bundles

Related: VAULT-17307

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add test for v1->v2 migration post-issuer deletion

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add changelog entry

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add known-issue about PKI double migration

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Update website/content/partials/pki-double-migration-bug.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/partials/pki-double-migration-bug.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/partials/pki-double-migration-bug.mdx

* Additional clarity around known issue

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

---------

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-06-21 20:34:51 +00:00
Steven Clark
eb634e9326
Remove bump_version from transit import docs (#21393)
- The argument was removed along the development path, but the
   documentation was not updated.
2023-06-21 15:36:52 -04:00
miagilepner
d8b811d8da
Add additional reporting versions to the documentation (#21304)
* add additional versions to the documentation

* pr fixes

* pr fixes
2023-06-21 17:42:23 +02:00
Sarah Chavis
3ad87e4b9a
Updates for GA (#21374) 2023-06-21 07:44:50 -07:00
Violet Hynes
99cf3836b6
Update logging completed requests docs (#21368) 2023-06-21 09:18:04 -04:00
Adrian Todorov
c1e6fa36e1
Update faq.mdx to remove dead link (#21377) 2023-06-21 11:12:06 +00:00
Alexander Scheel
4eed18cf49
Add ACME consideration about entity templating (#21356)
These don't do anything but reject requests:

> The server will not issue certificates for the identifier:
> role (something) will not issue certificate for name
> xps15.local.cipherboy.com

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
2023-06-20 14:53:47 +00:00
Nick Cabatoff
67927a1e9f
Make sure that main upgrading page contains the guidelines for replicated cluster upgrades (#21351) 2023-06-20 08:37:43 -04:00
Anton Averchenkov
e31ead37ba
[docs] Add Agent & Proxy to related tools (#21352) 2023-06-19 14:15:03 -04:00
Andy Assareh
6ebb61cc35
correct spelling error - Compatability to Compatibility (#21333) 2023-06-19 12:38:07 -04:00
Sarah Chavis
8af6780325
[DOCS] 1.14.0 draft release notes (#21296)
Push initial draft of layout and text
Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2023-06-16 17:08:51 -07:00
Anton Averchenkov
3908ec9dc4
agent: Fix agent generate-config to accept namespace (#21297) 2023-06-16 16:04:15 -04:00
Violet Hynes
d76424cb53
Miscellaneous docs cleanups (#21327) 2023-06-16 15:38:58 -04:00
Alexander Scheel
3347e5d56b
Fix naming of enable_templating parameter (#21319)
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
2023-06-16 17:04:37 +00:00
Violet Hynes
41f392c43f
Fix some broken links/clarify some things in the Vault Proxy docs (#21262)
* Fix some broken links/clarify some things

* More docs fixes

* More docs fixes
2023-06-16 08:47:29 -04:00
Sarah Chavis
774d75e63e
1.14.0 Known Issues text update (#21118)
TW editorial review on language and restructuring for scanability
2023-06-15 13:55:19 -07:00
Alexander Scheel
e6f3003adc
ACME Considerations Guide (#21225)
* Add notes on PKI performance and key types

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add ACME Public Internet section

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add note on importance of tidy

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add note on cluster scalability

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add note about server log location

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Fix ToC, finish public ACME discussion

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add note on role restrictions and ACLs

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add note on security considerations of ACME

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add consideration note about cluster URLs

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add note on 90 day certificates

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add note about client counts and ACME

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

---------

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
2023-06-15 14:29:52 -04:00
miagilepner
b993384983
VAULT-16905: Add upgrade description about non entity tokens (#21245)
* add to utilization reporting

* add known issue

* fixes
2023-06-15 17:38:28 +02:00
Theron Voran
8946911078
docs/vso: updating pki secret destination doc string (#21195)
From hashicorp/vault-secrets-operator@90ae1b3095
2023-06-13 14:21:23 -07:00
Nick Cabatoff
c823bd99a8
Document known issues surrounding update-primary on PR secondaries. (#21141) 2023-06-13 14:02:56 -04:00
Theron Voran
a3657dc604
docs/pki: add remove_roots_from_chain option to /pki/issue (#21161)
Adds the `remove_roots_from_chain` option to the docs for
`/pki/issue`, based on addNonCACommonFields().
2023-06-13 10:15:52 -07:00
Daniel Huckins
7a47df649d
[docs] Add note about agent sidecar injector (#21171)
* add note about agent sidecar injector

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* Apply suggestions from code review

---------

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>
2023-06-13 12:38:54 -04:00
Yoko Hyakuna
51c7e3e31a
Add the payload parameter description (#21050)
* Add the payload parameter description

* Update website/content/docs/enterprise/license/utilization-reporting.mdx

Co-authored-by: Mike Palmiotto <mike.palmiotto@hashicorp.com>

* Update website/content/docs/enterprise/license/utilization-reporting.mdx

Co-authored-by: Mike Palmiotto <mike.palmiotto@hashicorp.com>

* Update website/content/docs/enterprise/license/utilization-reporting.mdx

Co-authored-by: Mike Palmiotto <mike.palmiotto@hashicorp.com>

* Adjust spacing

---------

Co-authored-by: Mike Palmiotto <mike.palmiotto@hashicorp.com>
2023-06-13 09:17:24 -07:00
Steven Clark
820f7ee22f
Clarify that no_store=true certs can still be revoked (#21169)
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
Co-authored-by: Alexander Scheel <alex.scheel@hashicorp.com>
2023-06-13 11:34:26 -04:00
Steven Clark
95ad246162
Update docs for new 1.14 ACME health checks (#21063)
* Update docs for new 1.14 ACME health checks

* Remove wording about informational warning only

 - The health check can report back warnings if permissions are an issue
   or if the local cluster configuration is missing.
2023-06-12 22:17:32 -04:00
Daniel Huckins
6d232b2dc5
[docs] Agent Process Supervisor Mode (#21056)
* first pass at docs

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* try to add anchors

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* links didn't work correctly, just remove

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* add partial

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* use new style

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* add to index

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* edit index

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* add config

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com>

* update file name

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* more changes from PR review

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* updated name

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* exec -> process supervisor

* convert to old paragraph markers

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* exec -> process supervisor

* add link

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* exec -> process supervisor

* exec -> process supervisor

* "full stop"

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* little blurb about exit behavior

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* grammar

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* Apply suggestions from code review

* add link

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* expand the config section

* add env_template example

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* expand config description

* fix links

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* config example

* doesn't support anchors?

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* update functionality

* Update website/content/docs/agent-and-proxy/agent/process-supervisor.mdx

Co-authored-by: Daniel Huckins <dhuckins@users.noreply.github.com>

* Update website/content/docs/agent-and-proxy/agent/process-supervisor.mdx

* fix link

* move process supervisor mode in alphabetical order

* reference templating language

---------

Signed-off-by: Daniel Huckins <dhuckins@users.noreply.github.com>
Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com>
Co-authored-by: Anton Averchenkov <anton.averchenkov@hashicorp.com>
2023-06-12 20:39:25 -04:00
Kyle Schochenmaier
810bb6ccb2
[docs] VSO documentation updates for GA (#21117)
* [docs] Remove beta tag and update example code, add HCP as a supported platform.
* [docs] extend vault secrets operator secret CRD examples (#20913)
* [docs] update helm docs for vso GA (#21150)
* [docs] Add some initial telemetry documentation (#21144)
* [docs] update api reference for VSO (#21153)
---------
Co-authored-by: Thy Ton <maithytonn@gmail.com>
2023-06-12 15:59:51 -05:00
Anton Averchenkov
8194ec14fd
docs: vault agent generate-config (#21120) 2023-06-12 15:10:23 -04:00
Paul Banks
f2887a2535
Fix forwarding on token create on perf standby when an alias is created (#21100)
* Fix forwarding on token create on perf stanby when an alias is created

* Changelog entry

* Fix merge issues in docs

* Fix typo
2023-06-12 15:01:18 +01:00
Josh Black
0ff9059967
OSS changes for fixing bug in update-primary (#21119) 2023-06-09 14:35:41 -07:00
Jason O'Donnell
787897fa3a
Fix link in known issue (#21093) 2023-06-08 21:40:23 +00:00
Jason O'Donnell
698c39f988
secret/pki: add known issue for slow startup times (#21083)
* secret/pki: add known issue for slow startup times

* fix versions

* Fix typo in link

* Clarify impact
2023-06-08 15:38:21 -04:00
Conor McCullough
bbcd3f1c1b
S3 Auto-Snapshot IAM Roles EKS Incompatibility Footnote (#21039)
* S3 Auto-Snapshot IAM Roles EKS Incompatibility Footnote

This is a common source of confusion for customers when setting up S3 auto snapshots on EKS.

Currently internal feature request 0/1182317814772514/1200126608980599 is open for this.

By adding this footnote, we will save our customer's time spent attempting to configure an unsupported feature.

* Minor updates

---------

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2023-06-08 07:48:34 -07:00