github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/commands/system/gc.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: system gc'
     4  description: |
     5    Run the system garbage collection process.
     6  ---
     7  
     8  # Command: system gc
     9  
    10  Initializes a garbage collection of jobs, evaluations, allocations, and nodes.
    11  This is an asynchronous operation.
    12  
    13  Nomad periodically garbage collects jobs, evaluations, allocations, and nodes.
    14  The exact garbage collection logic varies by object, but in general Nomad only
    15  permanently deletes objects once they are terminal and no longer needed for
    16  future scheduling decisions. See [`gc` related server agent configuration
    17  parameters][gc_params] for details on tuning periodic garbage collection.
    18  
    19  [gc_params]: /docs/configuration/server#node_gc_threshold
    20  
    21  The `system gc` command bypasses these settings and immediately attempts to
    22  garbage collect dead objects regardless of any "threshold" or "interval" server
    23  settings. This is useful to quickly free memory on servers running low, but
    24  users should prefer tuning periodic garbage collection parameters to meet their
    25  needs instead of relying on manually running `system gc`.
    26  
    27  ## Usage
    28  
    29  ```plaintext
    30  nomad system gc [options]
    31  ```
    32  
    33  If ACLs are enabled, this option requires a management token.
    34  
    35  ## General Options
    36  
    37  @include 'general_options_no_namespace.mdx'
    38  
    39  ## Examples
    40  
    41  Running the system gc command does not output unless an error occurs:
    42  
    43  ```shell-session
    44  $ nomad system gc
    45  
    46  ```