Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Backport of Auto-rolling billing start docs PR into release/1.16.x #27998

Merged
merged 2 commits into from
Aug 7, 2024
Merged

Backport of Auto-rolling billing start docs PR into release/1.16.x #27998

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5f0758
Auto-rolling billing start docs PR (#27926)
akshya96 Aug 6, 2024
b753bc7
fix internal counters
akshya96 Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions website/content/api-docs/system/internal-counters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,8 @@ not have namespace attribution for the `new_clients` stanza. Furthermore, the
`new_clients` counts returned for the current month will be an approximation.
That is to say, the response will appear as follows.

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

```json
{
"months":[
Expand Down Expand Up @@ -342,8 +344,8 @@ This endpoint was added in Vault 1.6.
### Parameters

- `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 `default_report_months`
prior to the `end_time` will be used.
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.
- `end_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time. Specifies the end of the period
for which client counts will be reported. If no end time is specified, the end of the previous calendar
month will be used.
Expand Down Expand Up @@ -1072,6 +1074,18 @@ $ curl \
}
```

<Note title="Important change to supported versions">
As of 1.16.7, 1.17.3 and later,
the <a href="/vault/docs/concepts/billing-start-date">billing start date</a> automatically
rolls over to the latest billing year at the end of the last cycle.

For more information, refer to the upgrade guide for your Vault version:

[Vault v1.16.x](/vault/docs/upgrading/upgrade-to-1.16.x#auto-rolled-billing-start-date),
[Vault v1.17.x](/vault/docs/upgrading/upgrade-to-1.17.x#auto-rolled-billing-start-date)

</Note>

## Activity export

This endpoint returns an export of the clients that had activity within the
Expand Down
21 changes: 21 additions & 0 deletions website/content/docs/concepts/billing-start-date.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
layout: docs
page_title: Billing start date
description: >-
A description of Vault cluster's billing start date used throughout Vault.
---

# Billing start date

It is the start of the period for which [automated](/vault/docs/enterprise/license/utilization-reporting) and [manual](/vault/docs/enterprise/license/manual-reporting) license utilization data will be reported for a cluster. This is the license start date if you do not have an explicit
billing start date configured.

Vault also uses the billing start date as a default start timestamp for:
- [Direct queries via the activity log API](/vault/api-docs/system/internal-counters)
- [Activity export CLI](/vault/api-docs/system/internal-counters#activity-export)

As of 1.16.7, 1.17.3 and later, Vault clusters will automatically adjust the billing start date to provide a year's worth of utilization data.

@include 'auto-roll-billing-start.mdx'

@include 'auto-roll-billing-start-example.mdx'
16 changes: 15 additions & 1 deletion website/content/docs/enterprise/license/utilization-reporting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,21 @@ HashiCorp collects the following utilization data as JSON payloads:
- `entity` - The sum of tokens generated for a unique client identifier
- `nonentity` - The sum of tokens without an entity attached
- `metadata` - Optional product-specific metadata
- `billing_start` - The billing start date associated with the reporting cluster (license start date if not configured)
- `billing_start` - The billing start date associated with the reporting cluster (license start date if not configured).

<Note title="Important change to supported versions">

As of 1.16.7, 1.17.3 and later,
the <a href="/vault/docs/concepts/billing-start-date">billing start date</a> automatically
rolls over to the latest billing year at the end of the last cycle.

For more information, refer to the upgrade guide for your Vault version:

[Vault v1.16.x](/vault/docs/upgrading/upgrade-to-1.16.x#auto-rolled-billing-start-date),
[Vault v1.17.x](/vault/docs/upgrading/upgrade-to-1.17.x#auto-rolled-billing-start-date)

</Note>

- `cluster_id` - The cluster UUID as shown by `vault status` on the reporting
cluster

Expand Down
8 changes: 8 additions & 0 deletions website/content/docs/upgrading/upgrade-to-1.16.x.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,14 @@ operation called an activation-flag. The feature is gated until a Vault operator
decides to trigger the flag. More information can be found in the
[secrets sync documentation](/vault/docs/sync#activating-the-feature).

### Auto-rolled billing start date

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.

@include 'auto-roll-billing-start.mdx'

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

## Known issues and workarounds

@include 'known-issues/1_16-jwt_auth_bound_audiences.mdx'
Expand Down
8 changes: 8 additions & 0 deletions website/content/partials/auto-roll-billing-start-example.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

The default billing start date used in queries and license utilization reporting will be automatically adjusted to the latest billing year. Past year billing information will still be retained.

For example, assume a customer has signed a deal for 3 years with a license start date of Dec 1, 2023. After upgrading to the version with this change, the billing start date
auto-rolls to the most recent year.
- If the upgrade happens on Sept 1, 2024, the billing start date will continue to be Dec 1, 2023. Once we reach Dec 1, 2024, the billing start date
will automatically roll to Dec 1, 2024.
- If the upgrade happens on Dec 15, 2024, the billing start date should automatically roll to Dec 1, 2024 after upgrade.
3 changes: 3 additions & 0 deletions website/content/partials/auto-roll-billing-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@

This means that the billing start dates from earlier years will get updated to current calendar year, unless the date has not yet occured this year, in which case
it will remain in the last calendar year. The billing start date will adjust accordingly for leap years.
4 changes: 4 additions & 0 deletions website/data/docs-nav-data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,10 @@
"title": "Resource Quotas",
"path": "concepts/resource-quotas"
},
{
"title": "Billing Start Date",
"path": "concepts/billing-start-date"
},
{
"title": "Client count",
"routes": [
Expand Down
Loading