Skip to content

node-taints flag is incorrectly documented in code #203

Description

@ronanbarrett

To filter out node-taints the taint should be suffixed with a "-" but the cobra documentation (kube-capacity --help) says to prefix with a "!" which doesn't work. The readme is however correct.

The fix is to update

"node-taints", "t", "", "comma seperated list of taints to filter nodes with, prefix taint with '!' to filter out")
with the text to say "comma separated list of taints to filter nodes with, suffix taint with '-' to filter out"

❯ kube-capacity version
kube-capacity version v0.7.4

❯ kube-capacity --help
kube-capacity provides an overview of the resource requests, limits, and utilization in a Kubernetes cluster.

Usage:
  kube-capacity [flags]
  kube-capacity [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  version     Print the version number of kube-capacity

Flags:
      --as string                 user to impersonate kube-capacity with
      --as-group string           group to impersonate kube-capacity with
  -a, --available                 includes quantity available instead of percentage used
  -c, --containers                includes containers in output
      --context string            context to use for Kubernetes config
  -h, --help                      help for kube-capacity
      --kubeconfig string         kubeconfig file to use for Kubernetes config
  -n, --namespace string          only include pods from this namespace
      --namespace-labels string   labels to filter namespaces with
      --no-taint                  exclude nodes with taints
      --node-labels string        labels to filter nodes with
  -t, --node-taints string        comma seperated list of taints to filter nodes with, prefix taint with '!' to filter out
  -o, --output string             output format for information (supports: [table csv tsv json yaml]) (default "table")
      --pod-count                 includes pod count per node in output
  -l, --pod-labels string         labels to filter pods with
  -p, --pods                      includes pods in output
      --sort string               attribute to sort results by (supports: [cpu.util cpu.request cpu.limit mem.util mem.request mem.limit cpu.util.percentage cpu.request.percentage cpu.limit.percentage mem.util.percentage mem.request.percentage mem.limit.percentage name]) (default "name")
  -u, --util                      includes resource utilization in output

Use "kube-capacity [command] --help" for more information about a command.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions