Whirr
  1. Whirr
  2. WHIRR-181

Add descriptions for CLI command options

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 0.3.0
    • Component/s: cli, core
    • Labels:
      None

      Description

      As you can see bellow there are no docs for the command line options.

      $ bin/whirr launch-cluster
      Option 'identity' not set.
      Usage: whirr launch-cluster [OPTIONS]
       
      Option                                  Description                            
      ------                                  -----------                            
      --client-cidrs                                                                
      --cluster-name                                                                
      --config                                                                      
      --credential                                                                  
      --hardware-id                                                                  
      --identity                                                                    
      --image-id                                                                    
      --instance-templates                                                          
      --location-id                                                                  
      --private-key-file                                                            
      --provider                                                                    
      --public-key-file                                                              
      --run-url-base                                                                
      --service-name                                                                
      --version
      

        Activity

        Hide
        Tom White added a comment -

        I've just committed this. Thanks Andrei!

        Show
        Tom White added a comment - I've just committed this. Thanks Andrei!
        Hide
        Andrei Savu added a comment -

        I have attached a simple patch.

        $ ./bin/whirr launch-cluster
        Option 'identity' not set.
        Usage: whirr launch-cluster [OPTIONS]
        
        Option                                  Description                            
        ------                                  -----------                            
        --client-cidrs                          A comma-separated list of CIDR blocks. 
                                                  E.g. 208.128.0.0/11,108.128.0.0/11   
        --cluster-name                          The name of the cluster to operate on. 
                                                  E.g. hadoopcluster.                  
        --config <config.properties>            Note that Whirr properties specified   
                                                  in this file  should all have a      
                                                  whirr. prefix.                       
        --credential                            The cloud credential.                  
        --hardware-id                           The type of hardware to use for the    
                                                  instance. This must be compatible    
                                                  with the image ID.                   
        --identity                              The cloud identity.                    
        --image-id                              The ID of the image to use for         
                                                  instances. If not specified then a   
                                                  vanilla Linux image is chosen.       
        --instance-templates                    The number of instances to launch for  
                                                  each set of roles. E.g. 1 nn+jt,10   
                                                  dn+tt means one instance with the    
                                                  roles nn (namenode) and jt           
                                                  (jobtracker), and ten instances each 
                                                  with the roles dn (datanode) and tt  
                                                  (tasktracker).                       
        --location-id                           The location to launch instances in.   
                                                  If not specified then an arbitrary   
                                                  location will be chosen.             
        --private-key-file                      The filename of the private RSA key    
                                                  used to connect to instances.        
        --provider                              The name of the cloud provider. E.g.   
                                                  ec2, cloudservers                    
        --public-key-file                       The filename of the public key used to 
                                                  connect to instances.                
        --run-url-base                          The base URL for forming run urls      
                                                  from. Change this to host your own   
                                                  set of launch scripts.               
        --service-name                          (optional) The name of the service to  
                                                  use. E.g. hadoop.                    
        --version                                                       
        
        Show
        Andrei Savu added a comment - I have attached a simple patch. $ ./bin/whirr launch-cluster Option 'identity' not set. Usage: whirr launch-cluster [OPTIONS] Option Description ------ ----------- --client-cidrs A comma-separated list of CIDR blocks. E.g. 208.128.0.0/11,108.128.0.0/11 --cluster-name The name of the cluster to operate on. E.g. hadoopcluster. --config <config.properties> Note that Whirr properties specified in this file should all have a whirr. prefix. --credential The cloud credential. --hardware-id The type of hardware to use for the instance. This must be compatible with the image ID. --identity The cloud identity. --image-id The ID of the image to use for instances. If not specified then a vanilla Linux image is chosen. --instance-templates The number of instances to launch for each set of roles. E.g. 1 nn+jt,10 dn+tt means one instance with the roles nn (namenode) and jt (jobtracker), and ten instances each with the roles dn (datanode) and tt (tasktracker). --location-id The location to launch instances in. If not specified then an arbitrary location will be chosen. -- private -key-file The filename of the private RSA key used to connect to instances. --provider The name of the cloud provider. E.g. ec2, cloudservers -- public -key-file The filename of the public key used to connect to instances. --run-url-base The base URL for forming run urls from. Change this to host your own set of launch scripts. --service-name (optional) The name of the service to use. E.g. hadoop. --version

          People

          • Assignee:
            Andrei Savu
            Reporter:
            Andrei Savu
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development