github.com/Ilhicas/nomad@v1.0.4-0.20210304152020-e86851182bc3/website/content/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  When ACLs are enabled, this command requires a token with the 'read-job'
    25  capability for the deployment's namespace.
    26  
    27  ## General Options
    28  
    29  @include 'general_options.mdx'
    30  
    31  ## Status Options
    32  
    33  - `-json` : Output the deployment in its JSON format.
    34  - `-t` : Format and display the deployment using a Go template.
    35  - `-verbose`: Show full information.
    36  
    37  ## Examples
    38  
    39  Inspect the status of a complete deployment:
    40  
    41  ```shell-session
    42  $ nomad deployment status 06ca68a2
    43  ID          = 06ca68a2
    44  Job ID      = example
    45  Job Version = 0
    46  Status      = successful
    47  Description = Deployment completed successfully
    48  
    49  Deployed
    50  Task Group  Desired  Placed  Healthy  Unhealthy
    51  cache       2        2       2        0
    52  web         2        2       2        0
    53  ```
    54  
    55  Inspect the status of a deployment that is waiting for canary promotion:
    56  
    57  ```shell-session
    58  $ nomad deployment status 0b
    59  ID          = 0b23b149
    60  Job ID      = example
    61  Job Version = 1
    62  Status      = running
    63  Description = Deployment is running but requires manual promotion
    64  
    65  Deployed
    66  Task Group  Promoted  Desired  Canaries  Placed  Healthy  Unhealthy
    67  cache       false     2        1         1       0        0
    68  web         N/A       2        0         2       2        0
    69  ```