Skip to content

Conversation

schavis
Copy link
Contributor

@schavis schavis commented Oct 3, 2025

Sync GA changes to RC docs

@schavis schavis requested a review from a team as a code owner October 3, 2025 23:07
@github-actions github-actions bot added Vault Content update for Vault product docs Vault IC Higher priority Vault content PR. Update relates to an important changes announcement. labels Oct 3, 2025
Copy link
Contributor

github-actions bot commented Oct 3, 2025

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal 🔄 Building (Inspect) --- ---
Unified Docs API ✅ Ready (Inspect) Visit Preview Tue Oct 7 18:55:04 UTC 2025

Copy link
Contributor

@Dan-Heath Dan-Heath left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this looks good! I noted a few places where the content differed from the v1.20.x branch. Most were additions or small revisions that were probably new content. Please let me know if you have any questions or if there's anything I can do to help.

- `root_password_ttl` `(string: 182d)` - Specifies how long the root password is valid for in Azure when
rotate-root generates a new client secret. Uses [duration format strings](/vault/docs/concepts/duration-format).

- `metadata` (`map[string]string: {}`) - A map of string to string key/value pairs that will be stored
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This metadata field looks like a new addition. It's not in v1.20.x, but the rest of these updates are.

### Headers

- `X-Vault-Recover-Snapshot-Id` `(string: <required>)` - The ID of a snapshot previously loaded into Vault that contains SSH CA information.
- `X-Vault-Recover-Snapshot-Id` `(string: <required>)` - The ID of a snapshot
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The X-Vault-Recover-Snapshot-Id header looks like new content. I don't see it on the v1.20.x branch, but the other change above is.

- `key_version` `(int: 0)` – Specifies the version of the key to use for
encryption. If not set, uses the latest version. Must be greater than or
equal to the key's `min_encryption_version`, if set.
encryption. Leave `key_version` unset to use the latest version. `key_version`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The version on the v1.20.x branch has slightly different phrasing "Specifies the version of the key to use for the operation.." The rest of the changes in this file are there.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, the previous edit had a copy/paste error that I fixed in the 1.21 docs as part of the sync

- `start_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time. Specifies the start of the
period for which client counts will be reported. If no start time is specified, the billing start date will be used.
The [billing start date](/vault/docs/concepts/billing-start-date) automatically rolls over to the latest billing year at the end of the last cycle.
- `start_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This revision might be a new change, on v1.20.x it is still the old text.


- `start_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time. Specifies the start of the
period for which client counts will be reported. If no start time is specified, the billing start time will be used.
- `start_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This revision might be a new change, on v1.20.x it is still the old text.

The root bindpass can be rotated to a Vault-generated value that is not accessible by the operator.
This will ensure that only Vault is able to access the "root" user that Vault uses to manipulate credentials.

Manual root rotations will be logged to the vault.log and state that the rotation was `on user request`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see this line on v1.20.x, it might be new content.

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `name` _string_ | Name of the VaultAuthGlobal resource. | | Pattern: `^([a-z0-9.-]{1,253})$` <br /> |
| `namespace` _string_ | Namespace of the VaultAuthGlobal resource. If not provided, the namespace of<br />the referring VaultAuth resource is used. | | Pattern: `^([a-z0-9.-]{1,253})$` <br /> |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like it could be a new change. The v1.20x branch still has the old pattern.

| `vault.secret.engine.activedirectory.count` | The total number of Active Directory secret engines in Vault. |
| `vault.secret.engine.alicloud.count` | The total number of Alicloud secret engines in Vault. |
| `vault.secret.engine.aws.count` | The total number of AWS secret engines in Vault. |
| `vault.secret.engine.aws.dynamic.role.count` | The total number of AWS dynamic roles in Vault. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These all look like new changes on this file, I don't see them on the v1.20.x branch.

Comment on lines +6 to +7
| databases | `/static-roles/:role_name` | `recover`, `read`, `list` | 1.20.4
| databases | `/static-creds/:role_name` | `read` | 1.20.4
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like these last 2 lines might be new content, I don't see them on the v1.20.x branch.

Comment on lines +1 to +7
<Tip>

If you cannot use the explicit `RECOVER` HTTP method, you can also use `PUT` or
`POST` for recover operations if you include the `X-Vault-Recover-Snapshot-Id`
header and set it to the relevant snapshot ID.

</Tip>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This tip looks like new content, I don't see it on the v1.20.x branch.

@schavis schavis merged commit ab8adb7 into vault/1.21.x Oct 7, 2025
14 of 15 checks passed
@schavis schavis deleted the bot/vault-ga-to-rc-sync-20251002 branch October 7, 2025 19:44
schavis added a commit that referenced this pull request Oct 9, 2025
* Create 1.21 docset
* Rename 1.21 folder to mark it as an rc docset
* Add documentation for new secret list parameter
* Add role count product usage metrics
* Add docs for client first used time
* Add api-docs field description and docs feature explanation
* Change description for token creation time
* Add docs for AES-CBC
* Add api docs for derivedkeys
* Add field documentation and info
* Fix LDAP docs referencing Azure by mistake
* Add reference
* Add more info about setting up CMEK for GCP sync
* Add section to api docs on batch-fetch certificates.
* VAULT-37634, VAULT-36946: Census metrics for recover capability and auto snapshot config counts (#864)
* VAULT-37633: Database static role recover (#884)
* VAULT-38654: Docs for autoloading snapshots (#890)
* Update gcpsm.mdx
* Add docs & api-docs for Azure Secrets Static Roles
* VAULT-37037 docs for Vault proxy update (#923)
* Add docs for KV v2 Version Attribution
* [VAULT-39627] Add GUI steps for Secret Engine mount tune.
* Prep update docs for 1.21
* Add missing version table
* Add SPIFFE auth plugin docs
* add docs to Setup login MFA
* cumulative api docs
* add missing partial
* Correct partial paths for summary tables
* Add metrics docs changes
* add documentation for oracle
* add TOTP support to login MFA types
* create a partial alert for tech preview, add another sample request and response
* Add missing important change info and remove empty release notes
* [VAULT] GA to RC sync 20251002 (#1052)
* Fix endpoint_url description within https_spiffe_bundle section in API docs
* Clarify only one enforcement can be configured for web UI self-enroll
* Update metadata docs
* Final pre-publication sync (#1076)
* Fix important changes pages

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Co-authored-by: Eleonore Carpentier <shaeli@github.com>
Co-authored-by: Ellie Sterner <ellie.sterner@hashicorp.com>
Co-authored-by: akshya96 <araghavan@hashicorp.com>
Co-authored-by: robmonte <17119716+robmonte@users.noreply.github.com>
Co-authored-by: akshya96 <87045294+akshya96@users.noreply.github.com>
Co-authored-by: rculpepper <rculpepper@hashicorp.com>
Co-authored-by: Kit Haines <khaines@mit.edu>
Co-authored-by: Rachel Culpepper <84159930+rculpepper@users.noreply.github.com>
Co-authored-by: miagilepner <miagilepner@gmail.com>
Co-authored-by: Milena Zlaticanin <Milena.Zlaticanin@ibm.com>
Co-authored-by: Zlaticanin <60530402+Zlaticanin@users.noreply.github.com>
Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>
Co-authored-by: Yoko Hyakuna <yoko.hyakuna1@ibm.com>
Co-authored-by: Mike Palmiotto <mike.palmiotto@hashicorp.com>
Co-authored-by: Jaired Jawed <jaired.jawed@hashicorp.com>
Co-authored-by: Jaired Jawed <me@jairedjawed.com>
Co-authored-by: Vinay Gopalan <vinay@hashicorp.com>
Co-authored-by: vinay-gopalan <86625824+vinay-gopalan@users.noreply.github.com>
Co-authored-by: Shannon Roberts <shannon.roberts@hashicorp.com>
Co-authored-by: Steven Clark <steven.clark@hashicorp.com>
Co-authored-by: Shannon Roberts (Beagin) <beagins@users.noreply.github.com>
Co-authored-by: claire bontempo <cbontempo@hashicorp.com>
Co-authored-by: Jenny Deng <jenny.deng@hashicorp.com>
Co-authored-by: Kuba Wieczorek <kuba.wieczorek@hashicorp.com>
Co-authored-by: Guilherme Santos <157053549+gsantos-hc@users.noreply.github.com>
Co-authored-by: claire bontempo <68122737+hellobontempo@users.noreply.github.com>
Co-authored-by: divyaac <divya.chandrasekaran@hashicorp.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Vault IC Higher priority Vault content PR. Update relates to an important changes announcement. Vault Content update for Vault product docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants