Skip to content

Commit 1f6c304

Browse files
committed
Better release notes
1 parent 91a0372 commit 1f6c304

File tree

6 files changed

+121
-6
lines changed

6 files changed

+121
-6
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ description: |-
2828
| 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) | |
2929
| 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) |
3030
| 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/enterprise/license/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.18.x#activity-log-changes) |
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) |
3333

3434

3535
## Vault companion updates

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ description: |-
2727
| 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) |
2828
| 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) |
2929
| 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/enterprise/license/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.18.x#activity-log-changes) |
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) |
3232

3333
## Vault companion updates
3434

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ description: |-
1818
| New default (1.18.0) | [Default activity log querying period](/vault/docs/upgrading/upgrade-to-1.18.x#default-activity-log-querying-period) |
1919
| 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) |
2020
| 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/enterprise/license/product-usage-reporting) |
21+
| New default (1.18.2) | [Vault product usage metrics reporting](/vault/docs/upgrading/upgrade-to-1.18.x#product-usage-reporting) |
2222

2323
## Vault companion updates
2424

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'

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

+53
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,50 @@ Users may not be able to log into Vault if the JWT role is configured
8181
incorrectly. For additional details, refer to the
8282
[JWT auth method (API)](/vault/api-docs/auth/jwt) documentation.
8383

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

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

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

176+
### Product usage reporting
177+
178+
As of 1.17.9, Vault will collect anonymous product usage metrics for HashiCorp. This information will be collected
179+
alongside activity information, and will be sent automatically if automated reporting is configured, or added to manual
180+
reports if manual reporting is preferred.
181+
182+
See the main page for [Vault product usage metrics reporting](/vault/docs/enterprise/license/product-usage-reporting) for
183+
more details, and information about opt-out.
184+
132185
## Known issues and workarounds
133186

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

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

+10-1
Original file line numberDiff line numberDiff line change
@@ -128,4 +128,13 @@ WARNING: Request Limiter configuration is no longer supported; overriding server
128128

129129
```text
130130
... [WARN] unknown or unsupported field request_limiter found in configuration at config.hcl:22:1
131-
```
131+
```
132+
133+
### Product usage reporting
134+
135+
As of 1.18.2, Vault will collect anonymous product usage metrics for HashiCorp. This information will be collected
136+
alongside activity information, and will be sent automatically if automated reporting is configured, or added to manual
137+
reports if manual reporting is preferred.
138+
139+
See the main page for [Vault product usage metrics reporting](/vault/docs/enterprise/license/product-usage-reporting) for
140+
more details, and information about opt-out.

0 commit comments

Comments
 (0)