cli needs beautifcation

Bug #767955 reported by Kapil Thangavelu
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
pyjuju
Fix Released
High
Kapil Thangavelu

Bug Description

The current cli has some ugly output warts, caused by the auto generated output argparse which we need to customize..
for example running ./bin/ensemble gets

./bin/ensemble -h
usage: ensemble [-h] [--verbose] [--log-file LOG_FILE]

                {resolved,status,add-relation,destroy-service,terminate-machine,deploy,remove-relation,bootstrap,upgrade-formula,open-tunnel,debug-hooks,remove-unit,debug-log,shutdown,add-unit,ssh}
                ...

Ensemble cloud orchestration admin

positional arguments:
  {resolved,status,add-relation,destroy-service,terminate-machine,deploy,remove-relation,bootstrap,upgrade-formula,open-tunnel,debug-hooks,remove-unit,debug-log,shutdown,add-unit,ssh}
    add-relation Add a relation between services in Ensemble.
    add-unit Add a new service unit.
    bootstrap Bootstrap all machine providers in all configured environments.
    debug-log Distributed ensemble debug log watching.
    debug-hooks Interactively debug a hook remotely on a service unit with screen.
    deploy Deploy a formula to Ensemble!
    destroy-service Destroy a running service, its units, and break its relations.
    open-tunnel Establish a tunnel to the environment.
    remove-relation Add a relation between services in Ensemble.
    remove-unit Remove a service unit.
    resolved The ensemble resolve command
    status Output status information about a deployment. This command will report on the runtime state
                        of various system entities. $ ensemble status will return data on entire default deployment.
                        $ ensemble status -e DEPLOYMENT2 will return data on the DEPLOYMENT2 envionment.
    ssh Launch an ssh shell on the given unit or machine.
    shutdown Shutdown machine providers in all configured environments.
    terminate-machine Terminate machines in an environment.
    upgrade-formula Upgrade a service's formula.

optional arguments:
  -h, --help show this help message and exit
  --verbose, -v Enable verbose logging
  --log-file LOG_FILE, -l LOG_FILE
                        Log output to file

notice the multiple duplication of positional arg specs, also the status command has paragraph description instead of the one liner of all the others.. additionally ensemble subcommand --help should have a more detailed help description with examples.

Related branches

Changed in ensemble:
milestone: none → budapest
importance: Undecided → High
Changed in ensemble:
assignee: nobody → Kapil Thangavelu (hazmat)
status: New → In Progress
Changed in ensemble:
milestone: budapest → dublin
Changed in ensemble:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.