`status`

status shows the resource status for resources belonging to the package.

Synopsis #

kpt live status [PKG_PATH | -] [flags]

Args #

PKG_PATH | -:
  Path to the local package for which the status of the package in the cluster
  should be displayed. It must contain either a Kptfile or a ResourceGroup CR
  with inventory metadata.
  Defaults to the current working directory.
  Using '-' as the package path will cause kpt to read resources from stdin.

Flags #

--output:
  Determines the output format for the status information. Must be one of the following:

    * events: The output will be a list of the status events as they become available.
    * json: The output will be a list of the status events as they become available,
      each formatted as a json object.
    * table: The output will be presented as a table that will be updated inline
      as the status of resources become available.

  The default value is ‘events’.

--poll-period:
  The frequency with which the cluster will be polled to determine the status
  of the applied resources. The default value is 2 seconds.

--poll-until:
  When to stop polling for status and exist. Must be one of the following:

    * known: Exit when the status for all resources have been found.
    * current: Exit when the status for all resources have reached the Current status.
    * deleted: Exit when the status for all resources have reached the NotFound
      status, i.e. all the resources have been deleted from the live state.
    * forever: Keep polling for status until interrupted.

  The default value is ‘known’.

--timeout:
  Determines how long the command should run before exiting. This deadline will
  be enforced regardless of the value of the --poll-until flag. The default is
  to wait forever.
  
--inv-type:
  Ways to get the inventory information. Must be one of the following:
  
  * local: Get the inventory information from the local file.
    This will only get the inventory information of the package at the given/default path.
  * remote: Get the inventory information by calling List API to the cluster.
    This will retrieve a list of inventory information from the cluster.
  
  The default value is ‘local’.
  
--inv-names:
  Filter for printing statuses of packages with specified inventory names.
  For multiple inventory names, use comma to them.
  This must be used with --inv-type=remote.
  
--namespaces:
  Filter for printing statuses of packages under specified namespaces.
  For multiple namespaces, use comma to separate them.
  
--statuses:
  Filter for printing packages with specified statuses.
  For multiple statuses, use comma to separate them.

Examples #

# Monitor status for the resources belonging to the package in the current
# directory. Wait until all resources have reconciled.
$ kpt live status

# Monitor status for the resources belonging to the package in the my-app
# directory. Output in table format:
$ kpt live status my-app --poll-until=forever --output=table

# Monitor status for the all resources on the cluster
# with certain inventory names and under certain namespaces.
$ kpt live status --inv-type remote --inv-names inv1,inv2 --namespaces ns1,ns2

# Monitor resources on the cluster that has Current or InProgress status
$ kpt live status --inv-type remote --statuses Current,InProgress