mirror of
https://github.com/kemko/nomad.git
synced 2026-01-01 16:05:42 +03:00
53b083b8c5
* Move commands from docs to its own root-level directory * temporarily use modified dev-portal branch with nomad ia changes * explicitly clone nomad ia exp branch * retrigger build, fixed dev-portal broken build * architecture, concepts and get started individual pages * fix get started section destinations * reference section * update repo comment in website-build.sh to show branch * docs nav file update capitalization * update capitalization to force deploy * remove nomad-vs-kubernetes dir; move content to what is nomad pg * job section * Nomad operations category, deploy section * operations category, govern section * operations - manage * operations/scale; concepts scheduling fix * networking * monitor * secure section * remote auth-methods folder and move up pages to sso; linkcheck * Fix install2deploy redirects * fix architecture redirects * Job section: Add missing section index pages * Add section index pages so breadcrumbs build correctly * concepts/index fix front matter indentation * move task driver plugin config to new deploy section * Finish adding full URL to tutorials links in nav * change SSO to Authentication in nav and file system * Docs NomadIA: Move tutorials into NomadIA branch (#26132) * Move governance and policy from tutorials to docs * Move tutorials content to job-declare section * run jobs section * stateful workloads * advanced job scheduling * deploy section * manage section * monitor section * secure/acl and secure/authorization * fix example that contains an unseal key in real format * remove images from sso-vault * secure/traffic * secure/workload-identities * vault-acl change unseal key and root token in command output sample * remove lines from sample output * fix front matter * move nomad pack tutorials to tools * search/replace /nomad/tutorials links * update acl overview with content from deleted architecture/acl * fix spelling mistake * linkcheck - fix broken links * fix link to Nomad variables tutorial * fix link to Prometheus tutorial * move who uses Nomad to use cases page; move spec/config shortcuts add dividers * Move Consul out of Integrations; move namespaces to govern * move integrations/vault to secure/vault; delete integrations * move ref arch to docs; rename Deploy Nomad back to Install Nomad * address feedback * linkcheck fixes * Fixed raw_exec redirect * add info from /nomad/tutorials/manage-jobs/jobs * update page content with newer tutorial * link updates for architecture sub-folders * Add redirects for removed section index pages. Fix links. * fix broken links from linkcheck * Revert to use dev-portal main branch instead of nomadIA branch * build workaround: add intro-nav-data.json with single entry * fix content-check error * add intro directory to get around Vercel build error * workound for emtpry directory * remove mdx from /intro/ to fix content-check and git snafu * Add intro index.mdx so Vercel build should work --------- Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>
60 lines
1.8 KiB
Plaintext
60 lines
1.8 KiB
Plaintext
---
|
|
layout: api
|
|
page_title: Utilization - Operator - HTTP API
|
|
description: |-
|
|
The /operator/utilization endpoints provide tools for generating utilization reporting bundles for Nomad Enterprise.
|
|
---
|
|
|
|
# Operator Utilization HTTP API
|
|
|
|
The `/operator/utilization` endpoints provide tools for generating utilization
|
|
reporting bundles for Nomad Enterprise.
|
|
|
|
<EnterpriseAlert />
|
|
|
|
## Generate Nomad Enterprise Utilization Report Bundle
|
|
|
|
This endpoint generates a utilization report. If Nomad did not record a
|
|
utilization snapshot in the previous 24 hours, Nomad records a utilization
|
|
snapshot first.
|
|
|
|
| Method | Path | Produces |
|
|
|--------|----------------------------|--------------------|
|
|
| `POST` | `/v1/operator/utilization` | `application/json` |
|
|
|
|
This table shows this endpoint's support for [blocking queries][] and
|
|
[required ACLs][].
|
|
|
|
| Blocking Queries | ACL Required |
|
|
|------------------|------------------|
|
|
| `NO` | `operator:write` |
|
|
|
|
### Parameters
|
|
|
|
- `today` `(bool: false)` - Specifies to return a bundle that only includes
|
|
utilization snapshots from the previous 24 hours.
|
|
|
|
### Sample Request
|
|
|
|
```shell-session
|
|
$ curl -XPOST \
|
|
https://localhost:4646/v1/operator/utilization?today=true
|
|
```
|
|
|
|
### Sample Response
|
|
|
|
The `Bundle` field in the response body is a base64-encoded blob. The exact
|
|
format of this blog is not part of the Nomad API and is subject to change
|
|
between versions. The [`nomad operator utilization`][] command, which uses this
|
|
API, decodes this to a human-readable file in the current working directory.
|
|
|
|
```json
|
|
{
|
|
"Bundle": "eyJ2ZXJzaW9uIjoiMiIsIm1vZGUiOiJtYW51Y..."
|
|
}
|
|
```
|
|
|
|
[blocking queries]: /nomad/api-docs#blocking-queries
|
|
[required ACLs]: /nomad/api-docs#acls
|
|
[`nomad operator utilization`]: /nomad/commands/operator/utilization
|