Issue #8160 has been updated by Jeff McCune.

# Required for release #

Dan and I believe this ticket is a requirement for release.
----------------------------------------
Bug #8160: CloudPack subcommand should be renamed from "node"
https://projects.puppetlabs.com/issues/8160

Author: Jeff McCune
Status: Accepted
Priority: High
Assignee: Jeff McCune
Category: 
Target version: 
Keywords: cloudpack
Branch: 


# Overview #

This is more of a personal opinion I'd like to get UX feedback on, but in my 
evaluation of the potential work required before release I'm left with this 
opinion.

The cloud pack module in it's current form is 100% Amazon EC2 focused.  As an 
end-user of the Puppet Cloud Functionality, I expect the subcommand to be 
fairly focused on cloud functionality and not "other" things I didn't come to 
the module to work with.

 * Related documentation about the [Cloud CLI 
UX](https://sites.google.com/a/puppetlabs.com/ux/investigations/cloud-cli)

Here is the current output of the `puppet help node` subcommand in 
v0.0.1-6-gf15ed00.

<pre>
USAGE: puppet node <action> [--terminus TERMINUS] 

This subcommand interacts with node objects, which are used by Puppet to
build a catalog. A node object consists of the node's facts, environment,
node parameters (exposed in the parser as top-scope variables), and classes.

OPTIONS:
  --mode MODE                    - The run mode to use (user, agent, or master).
  --render-as FORMAT             - The rendering format to use.
  --verbose                      - Whether to log verbosely.
  --debug                        - Whether to log debug information.
  --terminus TERMINUS            - The indirector terminus to use.

ACTIONS:
  bootstrap    undocumented action
  classify     undocumented action
  create       undocumented action
  destroy      Invalid for this subcommand.
  find         Retrieve a node object.
  info         Print the default terminus class for this face.
  init         undocumented action
  install      undocumented action
  save         Invalid for this subcommand.
  search       Invalid for this subcommand.
  terminate    undocumented action

TERMINI: active_record, exec, ldap, memory, plain, rest, yaml

See 'puppet man node' or 'man puppet-node' for full help.
</pre>

I believe the following pieces of information are "noise" to the end user of 
cloud pack:

 * Has nothing to do with EC2 instances:
   * `[--terminus TERMINUS]`
   * `This subcommand interacts with node objects, which are used by Puppet to 
build a catalog. A node object consists of the node's facts, environment, node 
parameters (exposed in the parser as top-scope variables), and classes.`
 * Does not apply:
   * `--mode MODE                    - The run mode to use (user, agent, or 
master).`
   * `--render-as FORMAT             - The rendering format to use.`
 * Has nothing to do with EC2 instances:
   * `--terminus TERMINUS            - The indirector terminus to use.`
 * Confusing with --terminate option:
   * `destroy      Invalid for this subcommand.`
 * Has nothing to do with booting EC2 instances:
   * `find         Retrieve a node object.`
   * `info         Print the default terminus class for this face.`
   * `save         Invalid for this subcommand.`
   * `search       Invalid for this subcommand.`
   * `TERMINI: active_record, exec, ldap, memory, plain, rest, yaml`

# Recommendation #

My recommendation is to move all of the Cloud Pack EC2 actions to a subcommand 
named *`awsnode`* and "hide" all of the unrelated actions and documentation.



-- 
You have received this notification because you have either subscribed to it, 
or are involved in it.
To change your notification preferences, please click here: 
http://projects.puppetlabs.com/my/account

-- 
You received this message because you are subscribed to the Google Groups 
"Puppet Bugs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/puppet-bugs?hl=en.

Reply via email to