mirror of
https://github.com/kemko/nomad.git
synced 2026-01-10 04:15:41 +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
85 lines
2.4 KiB
Plaintext
85 lines
2.4 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: nomad operator utilization command reference
|
|
description: |-
|
|
The "operator utilization" generates utilization reporting bundles for Nomad Enterprise users.
|
|
---
|
|
|
|
# `nomad operator utilization` command reference
|
|
|
|
The `operator utilization` command allows Nomad Enterprise users to generate
|
|
utilization reporting bundles. If you have disabled automated reporting, use
|
|
this command to manually generate the report and send it to HashiCorp. Nomad
|
|
takes a new snapshot when there are no snapshots from the past twenty-four
|
|
hours.
|
|
|
|
If ACLs are enabled, this command requires a token with the `operator:write`
|
|
capability.
|
|
|
|
<Note title="Nomad Enterprise">
|
|
|
|
Refer to the [manual license utilization
|
|
reporting](/nomad/docs/enterprise/license/manual-reporting) page to learn more
|
|
about reporting your Nomad Enterprise license utilization.
|
|
|
|
</Note>
|
|
|
|
## Command Options
|
|
|
|
- `-message` `(string; "")` - Provide context about the conditions under which
|
|
the report was generated and submitted. This message is not included in the
|
|
utilization bundle but is included in the Nomad server logs.
|
|
|
|
- `-output` `(string; "")` - Specifies the output path for the bundle. Defaults
|
|
to a time-based generated file name in the current working directory.
|
|
|
|
- `-today-only` `(bool: false)` - Include snapshots from the previous 24 hours,
|
|
not historical snapshots.
|
|
|
|
## General options
|
|
|
|
@include 'general_options.mdx'
|
|
|
|
## Examples
|
|
|
|
Create a utilization reporting bundle that includes all persisted historical
|
|
snapshots and has the default bundle name
|
|
(`nomad-utilization-<time_stamp>.json`).
|
|
|
|
```shell-session
|
|
$ nomad operator utilization
|
|
Success! Utilization reporting bundle written to: nomad-utilization-2024-02-16T22-23-25Z.json
|
|
```
|
|
|
|
Create a utilization reporting bundle with a message about the bundle, and
|
|
output the file at the specified path, `/utilization/reports/latest.json`.
|
|
|
|
```shell-session
|
|
$ nomad operator utilization \
|
|
-message="Change Control 654987" \
|
|
-output="/utilization/reports/latest.json"
|
|
```
|
|
|
|
**Example output**
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```plaintext
|
|
Success! Utilization reporting bundle written to: /utilization/reports/latest.json
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
The message, `Change Control 654987`, is included in the _server log_, but not
|
|
in the bundle.
|
|
|
|
**Example entry in the server log**
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```plaintext
|
|
[INFO] reporting: reporting bundle generated: message="Change Control 654987"
|
|
```
|
|
|
|
</CodeBlockConfig>
|