Skip to content

Commit 9f15f22

Browse files
schavisyhyakuna
andauthored
[DOCS] Add missing update info to v1.16 docs (#30881)
* backport missing info * add missing partial * Update website/content/docs/upgrading/upgrade-to-1.16.x.mdx Co-authored-by: Yoko Hyakuna <[email protected]> --------- Co-authored-by: Yoko Hyakuna <[email protected]>
1 parent 9f3b09e commit 9f15f22

File tree

6 files changed

+139
-9
lines changed

6 files changed

+139
-9
lines changed

website/content/docs/upgrading/upgrade-to-1.16.x.mdx

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,26 @@ Vault 1.15. **Please read carefully**.
1414

1515
## Important changes
1616

17-
### Azure auth plugin requires `resource_group_name`, `vm_name`, and `vmss_name` to match the JWT claims on login
17+
### Strict validation for Azure auth login requests ((#strict-azure))
1818

19-
Vault versions before 1.19.1, 1.18.7, 1.17.14, and 1.16.18, do not strictly
20-
validate the `resource_group_name`, `vm_name`, and `vmss_name` parameters
21-
against their token claims during login with Azure authentication.
19+
| Change | Affected version
20+
| ------------ | ----------------
21+
| New behavior | 1.16.18+
2222

23-
Refer to the [Token validation](/vault/docs/auth/azure#token-validation) section
23+
Azure auth plugin requires `resource_group_name`, `vm_name`, and `vmss_name` to
24+
match the JWT claims on login
25+
26+
Vault versions before 11.16.18 did not strictly validate the
27+
`resource_group_name`, `vm_name`, and `vmss_name` parameters against their token
28+
claims for clients logging in with Azure authentication.
29+
30+
#### Recommendation
31+
32+
Review the [Token validation](/vault/docs/auth/azure#token-validation) section
2433
of the Azure authN plugin guide for more information on the new validation
2534
requirements.
2635

36+
2737
### External plugin variables take precedence over system variables ((#external-plugin-variables))
2838

2939
Vault gives precedence to plugin environment variables over system environment
@@ -71,6 +81,12 @@ If you register an external plugin called `myplugin` with `SOURCE=child`, the
7181
plugin process starts with `SOURCE=parent` and Vault reports a conflict for
7282
`myplugin`.
7383

84+
### LDAP auth login changes
85+
86+
Users cannot log in using LDAP unless the LDAP plugin is configured
87+
with an `userdn` value scoped to an organization unit (OU) where the
88+
user resides.
89+
7490
### LDAP auth entity alias names no longer include upndomain
7591

7692
The `userattr` field on the LDAP auth config is now used as the entity alias.
@@ -100,6 +116,10 @@ decides to trigger the flag. More information can be found in the
100116

101117
### Activity Log Changes
102118

119+
#### Disable client counting activity
120+
121+
License utilization cannot be reported if client counting is disabled. As of Vault Enterprise 1.16.0 and later, client counting cannot be disabled using `/sys/internal/counters/config` endpoint as manual license utilization reporting is always enabled.
122+
103123
#### Default Activity Log Querying Period
104124

105125
As of 1.16.13 and later, the field `default_report_months` can no longer be configured or read. Any previously set values
@@ -150,7 +170,6 @@ As of 1.16.7 and later, the billing start date (license start date if not config
150170

151171
@include 'auto-roll-billing-start-example.mdx'
152172

153-
=======
154173
### Docker image no longer contains `curl`
155174

156175
As of 1.16.7 and later, the `curl` binary is no longer included in the published Docker container
@@ -194,14 +213,15 @@ kubectl exec -ti <NAME> -- wget https://github.com/moparisthebest/static-curl/re
194213
### Product usage reporting
195214

196215
As of 1.16.13, Vault will collect anonymous product usage metrics for HashiCorp. This information will be collected
197-
alongside client activity data, and will be sent automatically if automated reporting is configured, or added to manual
216+
alongside activity information, and will be sent automatically if automated reporting is configured, or added to manual
198217
reports if manual reporting is preferred.
199218

200219
See the main page for [Vault product usage metrics reporting](/vault/docs/enterprise/license/product-usage-reporting) for
201220
more details, and information about opt-out.
202221

203222
## Known issues and workarounds
204223

224+
205225
@include 'known-issues/1_16-jwt_auth_bound_audiences.mdx'
206226

207227
@include 'known-issues/1_16-jwt_auth_config.mdx'
@@ -212,6 +232,8 @@ more details, and information about opt-out.
212232

213233
@include 'known-issues/1_16-default-policy-needs-to-be-updated.mdx'
214234

235+
@include 'known-issues/duplicate-hsm-key.mdx'
236+
215237
@include 'known-issues/1_16-default-lcq-pre-1_9-upgrade.mdx'
216238

217239
@include 'known-issues/ocsp-redirect.mdx'
@@ -220,6 +242,10 @@ more details, and information about opt-out.
220242

221243
@include 'known-issues/perf-standbys-revert-to-standby.mdx'
222244

245+
@include 'known-issues/1_13-reload-census-panic-standby.mdx'
246+
247+
@include 'known-issues/autopilot-upgrade-upgrade-version.mdx'
248+
223249
@include 'known-issues/1_16_secrets-sync-chroot-activation.mdx'
224250

225251
@include 'known-issues/config_listener_proxy_protocol_behavior_issue.mdx'
@@ -230,8 +256,6 @@ more details, and information about opt-out.
230256

231257
@include 'known-issues/manual-entity-merge-does-not-persist.mdx'
232258

233-
@include 'known-issues/duplicate-hsm-key.mdx'
234-
235259
@include 'known-issues/database-skip-static-role-rotation.mdx'
236260

237261
@include 'known-issues/azure-unseal-regression.mdx'
@@ -243,3 +267,7 @@ more details, and information about opt-out.
243267
@include 'known-issues/log_file_flush_issue.mdx'
244268

245269
@include 'known-issues/azure-auth-fails-uniform-vmss.mdx'
270+
271+
@include 'known-issues/sync-activation-flags-cache-not-updated.mdx'
272+
273+
@include 'known-issues/enterprise-plugins.mdx'
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
### Sending SIGHUP to vault standby node causes panic
2+
3+
#### Affected versions
4+
5+
- 1.13.4+
6+
- 1.14.0+
7+
- 1.15.0+
8+
- 1.16.0+
9+
10+
#### Issue
11+
12+
Sending a SIGHUP to a vault standby node running an enterprise build can cause a panic
13+
if there is a change to the license, or reporting configuration.
14+
Active and performance standby nodes will perform fine. It is recommended that operators
15+
stop and restart vault nodes individually if configuration changes are required.
16+
17+
18+
#### Workaround
19+
20+
Instead of issuing a SIGHUP, users should stop individual vault nodes, update the configuration
21+
or license and then restart the node.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### Client tokens and token accessors audited in plaintext
2+
3+
#### Affected versions
4+
5+
- 1.16.7, 1.16.8, 1.17.3, 1.17.4
6+
7+
#### Issue
8+
9+
In versions 1.16.7, 1.16.8, 1.17.3, and 1.17.4 audit logs may contain non-hmac’d values for
10+
client_token and accessor data in the response portion.
11+
A fix has been created and is released in 1.16.9 and 1.17.5.
12+
13+
#### Workaround
14+
It is recommended to avoid affected versions when upgrading.
15+
If you are on these versions and using the audit logging feature please upgrade promptly to 1.16.9 or 1.17.5.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
### New nodes added by autopilot upgrades provisioned with the wrong version
2+
3+
#### Affected versions
4+
5+
- 1.15.3 - 1.15.9
6+
- 1.16.1 - 1.16.3
7+
8+
#### Issue
9+
10+
If `autopilot_upgrade_version` is not explicitly set in the Vault configuration file in the `storage`
11+
section, new non-active nodes will retain their original Vault version as opposed to the new version.
12+
13+
#### Workaround
14+
15+
Set the desired version in the configuration file as `autopilot_upgrade_version=<version string>`. This will
16+
allow all nodes to receive the proper version to upgrade to.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
### External Enterprise plugins cannot run on a standby node when it becomes active ((#external-ent-plugins))
2+
3+
| Change | Affected version | Affected deployments
4+
| ------------ | -------------------------------- | --------------------
5+
| Bug | 1.16.17-1.16.20, 1.17.13-1.17.16, 1.18.6-1.18.9, 1.19.0-1.19.3 | any
6+
7+
External Enterprise plugins can't run on a standby node when it becomes active
8+
because standby nodes don't extract the artifact when the plugin
9+
is registered.
10+
11+
#### Recommendation
12+
13+
As a workaround, add the plugin `.zip` artifact on every node and register the plugin on the
14+
active node. Then, extract the contents of the zip file on the follower nodes
15+
similar to the following folder structure for
16+
`vault-plugin-secrets-keymgmt_0.16.0+ent_darwin_arm64.zip`.
17+
18+
```text
19+
<plugin-directory>/vault-plugin-secrets-keymgmt_0.16.0+ent_darwin_arm64
20+
├── metadata.json
21+
├── metadata.json.sig
22+
└── vault-plugin-secrets-keymgmt
23+
```
24+
25+
Alternatively, upgrade to one of the following Vault versions: 1.16.21+, 1.17.17+,
26+
1.18.10+, 1.19.4+. See [Register external plugins](/vault/docs/plugins/register)
27+
for more details.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
### Cached activation flags for secrets sync on follower nodes are not updated
2+
3+
#### Affected versions
4+
5+
- 1.16.0 - 1.16.2
6+
- 1.17.0 - 1.17.5
7+
8+
#### Issue
9+
10+
Vault 1.16 introduced secrets sync with a one-time flag required to activate the
11+
feature before use. Writing the activation flag to enable secrets sync is forwarded
12+
to leader nodes for storage and distributed to follower nodes, but the in-memory
13+
cache for this flag is not updated on the followers.
14+
15+
This prevents any secrets sync endpoints (those starting with `sys/sync/`) from
16+
being usable on follower nodes in a cluster.
17+
18+
#### Workaround
19+
20+
The cache is force-updated on all nodes when the leader node steps down and the
21+
cluster promotes a new leader. First, activate the secrets sync feature as described
22+
in the [documentation](/vault/docs/sync#activating-the-feature). Then, have the leader node
23+
step down.

0 commit comments

Comments
 (0)