Documentation for CLI options?

[mikl]

Spelunking around in types.go, it looks like there are a bunch of CLI options that are not mentioned in the README, like CommitLimit or OrphanDeletionRegex.

Are those documented somewhere else?

[bittner]

This is where they are documented:

$ seiso
Keeps your Kubernetes projects clean

Usage:
  seiso [command]

Available Commands:
  configmaps  Cleans up your unused ConfigMaps in the Kubernetes cluster
  help        Help about any command
  images      Cleans up your image registry from unused image tags
  secrets     Cleans up your unused secrets in the Kubernetes cluster

Flags:
  -h, --help               help for seiso
  -b, --log.batch          Use Batch mode (disables logging, prints deleted images only)
      --log.level string   Log level, one of [debug info warn error fatal] (default "info")
  -v, --log.verbose        Shorthand for --log.level debug
  -n, --namespace string   Cluster namespace of current context (default "example-django")
      --version            version for seiso

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

$ seiso configmaps --help
Sometimes ConfigMaps are left unused in the Kubernetes cluster.
This command deletes ConfigMaps that are not being used anymore.

Usage:
  seiso configmaps [flags]

Aliases:
  configmaps, configmap, cm

Flags:
  -d, --delete              Effectively delete ConfigMaps found
  -h, --help                help for configmaps
  -k, --keep int            Keep most current <k> ConfigMaps; does not include currently used ConfigMaps (if detected) (default 3)
  -l, --label strings       Identify the ConfigMap by these labels
      --older-than string   Delete ConfigMaps that are older than the duration, e.g. [1y2mo3w4d5h6m7s] (default "1w")

Global Flags:
  -b, --log.batch          Use Batch mode (disables logging, prints deleted images only)
      --log.level string   Log level, one of [debug info warn error fatal] (default "info")
  -v, --log.verbose        Shorthand for --log.level debug
  -n, --namespace string   Cluster namespace of current context (default "example-django")

$ seiso secrets --help
Sometimes secrets are left unused in the Kubernetes cluster.
This command deletes secrets that are not being used anymore.

Usage:
  seiso secrets [flags]

Aliases:
  secrets, secret

Flags:
  -d, --delete              Effectively delete Secrets found
  -h, --help                help for secrets
  -k, --keep int            Keep most current <k> Secrets; does not include currently used secret (if detected) (default 3)
  -l, --label strings       Identify the Secret by these labels
      --older-than string   Delete Secrets that are older than the duration, e.g. [1y2mo3w4d5h6m7s] (default "1w")

Global Flags:
  -b, --log.batch          Use Batch mode (disables logging, prints deleted images only)
      --log.level string   Log level, one of [debug info warn error fatal] (default "info")
  -v, --log.verbose        Shorthand for --log.level debug
  -n, --namespace string   Cluster namespace of current context (default "example-django")

$ seiso image --help
Cleans up your image registry from unused image tags

Usage:
  seiso images [command]

Aliases:
  images, image, img

Available Commands:
  history     Clean up excessive image tags
  orphans     Clean up unknown image tags

Flags:
  -h, --help   help for images

Global Flags:
  -b, --log.batch          Use Batch mode (disables logging, prints deleted images only)
      --log.level string   Log level, one of [debug info warn error fatal] (default "info")
  -v, --log.verbose        Shorthand for --log.level debug
  -n, --namespace string   Cluster namespace of current context (default "example-django")

Use "seiso images [command] --help" for more information about a command.

Do you think we should create a dedicated documentation (à la readthedocs.org) or would it be sufficient to mention this in the README?

[mikl]

Ah, yes, I guess I should have thought of that.

Since it’s now clear in the readme how to find more information, I think that should be good enough for most people.

[bittner]

Thanks @mikl for helping to make Seiso more useful! 🥇

Let us know what else you see missing or features you'd like to have. Your feedback is always more than welcome!