Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve help output for deploy command to list common flags first #40

Closed
cppforlife opened this issue Sep 27, 2019 · 2 comments
Closed
Labels
enhancement This issue is a feature request tgik Came up during http://tgik.io/ episode ui UI improvement

Comments

@cppforlife
Copy link
Contributor

No description provided.

@cppforlife cppforlife added ui UI improvement tgik Came up during http://tgik.io/ episode labels Sep 27, 2019
@cppforlife
Copy link
Contributor Author

help mesage updated:

$ kapp deploy -h
Deploy app

Usage:
  kapp deploy [flags]

Aliases:
  deploy, d, dep

Examples:

  # Deploy app 'app1' based on config files in config/
  kapp deploy -a app1 -f config/

  # Deploy app 'app1' while showing full text diff
  kapp deploy -a app1 -f config/ --diff-changes

  # Deploy app 'app1' based on remote file
  kapp deploy -a app1 \
    -f https://github.com/...download/v0.6.0/crds.yaml \
    -f https://github.com/...download/v0.6.0/release.yaml

Common Flags:
  -a, --app string                                           Set app name (or label selector) (format: name, key=val, !key)
  -c, --diff-changes                                         Show changes
  -f, --file strings                                         Set file (format: /tmp/foo, https://..., -) (can repeat)
  -n, --namespace string                                     Specified namespace ($KAPP_NAMESPACE or default from kubeconfig)

Diff Flags:
      --diff-against-last-applied                            Show changes against last applied copy when possible (default true)
  -c, --diff-changes                                         Show changes
      --diff-context int                                     Show number of lines around changed lines (default 2)
      --diff-run                                             Show diff and exit successfully without any further action
      --diff-summary                                         Show diff summary (default true)

Apply Flags:
      --apply-concurrency int                                Maximum number of concurrent apply operations (default 5)
      --apply-default-update-strategy string                 Change default update strategy
      --apply-ignored                                        Set to apply ignored changes
      --dangerous-allow-empty-list-of-resources              Allow to apply empty set of resources (same as running kapp delete)
      --dangerous-override-ownership-of-existing-resources   Steal existing resources from another app

Wait Flags:
      --wait                                                 Set to wait for changes to be applied (default true)
      --wait-check-interval duration                         Amount of time to sleep between checks while waiting (default 1s)
      --wait-ignored                                         Set to wait for ignored changes to be applied
      --wait-timeout duration                                Maximum amount of time to wait (default 15m0s)

Resource Filter Flags:
      --filter string                                        Set filter (example: {"and":[{"not":{"resource":{"kind":"foo%"}}},{"resource":{"kind":"!foo"}}]})
      --filter-age string                                    Set age filter (example: 5m, 500h+, 10m-)
      --filter-kind strings                                  Set kinds filter (example: Pod) (can repeat)
      --filter-kind-ns strings                               Set kind-namespace filter (example: Pod/, Pod/knative-serving) (can repeat)
      --filter-kind-ns-name strings                          Set kind-namespace-name filter (example: Deployment/knative-serving/controller) (can repeat)
      --filter-name strings                                  Set name filter (example: controller) (can repeat)
      --filter-ns strings                                    Set namespace filter (example: knative-serving) (can repeat)

Resource Validation Flags:
      --allow-all-ns                                         Set to allow all namespaces for resources (does not apply to the app itself)
      --allow-check                                          Enable client-side allowing
      --allow-cluster                                        Set to allow cluster level for resources (does not apply to the app itself)
      --allow-ns strings                                     Set allowed namespace for resources (does not apply to the app itself)

Resource Mangling Flags:
      --into-ns string                                       Place resources into namespace
      --map-ns strings                                       Map resources from one namespace into another (could be specified multiple times)

Logs Flags:
      --logs                                                 Show logs from Pods annotated as 'kapp.k14s.io/deploy-logs' (default true)
      --logs-all                                             Show logs from all Pods

Available/Other Flags:
  -h, --help                                                 help for deploy
      --labels strings                                       Set app label (format: key=val, key=) (can repeat)
  -p, --patch                                                Add or update provided resources
      --sort                                                 Sort by namespace, name, etc. (default true)

Global Flags:
      --color                       Set color output (default true)
      --column strings              Filter to show only given columns
      --json                        Output as JSON
      --kubeconfig string           Path to the kubeconfig file ($KAPP_KUBECONFIG)
      --kubeconfig-context string   Kubeconfig context override ($KAPP_KUBECONFIG_CONTEXT)
      --tty                         Force TTY-like output (default true)
  -y, --yes                         Assume yes for any prompt

Succeeded

@cppforlife
Copy link
Contributor Author

@cppforlife cppforlife added the enhancement This issue is a feature request label Sep 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue is a feature request tgik Came up during http://tgik.io/ episode ui UI improvement
Projects
None yet
Development

No branches or pull requests

1 participant