Skip to content

Commit e309098

Browse files
VioletHynesVioletHynes
authored
VAULT-32201 release notes for product usage reporting (#28904)
* VAULT-32201 release notes for product usage reporting * Add note about default report months * Better release notes
1 parent bb5ce48 commit e309098

File tree

6 files changed

+159
-38
lines changed

6 files changed

+159
-38
lines changed

‎website/content/docs/release-notes/1.16.1.mdx

+18-15
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,24 @@ description: |-
1313

1414
## Important changes
1515

16-
| Version | Change |
17-
|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
18-
| 1.16.0+ | [Existing clusters do not show the current Vault version in UI by default](/vault/docs/upgrading/upgrade-to-1.16.x#default-policy-changes) |
19-
| 1.16.0+ | [Default LCQ enabled when upgrading pre-1.9](/vault/docs/upgrading/upgrade-to-1.16.x#default-lcq-pre-1.9-upgrade) |
20-
| 1.16.0+ | [External plugin environment variables take precedence over server variables](/vault/docs/upgrading/upgrade-to-1.16.x#external-plugin-variables) |
21-
| 1.16.0+ | [LDAP auth entity alias names no longer include upndomain](/vault/docs/upgrading/upgrade-to-1.16.x#ldap-auth-entity-alias-names-no-longer-include-upndomain) |
22-
| 1.16.0+ | [Secrets Sync now requires a one-time flag to operate](/vault/docs/upgrading/upgrade-to-1.16.x#secrets-sync-now-requires-setting-a-one-time-flag-before-use) |
23-
| 1.16.0+ | [Azure secrets engine role creation failing](/vault/docs/upgrading/upgrade-to-1.16.x#azure-secrets-engine-role-creation-failing) |
24-
| 1.16.1 - 1.16.3 | [New nodes added by autopilot upgrades provisioned with the wrong version](/vault/docs/upgrading/upgrade-to-1.15.x#new-nodes-added-by-autopilot-upgrades-provisioned-with-the-wrong-version) |
25-
| 1.15.8+ | [Autopilot upgrade for Vault Enterprise fails](/vault/docs/upgrading/upgrade-to-1.15.x#autopilot) |
26-
| 1.16.5 | [Listener stops listening on untrusted upstream connection with particular config settings](/vault/docs/upgrading/upgrade-to-1.16.x#listener-proxy-protocol-config) |
27-
| 1.16.3 - 1.16.6 | [Vault standby nodes not deleting removed entity-aliases from in-memory database](/vault/docs/upgrading/upgrade-to-1.16.x#dangling-entity-alias-in-memory) |
28-
| 0.7.0+ | [Duplicate identity groups created](/vault/docs/upgrading/upgrade-to-1.16.x#duplicate-identity-groups-created-when-concurrent-requests-sent-to-the-primary-and-pr-secondary-cluster) | |
29-
| Known Issue (0.7.0+) | [Manual entity merges fail](/vault/docs/upgrading/upgrade-to-1.16.x#manual-entity-merges-sent-to-a-pr-secondary-cluster-are-not-persisted-to-storage)
30-
| Known Issue (1.16.7-1.16.8) | [Some values in the audit logs not hmac'd properly](/vault/docs/upgrading/upgrade-to-1.16.x#client-tokens-and-token-accessors-audited-in-plaintext) |
16+
| Version | Change |
17+
|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
18+
| 1.16.0+ | [Existing clusters do not show the current Vault version in UI by default](/vault/docs/upgrading/upgrade-to-1.16.x#default-policy-changes) |
19+
| 1.16.0+ | [Default LCQ enabled when upgrading pre-1.9](/vault/docs/upgrading/upgrade-to-1.16.x#default-lcq-pre-1.9-upgrade) |
20+
| 1.16.0+ | [External plugin environment variables take precedence over server variables](/vault/docs/upgrading/upgrade-to-1.16.x#external-plugin-variables) |
21+
| 1.16.0+ | [LDAP auth entity alias names no longer include upndomain](/vault/docs/upgrading/upgrade-to-1.16.x#ldap-auth-entity-alias-names-no-longer-include-upndomain) |
22+
| 1.16.0+ | [Secrets Sync now requires a one-time flag to operate](/vault/docs/upgrading/upgrade-to-1.16.x#secrets-sync-now-requires-setting-a-one-time-flag-before-use) |
23+
| 1.16.0+ | [Azure secrets engine role creation failing](/vault/docs/upgrading/upgrade-to-1.16.x#azure-secrets-engine-role-creation-failing) |
24+
| 1.16.1 - 1.16.3 | [New nodes added by autopilot upgrades provisioned with the wrong version](/vault/docs/upgrading/upgrade-to-1.15.x#new-nodes-added-by-autopilot-upgrades-provisioned-with-the-wrong-version) |
25+
| 1.15.8+ | [Autopilot upgrade for Vault Enterprise fails](/vault/docs/upgrading/upgrade-to-1.15.x#autopilot) |
26+
| 1.16.5 | [Listener stops listening on untrusted upstream connection with particular config settings](/vault/docs/upgrading/upgrade-to-1.16.x#listener-proxy-protocol-config) |
27+
| 1.16.3 - 1.16.6 | [Vault standby nodes not deleting removed entity-aliases from in-memory database](/vault/docs/upgrading/upgrade-to-1.16.x#dangling-entity-alias-in-memory) |
28+
| 0.7.0+ | [Duplicate identity groups created](/vault/docs/upgrading/upgrade-to-1.16.x#duplicate-identity-groups-created-when-concurrent-requests-sent-to-the-primary-and-pr-secondary-cluster) | |
29+
| Known Issue (0.7.0+) | [Manual entity merges fail](/vault/docs/upgrading/upgrade-to-1.16.x#manual-entity-merges-sent-to-a-pr-secondary-cluster-are-not-persisted-to-storage) |
30+
| Known Issue (1.16.7-1.16.8) | [Some values in the audit logs not hmac'd properly](/vault/docs/upgrading/upgrade-to-1.16.x#client-tokens-and-token-accessors-audited-in-plaintext) |
31+
| New default (1.16.13) | [Vault product usage metrics reporting](/vault/docs/upgrading/upgrade-to-1.6.x#product-usage-reporting) |
32+
| Deprecation (1.16.13) | [`default_report_months` is deprecated for the `sys/internal/counters` API](/vault/docs/upgrading/upgrade-to-1.16.x#activity-log-changes) |
33+
3134

3235
## Vault companion updates
3336

‎website/content/docs/release-notes/1.17.0.mdx

+16-14
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,22 @@ description: |-
1313

1414
## Important changes
1515

16-
| Change | Description |
17-
|------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
18-
| New default (1.17) | [Allowed audit headers now have unremovable defaults](/vault/docs/upgrading/upgrade-to-1.17.x#audit-headers) |
19-
| Opt out feature (1.17) | [PKI sign-intermediate now truncates `notAfter` field to signing issuer](/vault/docs/upgrading/upgrade-to-1.17.x#pki-truncate) |
20-
| Beta feature deprecated (1.17) | [Request limiter deprecated](/vault/docs/upgrading/upgrade-to-1.17.x#request-limiter) |
21-
| Known issue (1.17.0+) | [PKI OCSP GET requests can return HTTP redirect responses](/vault/docs/upgrading/upgrade-to-1.17.x#pki-ocsp) |
22-
| Known issue (1.17.0) | [Vault Agent and Vault Proxy consume excessive amounts of CPU](/vault/docs/upgrading/upgrade-to-1.17.x#agent-proxy-cpu-1-17) |
23-
| Known issue (1.15.8 - 1.15.9, 1.16.0 - 1.16.3) | [Autopilot upgrade for Vault Enterprise fails](/vault/docs/upgrading/upgrade-to-1.16.x#new-nodes-added-by-autopilot-upgrades-provisioned-with-the-wrong-version) |
24-
| Known issue (1.17.0 - 1.17.2) | [Vault standby nodes not deleting removed entity-aliases from in-memory database](/vault/docs/upgrading/upgrade-to-1.17.x#dangling-entity-alias-in-memory) |
25-
| Known issue (1.17.0 - 1.17.3) | [AWS Auth AssumeRole requires an external ID even if none is set](/vault/docs/upgrading/upgrade-to-1.17.x#aws-auth-role-configuration-requires-an-external_id) |
26-
| Known Issue (0.7.0+) | [Duplicate identity groups created](/vault/docs/upgrading/upgrade-to-1.17.x#duplicate-identity-groups-created-when-concurrent-requests-sent-to-the-primary-and-pr-secondary-cluster)
27-
| Known Issue (0.7.0+) | [Manual entity merges fail](/vault/docs/upgrading/upgrade-to-1.17.x#manual-entity-merges-sent-to-a-pr-secondary-cluster-are-not-persisted-to-storage)
28-
| Known Issue (1.17.3-1.17.4) | [Some values in the audit logs not hmac'd properly](/vault/docs/upgrading/upgrade-to-1.17.x#client-tokens-and-token-accessors-audited-in-plaintext)
29-
| Known Issue (1.17.0-1.17.5) | [Cached activation flags for secrets sync on follower nodes are not updated](/vault/docs/upgrading/upgrade-to-1.17.x#cached-activation-flags-for-secrets-sync-on-follower-nodes-are-not-updated)
16+
| Change | Description |
17+
|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
18+
| New default (1.17) | [Allowed audit headers now have unremovable defaults](/vault/docs/upgrading/upgrade-to-1.17.x#audit-headers) |
19+
| Opt out feature (1.17) | [PKI sign-intermediate now truncates `notAfter` field to signing issuer](/vault/docs/upgrading/upgrade-to-1.17.x#pki-truncate) |
20+
| Beta feature deprecated (1.17) | [Request limiter deprecated](/vault/docs/upgrading/upgrade-to-1.17.x#request-limiter) |
21+
| Known issue (1.17.0+) | [PKI OCSP GET requests can return HTTP redirect responses](/vault/docs/upgrading/upgrade-to-1.17.x#pki-ocsp) |
22+
| Known issue (1.17.0) | [Vault Agent and Vault Proxy consume excessive amounts of CPU](/vault/docs/upgrading/upgrade-to-1.17.x#agent-proxy-cpu-1-17) |
23+
| Known issue (1.15.8 - 1.15.9, 1.16.0 - 1.16.3) | [Autopilot upgrade for Vault Enterprise fails](/vault/docs/upgrading/upgrade-to-1.16.x#new-nodes-added-by-autopilot-upgrades-provisioned-with-the-wrong-version) |
24+
| Known issue (1.17.0 - 1.17.2) | [Vault standby nodes not deleting removed entity-aliases from in-memory database](/vault/docs/upgrading/upgrade-to-1.17.x#dangling-entity-alias-in-memory) |
25+
| Known issue (1.17.0 - 1.17.3) | [AWS Auth AssumeRole requires an external ID even if none is set](/vault/docs/upgrading/upgrade-to-1.17.x#aws-auth-role-configuration-requires-an-external_id) |
26+
| Known Issue (0.7.0+) | [Duplicate identity groups created](/vault/docs/upgrading/upgrade-to-1.17.x#duplicate-identity-groups-created-when-concurrent-requests-sent-to-the-primary-and-pr-secondary-cluster) |
27+
| Known Issue (0.7.0+) | [Manual entity merges fail](/vault/docs/upgrading/upgrade-to-1.17.x#manual-entity-merges-sent-to-a-pr-secondary-cluster-are-not-persisted-to-storage) |
28+
| Known Issue (1.17.3-1.17.4) | [Some values in the audit logs not hmac'd properly](/vault/docs/upgrading/upgrade-to-1.17.x#client-tokens-and-token-accessors-audited-in-plaintext) |
29+
| Known Issue (1.17.0-1.17.5) | [Cached activation flags for secrets sync on follower nodes are not updated](/vault/docs/upgrading/upgrade-to-1.17.x#cached-activation-flags-for-secrets-sync-on-follower-nodes-are-not-updated) |
30+
| New default (1.17.9) | [Vault product usage metrics reporting](/vault/docs/upgrading/upgrade-to-1.17.x#product-usage-reporting) |
31+
| Deprecation (1.17.9) | [`default_report_months` is deprecated for the `sys/internal/counters` API](/vault/docs/upgrading/upgrade-to-1.17.x#activity-log-changes) |
3032

3133
## Vault companion updates
3234

‎website/content/docs/release-notes/1.18.0.mdx

+9-8
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,12 @@ description: |-
1313

1414
## Important changes
1515

16-
| Change | Description
17-
| --------------------------- | -----------
18-
| New default (1.18.0) | [Default activity log querying period](/vault/docs/upgrading/upgrade-to-1.18.x#default-activity-log-querying-period)
19-
| New default (1.18.0) | [Docker image no longer contains curl](/vault/docs/upgrading/upgrade-to-1.18.x#docker-image-no-longer-contains-curl)
20-
| Beta feature removed (1.18) | [Request limiter removed](/vault/docs/upgrading/upgrade-to-1.18.x#request-limiter-configuration-removal)
16+
| Change | Description |
17+
|-----------------------------|----------------------------------------------------------------------------------------------------------------------|
18+
| New default (1.18.0) | [Default activity log querying period](/vault/docs/upgrading/upgrade-to-1.18.x#default-activity-log-querying-period) |
19+
| New default (1.18.0) | [Docker image no longer contains curl](/vault/docs/upgrading/upgrade-to-1.18.x#docker-image-no-longer-contains-curl) |
20+
| Beta feature removed (1.18) | [Request limiter removed](/vault/docs/upgrading/upgrade-to-1.18.x#request-limiter-configuration-removal) |
21+
| New default (1.18.2) | [Vault product usage metrics reporting](/vault/docs/upgrading/upgrade-to-1.18.x#product-usage-reporting) |
2122

2223
## Vault companion updates
2324

@@ -63,15 +64,15 @@ Follow the learn more links for more information, or browse the list of
6364
</td>
6465
<td style={{verticalAlign: 'middle', textAlign: 'center'}}>ENHANCED</td>
6566
<td style={{verticalAlign: 'middle'}}>
66-
Overall stability improvements.
67+
Overall stability improvements.
6768
<br /><br />
6869
Learn more: <a href="/vault/docs/concepts/integrated-storage/autopilot">Autopilot overview</a>
6970
</td>
7071
</tr>
7172

7273
<tr>
7374
<td style={{verticalAlign: 'middle'}}>
74-
Client count
75+
Client count
7576
</td>
7677
<td style={{verticalAlign: 'middle', textAlign: 'center'}}>ENHANCED</td>
7778
<td style={{verticalAlign: 'middle'}}>
@@ -88,7 +89,7 @@ Follow the learn more links for more information, or browse the list of
8889
<td style={{verticalAlign: 'middle', textAlign: 'center'}}>GA</td>
8990
<td style={{verticalAlign: 'middle'}}>
9091
Enable PKI support for automated certificate enrollment with CMPv2
91-
protocols for 5G networks per 3G PP standards.
92+
protocols for 5G networks per 3G PP standards.
9293
<br /><br />
9394
Learn more: <a href="/vault/docs/secrets/pki/cmpv2">CMPv2 in the Vault PKI plugin</a>
9495
</td>

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

+53
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,50 @@ operation called an activation-flag. The feature is gated until a Vault operator
9494
decides to trigger the flag. More information can be found in the
9595
[secrets sync documentation](/vault/docs/sync#activating-the-feature).
9696

97+
### Activity Log Changes
98+
99+
#### Default Activity Log Querying Period
100+
101+
As of 1.16.13 and later, the field `default_report_months` can no longer be configured or read. Any previously set values
102+
will be ignored by the system.
103+
104+
105+
Attempts to modify `default_report_months` through the
106+
[/sys/internal/counters/config](/vault/api-docs/system/internal-counters#update-the-client-count-configuration)
107+
endpoint, will result in the following warning from Vault:
108+
109+
<CodeBlockConfig hideClipboard>
110+
111+
```shell-session
112+
113+
WARNING! The following warnings were returned from Vault:
114+
115+
* default_report_months is deprecated: defaulting to billing start time
116+
117+
118+
```
119+
120+
</CodeBlockConfig>
121+
122+
123+
The `current_billing_period` toggle for `/sys/internal/counters/activity` is also deprecated, as this will be set
124+
true by default.
125+
126+
Attempts to set `current_billing_period` will result in the following warning from Vault:
127+
128+
<CodeBlockConfig hideClipboard>
129+
130+
```shell-session
131+
132+
WARNING! The following warnings were returned from Vault:
133+
134+
* current_billing_period is deprecated; unless otherwise specified, all requests will default to the current billing period
135+
136+
137+
```
138+
139+
</CodeBlockConfig>
140+
97141
### Auto-rolled billing start date
98142

99143
As of 1.16.7 and later, the billing start date (license start date if not configured) automatically rolls over to the latest billing year at the end of the last cycle.
@@ -142,6 +186,15 @@ kubectl exec -ti <NAME> -- wget https://github.com/moparisthebest/static-curl/re
142186

143187
**NOTE:** When using this option you'll want to verify that the static binary comes from a trusted source.
144188

189+
### Product usage reporting
190+
191+
As of 1.16.13, Vault will collect anonymous product usage metrics for HashiCorp. This information will be collected
192+
alongside activity information, and will be sent automatically if automated reporting is configured, or added to manual
193+
reports if manual reporting is preferred.
194+
195+
See the main page for [Vault product usage metrics reporting](/vault/docs/enterprise/license/product-usage-reporting) for
196+
more details, and information about opt-out.
197+
145198
## Known issues and workarounds
146199

147200
@include 'known-issues/1_17_audit-log-hmac.mdx'

0 commit comments

Comments
 (0)