Carvel Logo

App Command Reference

Overview

The app commands let users observe and interact with Apps conveniently.

Listing apps

The kctrl app list command can be used to list apps.

$ kctrl app list

Supported flags:

  • -A, --all-namespaces boolean, List apps in all namespaces
  • -n, --namespace string, Specified namespace ($KCTRL_NAMESPACE or default from kubeconfig)

Geting details for an app

The kctrl app get command can be used to get details for an app.

$ kctrl app get -a simple-app

Supported flags:

  • -a, --app string, Set app name (required)
  • -n, --namespace string, Specified namespace ($KCTRL_NAMESPACE or default from kubeconfig)

Observe status of an app

The kctrl app status command allows users to observe the status of the app with information from the last reconciliation. The command tails and streams app status updates till the app reconciles or fails if the command is run while the app is reconciling.

$ kctrl app status -a simple-app

Supported flags:

  • -a, --app string, Set app name (required)
  • -n, --namespace string, Specified namespace ($KCTRL_NAMESPACE or default from kubeconfig)
  • --ignore-not-exists boolean, Keep following app if it does not exist

Pause reconciliation of an app

The kctrl app pause command allows pausing of periodic recopnciliation of an app.

$ kctrl app pause -a simple-app

Supported flags:

  • -a, --app string, Set app name (required)
  • -n, --namespace string, Specified namespace ($KCTRL_NAMESPACE or default from kubeconfig)

Trigger reconciliation of an app

The kctrl app kick command can be used to trigger reconciliation of a command and tail the app status till it reconciles if desired. It can also be used to restart periodic reconciliation for a paused app.

$ kctrl app kick -a simple-app

Supported flags:

  • -a, --app string, Set app name (required)
  • -n, --namespace string, Specified namespace ($KCTRL_NAMESPACE or default from kubeconfig)
  • --wait boolean, Wait for reconciliation to complete (default true)
  • --wait-check-interval duration, Amount of time to sleep between checks while waiting (default 1s)
  • --wait-timeout duration, Maximum amount of time to wait in wait phase (default 5m0s)

Delete an app

The kctrl app delete command can be used to delete an app.

$ kctrl app delete -a simple-app

Supported flags:

  • -a, --app string, Set app name (required)
  • -n, --namespace string, Specified namespace ($KCTRL_NAMESPACE or default from kubeconfig)
  • --noop boolean, Ignore resources created by the app and delete the custom resource itself
  • --wait boolean, Wait for reconciliation to complete (default true)
  • --wait-check-interval duration, Amount of time to sleep between checks while waiting (default 1s)
  • --wait-timeout duration, Maximum amount of time to wait in wait phase (default 5m0s)

Global Flags

  • --color boolean, Set color output (default true)
  • --column string, Filter to show only given columns
  • --debug boolean, Include debug output
  • -h, --help boolean, help for kctrl
  • --json boolean, Output as JSON
  • --kube-api-burst, int, Set Kubernetes API client burst limit (default 1000)
  • --kube-api-qps float32, Set Kubernetes API client QPS limit (default 1000)
  • --kubeconfig string, Path to the kubeconfig file ($KCTRL_KUBECONFIG),
  • --kubeconfig-contextstring, Kubeconfig context override ($KCTRL_KUBECONFIG_CONTEXT)
  • --kubeconfig-yaml string, Kubeconfig contents as YAML ($KCTRL_KUBECONFIG_YAML)
  • --tty boolean, Force TTY-like output (default true)
  • -v, --version boolean, version for kctrl
  • -y, --yes, boolean, Assumes yes for any prompt