github.com/smintz/nomad@v0.8.3/website/source/docs/commands/deployment/fail.html.md.erb (about)

     1  ---
     2  layout: "docs"
     3  page_title: "Commands: deployment fail"
     4  sidebar_current: "docs-commands-deployment-fail"
     5  description: >
     6    The deployment fail command is used to manually fail a deployment.
     7  ---
     8  
     9  # Command: deployment fail
    10  
    11  The `deployment fail` command is used to mark a deployment as failed. Failing a
    12  deployment will stop the placement of new allocations as part of rolling
    13  deployment and if the job is configured to auto revert, the job will attempt to
    14  roll back to a stable version.
    15  
    16  ## Usage
    17  
    18  ```
    19  nomad deployment fail [options] <deployment id>
    20  ```
    21  
    22  The `deployment fail` command requires a single argument, a deployment ID or
    23  prefix. 
    24  
    25  ## General Options
    26  
    27  <%= partial "docs/commands/_general_options" %>
    28  
    29  ## Fail Options
    30  
    31  * `-detach`: Return immediately instead of monitoring. A new evaluation ID
    32    will be output, which can be used to examine the evaluation using the
    33    [eval status](/docs/commands/eval-status.html) command.
    34  
    35  * `-verbose`: Show full information.
    36  
    37  ## Examples
    38  
    39  Manually mark an ongoing deployment as failed:
    40  
    41  ```
    42  $ nomad deployment fail 8990cfbc
    43  Deployment "8990cfbc-28c0-cb28-ca31-856cf691b987" failed
    44  
    45  ==> Monitoring evaluation "a2d97ad5"
    46      Evaluation triggered by job "example"
    47      Evaluation within deployment: "8990cfbc"
    48      Evaluation status changed: "pending" -> "complete"
    49  ==> Evaluation "a2d97ad5" finished with status "complete"
    50  
    51  $ nomad deployment status 8990cfbc
    52  ID          = 8990cfbc
    53  Job ID      = example
    54  Job Version = 2
    55  Status      = failed
    56  Description = Deployment marked as failed
    57  
    58  Deployed
    59  Task Group  Desired  Placed  Healthy  Unhealthy
    60  cache       3        2       1        0
    61  ```