mirror of
https://github.com/kemko/nomad.git
synced 2026-01-03 08:55:43 +03:00
8a5a057d88
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: https://github.com/hashicorp/nomad-enterprise/pull/2673 Ref: https://hashicorp.atlassian.net/browse/NMD-68 Ref: https://go.hashi.co/rfc/nmd-210
51 lines
1.6 KiB
Plaintext
51 lines
1.6 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: reporting Block in Agent Configuration
|
|
description: >-
|
|
Enable automated license utilization reporting in the `reporting` block of a Nomad agent configuration. Configuration applies to agents running Nomad Enterprise with server mode enabled.
|
|
---
|
|
|
|
# `reporting` Block in Agent Configuration
|
|
|
|
<Placement groups={['reporting']} />
|
|
<EnterpriseAlert product="nomad"/>
|
|
|
|
This page provides reference information for enabling automated license
|
|
utilization reporting in the `reporting` block of a Nomad agent configuration.
|
|
|
|
Configuration applies to agents running with [server mode
|
|
enabled][server_mode_enabled].
|
|
|
|
Refer to the [Automated license utilization reporting
|
|
guide][automated_license_utilization_reporting] for which ports to open and what
|
|
data is shared.
|
|
|
|
```hcl
|
|
reporting {
|
|
license {
|
|
enabled = true
|
|
}
|
|
|
|
snapshot_retention_time = "9600h"
|
|
}
|
|
```
|
|
|
|
## `reporting` Parameters
|
|
|
|
- `license` <code>([license](#license-block): default)</code> - Configures
|
|
automated license utilization reporting.
|
|
|
|
- `snapshot_retention_time` `(string: "9600h")` - Configures the maximum amount
|
|
of time that Nomad retains a utilization reporting snapshot in the Nomad
|
|
state store. You can export these snapshots with the [`nomad operator
|
|
utilization`][] command.
|
|
|
|
## `license` Block
|
|
|
|
- `enabled` `(bool: true)` - Specifies whether automated license utilization
|
|
reporting should be enabled and run.
|
|
|
|
[server_mode_enabled]: /nomad/docs/configuration/server#enabled
|
|
[automated_license_utilization_reporting]: /nomad/docs/enterprise/license/utilization-reporting
|
|
[`nomad operator utilization`]: /nomad/docs/commands/operator/utilization
|