luxolus
/
open-nomad
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

docs: explain behavior of system gc command (#13342)

This commit is contained in:
Michael Schurter 2022-06-13 00:54:23 -07:00 committed by GitHub
parent 5ebd06a8f9
commit f41ea0e5dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
website/content/docs/commands/system/gc.mdx
View File

@ -10,6 +10,20 @@ description: |
Initializes a garbage collection of jobs, evaluations, allocations, and nodes.
This is an asynchronous operation.
Nomad periodically garbage collects jobs, evaluations, allocations, and nodes.
The exact garbage collection logic varies by object, but in general Nomad only
permanently deletes objects once they are terminal and no longer needed for
future scheduling decisions. See [`gc` related server agent configuration
parameters][gc_params] for details on tuning periodic garbage collection.
[gc_params]: /docs/configuration/server#node_gc_threshold
The `system gc` command bypasses these settings and immediately attempts to
garbage collect dead objects regardless of any "threshold" or "interval" server
settings. This is useful to quickly free memory on servers running low, but
users should prefer tuning periodic garbage collection parameters to meet their
needs instead of relying on manually running `system gc`.
## Usage
```plaintext