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>
86 lines
2.9 KiB
Plaintext
86 lines
2.9 KiB
Plaintext
---
|
|
layout: api
|
|
page_title: Snapshot - Operator - HTTP API
|
|
description: |-
|
|
The /operator/snapshot endpoints save and restore Nomad's server state for disaster recovery.
|
|
---
|
|
|
|
# Snapshot Operator HTTP API
|
|
|
|
## Generate Snapshot
|
|
|
|
This endpoint generates and returns an atomic, point-in-time snapshot of the
|
|
Nomad server state for disaster recovery. Snapshots include all state managed by Nomad's
|
|
Raft [consensus protocol](/nomad/docs/architecture/cluster/consensus).
|
|
|
|
Snapshots are exposed as gzipped tar archives which internally contain the Raft
|
|
metadata required to restore, as well as a binary serialized version of the
|
|
Nomad server state. The contents are covered internally by SHA-256 hashes.
|
|
These hashes are verified during snapshot restore operations. The structure of
|
|
the archive is internal to Nomad and not intended to be used other than for
|
|
restore operations. The archives are not designed to be modified before a
|
|
restore.
|
|
|
|
| Method | Path | Produces |
|
|
| :----- | :---------------------- | ------------------------ |
|
|
| `GET` | `/v1/operator/snapshot` | `200 application/x-gzip` |
|
|
|
|
The table below shows this endpoint's support for
|
|
[blocking queries](/nomad/api-docs#blocking-queries) and
|
|
[required ACLs](/nomad/api-docs#acls).
|
|
|
|
| Blocking Queries | ACL Required |
|
|
| ---------------- | ------------ |
|
|
| `NO` | `management` |
|
|
|
|
### Parameters
|
|
|
|
- `stale` - Specifies if the cluster should respond without an active leader.
|
|
This is specified as a query string parameter.
|
|
|
|
### Sample Request
|
|
|
|
```shell-session
|
|
$ curl \
|
|
-o snapshot.tgz \
|
|
http://127.0.0.1:4646/v1/operator/snapshot
|
|
```
|
|
|
|
The above example results in a tarball named `snapshot.tgz` in the current working directory.
|
|
|
|
## Restore Snapshot
|
|
|
|
This endpoint restores a point-in-time snapshot of the Nomad server state.
|
|
|
|
Restores involve a potentially dangerous low-level Raft operation that is not
|
|
designed to handle server failures during a restore. This operation is primarily
|
|
intended to be used when recovering from a disaster, restoring into a fresh
|
|
cluster of Nomad servers.
|
|
|
|
The body of the request should be a snapshot archive returned from a previous
|
|
call to the `GET` method.
|
|
|
|
| Method | Path | Produces |
|
|
| :----- | :---------------------- | ----------------------------- |
|
|
| `PUT` | `/v1/operator/snapshot` | `200 text/plain (empty body)` |
|
|
|
|
The table below shows this endpoint's support for
|
|
[blocking queries](/nomad/api-docs#blocking-queries) and
|
|
[required ACLs](/nomad/api-docs#acls).
|
|
|
|
| Blocking Queries | ACL Required |
|
|
| ---------------- | ------------ |
|
|
| `NO` | `management` |
|
|
|
|
### Sample Request
|
|
|
|
```shell-session
|
|
$ curl \
|
|
--request PUT \
|
|
--data-binary @snapshot.tgz \
|
|
http://127.0.0.1:4646/v1/operator/snapshot
|
|
```
|
|
|
|
~> Some tools default to www/encoded uploads. Nomad expects the snapshot to be
|
|
in pure binary form.
|