Skip to content

Commit

Permalink
docs: explain behavior of system gc command (#13342)
Browse files Browse the repository at this point in the history
  • Loading branch information
schmichael authored Jun 13, 2022
1 parent dd71afb commit 34959b2
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions website/content/docs/commands/system/gc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 34959b2

Please sign in to comment.