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

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