github.com/wmuizelaar/kpt@v0.0.0-20221018115725-bd564717b2ed/site/reference/cli/live/status/README.md (about)

     1  ---
     2  title: "`status`"
     3  linkTitle: "status"
     4  type: docs
     5  description: >
     6  Display the status for the resources in the cluster
     7  ---
     8  
     9  <!--mdtogo:Short
    10      Display shows the status for the resources in the cluster
    11  -->
    12  
    13  `status` shows the resource status for resources belonging to the package.
    14  
    15  ### Synopsis
    16  
    17  <!--mdtogo:Long-->
    18  
    19  ```
    20  kpt live status [PKG_PATH | -] [flags]
    21  ```
    22  
    23  #### Args
    24  
    25  ```
    26  PKG_PATH | -:
    27    Path to the local package for which the status of the package in the cluster
    28    should be displayed. It must contain either a Kptfile or a ResourceGroup CR
    29    with inventory metadata.
    30    Defaults to the current working directory.
    31    Using '-' as the package path will cause kpt to read resources from stdin.
    32  ```
    33  
    34  #### Flags
    35  
    36  ```
    37  --output:
    38    Determines the output format for the status information. Must be one of the following:
    39  
    40      * events: The output will be a list of the status events as they become available.
    41      * json: The output will be a list of the status events as they become available,
    42        each formatted as a json object.
    43      * table: The output will be presented as a table that will be updated inline
    44        as the status of resources become available.
    45  
    46    The default value is ‘events’.
    47  
    48  --poll-period:
    49    The frequency with which the cluster will be polled to determine the status
    50    of the applied resources. The default value is 2 seconds.
    51  
    52  --poll-until:
    53    When to stop polling for status and exist. Must be one of the following:
    54  
    55      * known: Exit when the status for all resources have been found.
    56      * current: Exit when the status for all resources have reached the Current status.
    57      * deleted: Exit when the status for all resources have reached the NotFound
    58        status, i.e. all the resources have been deleted from the live state.
    59      * forever: Keep polling for status until interrupted.
    60  
    61    The default value is ‘known’.
    62  
    63  --timeout:
    64    Determines how long the command should run before exiting. This deadline will
    65    be enforced regardless of the value of the --poll-until flag. The default is
    66    to wait forever.
    67    
    68  --inv-type:
    69    Ways to get the inventory information. Must be one of the following:
    70    
    71    * local: Get the inventory information from the local file.
    72      This will only get the inventory information of the package at the given/default path.
    73    * remote: Get the inventory information by calling List API to the cluster.
    74      This will retrieve a list of inventory information from the cluster.
    75    
    76    The default value is ‘local’.
    77    
    78  --inv-names:
    79    Filter for printing statuses of packages with specified inventory names.
    80    For multiple inventory names, use comma to them.
    81    This must be used with --inv-type=remote.
    82    
    83  --namespaces:
    84    Filter for printing statuses of packages under specified namespaces.
    85    For multiple namespaces, use comma to separate them.
    86    
    87  --statuses:
    88    Filter for printing packages with specified statuses.
    89    For multiple statuses, use comma to separate them.
    90  ```
    91  
    92  <!--mdtogo-->
    93  
    94  ### Examples
    95  
    96  <!--mdtogo:Examples-->
    97  
    98  ```shell
    99  # Monitor status for the resources belonging to the package in the current
   100  # directory. Wait until all resources have reconciled.
   101  $ kpt live status
   102  ```
   103  
   104  ```shell
   105  # Monitor status for the resources belonging to the package in the my-app
   106  # directory. Output in table format:
   107  $ kpt live status my-app --poll-until=forever --output=table
   108  ```
   109  
   110  ```shell
   111  # Monitor status for the all resources on the cluster
   112  # with certain inventory names and under certain namespaces.
   113  $ kpt live status --inv-type remote --inv-names inv1,inv2 --namespaces ns1,ns2
   114  ```
   115  
   116  ```shell
   117  # Monitor resources on the cluster that has Current or InProgress status
   118  $ kpt live status --inv-type remote --statuses Current,InProgress
   119  ```
   120  
   121  <!--mdtogo-->
   122  
   123  [inventory template]: /reference/cli/live/apply/#prune