bin/forj in forj-0.0.31 vs bin/forj in forj-0.0.32
- old
+ new
@@ -32,51 +32,50 @@
class Forj < Thor
desc 'help', 'Display forj cli help'
def help
puts 'Forj cli help'
puts ''
- puts ' forj setup # Set the credentials for forj.'
- puts ' required credentials:'
+ puts ' forj setup # Set the credentials for forj. Currently supports only hpcloud provider.'
+ puts ' Several data will be requested like:'
puts ' access_key: access key from hpcloud'
puts ' secret_key: secret key from hpcloud'
puts ' auth_uri: identity endpoint'
puts ' tenant_id: id for the tenant you want to use'
puts ' availability_zone: which availability zone will be deployed'
puts ''
- puts ' forj boot # Boot a new forge with the following options'
- puts ' required:'
- puts ' blueprint: name of the blueprint (currently cli only supports redstone)'
- puts ' on: just to have a natural description'
- puts ' cloud_provider: in which cloud provider to deploy the forge'
- puts ' as: just to have a natural description'
- puts ' name: name of the forge'
- puts ' example:'
- puts ' forj boot redstone on hpcloud as maestro_test'
- puts ' optional:'
+ puts ' forj boot <Blueprint> on <Provider> as <InstanceName> [options] # Boot a new forge with the following options'
+ puts ' where:'
+ puts ' blueprint : Is the name of the blueprint (currently cli only supports redstone)'
+ puts ' Provider : in which cloud provider to deploy the forge'
+ puts ' InstanceName : name of the forge'
+ puts ''
+ puts ' Ex: forj boot redstone on hpcloud as maestro_test'
+ puts ''
+ puts ' [Options] are:'
puts ' -b build: replace the default build.sh'
puts ' -bcd build_config_dir: defines the build configuration directory to load the build configuration file'
puts ' -bc build_config: the build config file to load <confdir>/<BoxName>.<Config>.env.'
puts ' -gb branch: the build will extract from git branch name'
puts ' -tb test_box (not yet implemented): create test-box meta from the repository path provided.'
puts ' -gr git_repo: the box built will use a different git repository sent out to <user_data>'
puts ' -bh boothook: by default, boothook file used is build/bin/build-tools/boothook.sh. Use this option to set another one.'
puts ' -bn box_name: defines the name of the box or box image to build.'
puts ''
- puts ' forj ssh # Connect through ssh to an existing instance'
- puts ' required:'
- puts ' name: name of the forge (maestro_test)'
- puts ' node: name of the node (maestro, ci, etc...)'
+ puts ' forj ssh <Name> <Node> # Connect through ssh to an existing instance'
+ puts ' where'
+ puts ' InstanceName: is the name of the forge (maestro_test)'
+ puts ' Node : is the name of the node (maestro, ci, etc...)'
puts ''
- puts ' forj down # Delete a forge and create a backup of your data'
+ puts ' forj down <InstanceName> # Delete a forge and create a backup of your data'
puts ' not yet implemented'
puts ''
puts ' forj help # Display this help'
end
desc 'boot', 'boot a Maestro box and instruct it to provision the blueprint'
method_option :build, :aliases => '-u', :desc => 'Replace the default build.sh'
- method_option :build_config_dir, :aliases => '-d', :desc => 'Defines the build configuration directory to load the build configuration file. You can set FORJ_BLD_CONF_DIR. By default, it will look in your current directory.'
+ method_option :infra, :aliases => '-I', :desc => 'Defines the Infra directory to load the build configuration file. You can set FORJ_INFRA_DIR. By default, it will look in your current directory.'
method_option :build_config, :aliases => '-c', :desc => 'The build config file to load <confdir>/<BoxName>.<Config>.env. By default, uses "master" as Config.'
method_option :branch, :aliases => '-b', :desc => 'The build will extract from git branch name. It sets the configuration build <config> to the branch name <branch>.'
method_option :test_box, :aliases => '-t', :desc => 'Create test.rb-box meta from the repository path provided.'
method_option :git_repo, :aliases => '-r', :desc => 'The box built will use a different git repository sent out to <user_data>. This repository needs to be read only. No keys are sent.'
method_option :boothook, :aliases => '-h', :desc => 'By default, boothook file used is build/bin/build-tools/boothook.sh. Use this option to set another one.'