jetstack / navigator

Managed Database-as-a-Service (DBaaS) on Kubernetes
Apache License 2.0
271 stars 31 forks source link

Use consistent command line help summary for all Navigator CLI tools #342

Closed wallrj closed 6 years ago

wallrj commented 6 years ago

Fixes: #341

Release note:

NONE
wallrj commented 6 years ago

Here's how it looks:

find . -maxdepth 1 -executable -type f  | while read f; do echo; echo "\$ $f --help"; $f --help | head -n 8; done

$ ./navigator-controller_linux_amd64 --help

Launch a Navigator controller.

Navigator is a Kubernetes extension for managing common stateful services on Kubernetes.
Documentation is available at https://navigator-dbaas.readthedocs.io.

Usage:
  navigator-controller [flags]

$ ./navigator-apiserver_linux_amd64 --help

Launch a Navigator API server.

Navigator is a Kubernetes extension for managing common stateful services on Kubernetes.
Documentation is available at https://navigator-dbaas.readthedocs.io.

Usage:
  navigator-apiserver [flags]

$ ./navigator-pilot-elasticsearch_linux_amd64 --help

Launch a Navigator Elasticsearch Pilot.

Navigator is a Kubernetes extension for managing common stateful services on Kubernetes.
Documentation is available at https://navigator-dbaas.readthedocs.io.

Usage:
  navigator-pilot-elasticsearch [flags]

$ ./navigator-pilot-cassandra_linux_amd64 --help

Launch a Navigator Cassandra Pilot.

Navigator is a Kubernetes extension for managing common stateful services on Kubernetes.
Documentation is available at https://navigator-dbaas.readthedocs.io.

Usage:
  navigator-pilot-cassandra [flags]
jetstack-bot commented 6 years ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kragniz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/jetstack/navigator/blob/master/OWNERS)~~ [kragniz] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment