github.com/adityamillind98/nomad@v0.11.8/website/pages/docs/commands/deployment/status.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: deployment status'
     4  sidebar_title: status
     5  description: |
     6    The deployment status command is used to display the status of a deployment.
     7  ---
     8  
     9  # Command: deployment status
    10  
    11  The `deployment status` command is used to display the status of a deployment.
    12  The status will display the number of desired changes as well as the currently
    13  applied changes.
    14  
    15  ## Usage
    16  
    17  ```plaintext
    18  nomad deployment status [options] <deployment id>
    19  ```
    20  
    21  The `deployment status` command requires a single argument, a deployment ID or
    22  prefix.
    23  
    24  ## General Options
    25  
    26  @include 'general_options.mdx'
    27  
    28  ## Status Options
    29  
    30  - `-json` : Output the deployment in its JSON format.
    31  - `-t` : Format and display the deployment using a Go template.
    32  - `-verbose`: Show full information.
    33  
    34  ## Examples
    35  
    36  Inspect the status of a complete deployment:
    37  
    38  ```shell-session
    39  $ nomad deployment status 06ca68a2
    40  ID          = 06ca68a2
    41  Job ID      = example
    42  Job Version = 0
    43  Status      = successful
    44  Description = Deployment completed successfully
    45  
    46  Deployed
    47  Task Group  Desired  Placed  Healthy  Unhealthy
    48  cache       2        2       2        0
    49  web         2        2       2        0
    50  ```
    51  
    52  Inspect the status of a deployment that is waiting for canary promotion:
    53  
    54  ```shell-session
    55  $ nomad deployment status 0b
    56  ID          = 0b23b149
    57  Job ID      = example
    58  Job Version = 1
    59  Status      = running
    60  Description = Deployment is running but requires manual promotion
    61  
    62  Deployed
    63  Task Group  Promoted  Desired  Canaries  Placed  Healthy  Unhealthy
    64  cache       false     2        1         1       0        0
    65  web         N/A       2        0         2       2        0
    66  ```