Skip to content

offline license utilization reporting#25844

Merged
tgross merged 2 commits intomainfrom
NMD68-manual-census-ce
May 14, 2025
Merged

offline license utilization reporting#25844
tgross merged 2 commits intomainfrom
NMD68-manual-census-ce

Conversation

@tgross
Copy link
Copy Markdown
Member

@tgross tgross commented May 13, 2025

Nomad Enterprise users operating in air-gapped or otherwise secured environments don't want to send license reporting metrics directly from their servers. Implement manual/offline reporting by periodically recording usage metrics snapshots in the state store, and providing an API and CLI by which cluster administrators can download the snapshot for review and out-of-band transmission to HashiCorp.

This is the CE portion of the work required for implemention in the Enterprise product (see https://github.com/hashicorp/nomad-enterprise/pull/2673). Nomad CE does not perform utilization reporting (ref).

Ref: https://github.com/hashicorp/nomad-enterprise/pull/2673
Ref: https://hashicorp.atlassian.net/browse/NMD-68
Ref: https://go.hashi.co/rfc/nmd-210

Contributor Checklist

  • Changelog Entry If this PR changes user-facing behavior, please generate and add a
    changelog entry using the make cl command.
  • Testing Please add tests to cover any new functionality or to demonstrate bug fixes and
    ensure regressions will be caught.
  • Documentation If the change impacts user-facing functionality such as the CLI, API, UI,
    and job configuration, please update the Nomad website documentation to reflect this. Refer to
    the website README for docs guidelines. Please also consider whether the
    change requires notes within the upgrade guide.

Reviewer Checklist

  • Backport Labels Please add the correct backport labels as described by the internal
    backporting document.
  • Commit Type Ensure the correct merge method is selected which should be "squash and merge"
    in the majority of situations. The main exceptions are long-lived feature branches or merges where
    history should be preserved.
  • Enterprise PRs If this is an enterprise only PR, please add any required changelog entry
    within the public repository.

Nomad Enterprise users operating in air-gapped or otherwise secured environments
don't want to send license reporting metrics directly from their
servers. Implement manual/offline reporting by periodically recording usage
metrics snapshots in the state store, and providing an API and CLI by which
cluster administrators can download the snapshot for review and out-of-band
transmission to HashiCorp.

This is the CE portion of the work required for implemention in the Enterprise
product. Nomad CE does not perform utilization reporting.

Ref: hashicorp/nomad-enterprise#2673
Ref: https://hashicorp.atlassian.net/browse/NMD-68
Ref: https://go.hashi.co/rfc/nmd-210
@tgross tgross force-pushed the NMD68-manual-census-ce branch from dcaed42 to cb2d431 Compare May 13, 2025 15:07
@tgross tgross added backport/1.10.x theme/enterprise Issues related to Enterprise features type/enhancement labels May 13, 2025
@tgross tgross added this to the 1.10.x milestone May 13, 2025
@tgross tgross marked this pull request as ready for review May 13, 2025 15:26
@tgross tgross requested review from a team as code owners May 13, 2025 15:26
@tgross tgross requested review from jrasell and pkazmierczak May 13, 2025 15:26
@aimeeu aimeeu added the theme/docs Documentation issues and enhancements label May 13, 2025
Copy link
Copy Markdown
Contributor

@aimeeu aimeeu left a comment

Choose a reason for hiding this comment

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

Some suggestions to conform to style guidelines

Comment thread website/content/docs/configuration/reporting.mdx Outdated
Comment thread website/content/api-docs/operator/utilization.mdx Outdated
Comment thread website/content/api-docs/operator/utilization.mdx Outdated
Comment thread website/content/api-docs/operator/utilization.mdx Outdated
Comment thread website/content/docs/commands/operator/utilization.mdx Outdated
Comment thread website/content/docs/commands/operator/utilization.mdx Outdated
Co-authored-by: Aimee Ukasick <aimee.ukasick@hashicorp.com>
Copy link
Copy Markdown
Member

@jrasell jrasell left a comment

Choose a reason for hiding this comment

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

LGTM

@tgross tgross merged commit 8a5a057 into main May 14, 2025
39 checks passed
@tgross tgross deleted the NMD68-manual-census-ce branch May 14, 2025 13:51
@tgross tgross added backport/ent/1.8.x+ent Changes are backported to 1.8.x+ent backport/ent/1.9.x+ent labels May 19, 2025
@github-actions
Copy link
Copy Markdown

I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Sep 17, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

backport/ent/1.8.x+ent Changes are backported to 1.8.x+ent theme/docs Documentation issues and enhancements theme/enterprise Issues related to Enterprise features type/enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants