corl 0.4.0

data/lib/puppet/parser/functions/global_param.rb

@@ -0,0 +1,43 @@
+#
+# global_param.rb
+#
+# This function performs a lookup for a variable value in various locations
+# following this order
+# - Hiera backend, if present (no prefix)
+# - ::global::default::varname
+# - ::varname
+# - {default parameter}
+#
+module Puppet::Parser::Functions
+  newfunction(:global_param, :type => :rvalue, :doc => <<-EOS
+This function performs a lookup for a variable value in various locations following this order:
+- Hiera backend, if present (no prefix)
+- ::global::default::varname
+- ::varname
+- {default parameter}
+If no value is found in the defined sources, it returns an empty string ('')
+    EOS
+) do |args|
+    
+    value = nil
+    CORL.run do
+      raise(Puppet::ParseError, "global_param(): Define at least the variable name " +
+        "given (#{args.size} for 1)") if args.size < 1
+
+      var_name = args[0]
+      default  = ( args.size > 1 ? args[1] : '' )
+      options  = ( args.size > 2 ? args[2] : {} )
+    
+      config = CORL::Config.init_flat(options, [ :param, :global_param ], {
+        :hiera_scope  => self,
+        :puppet_scope => self,
+        :search       => 'core::default',
+        :init_fact    => 'hiera_ready',
+        :force        => true,
+        :merge        => true
+      })
+      value = CORL::Config.lookup(var_name, default, config)
+    end
+    return value
+  end
+end

data/lib/puppet/parser/functions/interpolate.rb

@@ -0,0 +1,26 @@
+#
+# interpolate.rb
+#
+# Interpolate values from one hash to another for configuration injection.
+#
+module Puppet::Parser::Functions
+  newfunction(:interpolate, :type => :rvalue, :doc => <<-EOS
+This function interpolates values from one hash to another for configuration injections.
+    EOS
+) do |args|
+    
+    value = nil
+    CORL.run do
+      raise(Puppet::ParseError, "interpolate(): Define at least a property name with optional source configurations " +
+        "given (#{args.size} for 2)") if args.size < 1
+      
+      value   = args[0]
+      data    = ( args.size > 1 ? args[1] : {} )
+      options = ( args.size > 2 ? args[2] : {} )
+      
+      config = CORL::Config.init_flat(options, [ :data, :interpolate ])
+      value  = CORL::Util::Data.interpolate(value, data, config.options)
+    end
+    return value
+  end
+end

data/lib/puppet/parser/functions/is_false.rb

@@ -0,0 +1,21 @@
+#
+# is_false.rb
+#
+# Checks whether a given string or boolean value is false.
+#
+module Puppet::Parser::Functions
+  newfunction(:is_false, :type => :rvalue, :doc => <<-EOS
+This function checks whether a given value is false.
+    EOS
+) do |args|
+    
+    value = nil
+    CORL.run do
+      raise(Puppet::ParseError, "is_false(): Must have a value to check; " +
+        "given (#{args.size} for 1)") if args.size < 1
+      
+      value = CORL::Util::Data.false?(args[0])
+    end
+    return value
+  end
+end

data/lib/puppet/parser/functions/is_true.rb

@@ -0,0 +1,21 @@
+#
+# is_true.rb
+#
+# Checks whether a given string or boolean value is true.
+#
+module Puppet::Parser::Functions
+  newfunction(:is_true, :type => :rvalue, :doc => <<-EOS
+This function checks whether a given value is true.
+    EOS
+) do |args|
+    
+    value = nil
+    CORL.run do
+      raise(Puppet::ParseError, "is_true(): Must have a value to check; " +
+        "given (#{args.size} for 1)") if args.size < 1
+      
+      value = CORL::Util::Data.true?(args[0])
+    end
+    return value
+  end
+end

data/lib/puppet/parser/functions/module_array.rb

@@ -0,0 +1,38 @@
+#
+# module_array.rb
+#
+module Puppet::Parser::Functions
+  newfunction(:module_array, :type => :rvalue, :doc => <<-EOS
+This function performs a lookup for a variable value in various locations:
+See: module_params()
+If no value is found in the defined sources, it returns an empty array ([])
+    EOS
+) do |args|
+    
+    value = nil
+    CORL.run do
+      raise(Puppet::ParseError, "module_array(): Define at least the variable name " +
+        "given (#{args.size} for 1)") if args.size < 1
+
+      var_name      = args[0]
+      default_value = ( args.size > 1 ? args[1] : [] )
+      options       = ( args.size > 2 ? args[2] : {} )
+
+      module_name      = self.source.module_name
+      module_var_name  = "#{module_name}::#{var_name}"
+      default_var_name = "#{module_name}::default::#{var_name}"
+      
+      config = CORL::Config.init(options, [ :param, :module_array ], module_name, {
+        :hiera_scope  => self,
+        :puppet_scope => self,
+        :search       => 'core::default',
+        :search_name  => false,
+        :init_fact    => 'hiera_ready',
+        :force        => true,
+        :merge        => true
+      })
+      value = CORL::Config.lookup_array([ module_var_name, default_var_name ], default, config)
+    end
+    return value
+  end
+end

data/lib/puppet/parser/functions/module_hash.rb

@@ -0,0 +1,38 @@
+#
+# module_hash.rb
+#
+module Puppet::Parser::Functions
+  newfunction(:module_hash, :type => :rvalue, :doc => <<-EOS
+This function performs a lookup for a variable value in various locations:
+See: module_params()
+If no value is found in the defined sources, it returns an empty hash ({})
+    EOS
+) do |args|
+    
+    value = nil
+    CORL.run do
+      raise(Puppet::ParseError, "module_hash(): Define at least the variable name " +
+        "given (#{args.size} for 1)") if args.size < 1
+
+      var_name      = args[0]
+      default_value = ( args.size > 1 ? args[1] : {} )
+      options       = ( args.size > 2 ? args[2] : {} )
+    
+      module_name      = self.source.module_name
+      module_var_name  = "#{module_name}::#{var_name}"
+      default_var_name = "#{module_name}::default::#{var_name}"
+      
+      config = CORL::Config.init(options, [ :param, :module_hash ], module_name, {
+        :hiera_scope  => self,
+        :puppet_scope => self,
+        :search       => 'core::default',
+        :search_name  => false,
+        :init_fact    => 'hiera_ready',
+        :force        => true,
+        :merge        => true
+      })
+      value = CORL::Config.lookup_hash([ module_var_name, default_var_name ], default, config)
+    end
+    return value
+  end
+end

data/lib/puppet/parser/functions/module_options.rb

@@ -0,0 +1,23 @@
+#
+# module_options.rb
+#
+# This function sets module level default options for other functions.
+#
+module Puppet::Parser::Functions
+  newfunction(:module_options, :doc => <<-EOS
+This function sets module level default options for other functions:
+EOS
+) do |args|
+    
+    CORL.run do
+      raise(Puppet::ParseError, "module_options(): Define a context name and at least one option name/value pair: " +
+        "given (#{args.size} for 2)") if args.size < 2
+
+      contexts = args[0]
+      options  = args[1]
+      force    = ( args[2] ? true : false )
+      
+      CORL::Config.set_options(CORL::Util::Data.prefix(self.source.module_name, contexts), options, force)
+    end
+  end
+end

data/lib/puppet/parser/functions/module_param.rb

@@ -0,0 +1,48 @@
+#
+# module_param.rb
+#
+# This function performs a lookup for a variable value in various locations
+# following this order
+# - Hiera backend, if present (modulename prefix)
+# - ::corl::default::{modulename}::{varname} (configurable!!)
+# - ::{modulename}::default::{varname}
+# - {default parameter}
+#
+module Puppet::Parser::Functions
+  newfunction(:module_param, :type => :rvalue, :doc => <<-EOS
+This function performs a lookup for a variable value in various locations following this order:
+- Hiera backend, if present (modulename prefix)
+- ::data::default::{modulename}_{varname} (configurable!!)
+- ::{modulename}::default::{varname}
+- {default parameter}
+If no value is found in the defined sources, it returns an empty string ('')
+    EOS
+) do |args|
+    
+    value = nil
+    CORL.run do
+      raise(Puppet::ParseError, "module_param(): Define at least the variable name " +
+        "given (#{args.size} for 1)") if args.size < 1
+      
+      var_name = args[0]
+      default  = ( args.size > 1 ? args[1] : '' )
+      options  = ( args.size > 2 ? args[2] : {} )
+    
+      module_name      = self.source.module_name
+      module_var_name  = "#{module_name}::#{var_name}"
+      default_var_name = "#{module_name}::default::#{var_name}"
+      
+      config = CORL::Config.init(options, [ :param, :module_param ], module_name, {
+        :hiera_scope  => self,
+        :puppet_scope => self,
+        :search       => 'core::default',
+        :search_name  => false,
+        :init_fact    => 'hiera_ready',
+        :force        => true,
+        :merge        => true
+      })
+      value = CORL::Config.lookup([ module_var_name, default_var_name ], default, config)
+    end
+    return value
+  end
+end

data/lib/puppet/parser/functions/name.rb

@@ -0,0 +1,21 @@
+#
+# name.rb
+#
+# Returns a standardized form of a given resource name.
+#
+module Puppet::Parser::Functions
+  newfunction(:name, :type => :rvalue, :doc => <<-EOS
+This function returns a standardized form of a given resource name.
+    EOS
+) do |args|
+    
+    name = nil
+    CORL.run do
+      raise(Puppet::ParseError, "name(): Must have a resource name specified; " +
+        "given (#{args.size} for 1)") if args.size < 1
+      
+      name = CORL.provisioner(:puppet).to_name(args[0])
+    end
+    return name
+  end
+end

data/lib/puppet/parser/functions/render.rb

@@ -0,0 +1,33 @@
+#
+# render.rb
+#
+# Returns the string-ified form of a given value or set of values.
+#
+module Puppet::Parser::Functions
+  newfunction(:render, :type => :rvalue, :doc => <<-EOS
+This function returns the string-ified form of a given value.
+    EOS
+) do |args|
+    
+    value = nil
+    CORL.run do
+      raise(Puppet::ParseError, "render(): Must have a template class name and an optional source value specified; " +
+        "given (#{args.size} for 2)") if args.size < 1
+    
+      class_name = args[0]  
+      data       = ( args.size > 1 ? args[1] : {} )
+      options    = ( args.size > 2 ? args[2] : {} )
+    
+      config = CORL::Config.init_flat(options, [ :data, :render ], {
+        :hiera_scope  => self,
+        :puppet_scope => self,
+        :search       => 'core::default',
+        :init_fact    => 'hiera_ready',
+        :force        => true,
+        :merge        => true
+      })
+      value = CORL.template(class_name, config).render(data)
+    end
+    return value
+  end
+end

data/lib/puppet/parser/functions/value.rb

@@ -0,0 +1,21 @@
+#
+# value.rb
+#
+# Returns the internal form of a given value.
+#
+module Puppet::Parser::Functions
+  newfunction(:value, :type => :rvalue, :doc => <<-EOS
+This function returns the internal form of a given value.
+    EOS
+) do |args|
+    
+    value = nil
+    CORL.run do
+      raise(Puppet::ParseError, "value(): Must have a source value specified; " +
+        "given (#{args.size} for 1)") if args.size < 1
+      
+      value = CORL::Util::Data.value(args[0])
+    end
+    return value
+  end
+end

data/locales/en.yml

@@ -0,0 +1,232 @@
+en:
+  corl:
+    errors:
+      batch_error: |-
+        An issue was encountered during batch processing
+    core:
+      util:
+        cli:
+          options:
+            help: |-
+              Display help information for this command
+            log_level: |-
+              Set the logging level for this execution run
+            encoded: |-
+              Optional encoded parameter set that contains default action settings (machine use only)
+          parse:
+            error: |-
+              There was a problem with the command arguments given
+        batch:
+          unexpected_error: |
+            There was a problem with batch %{process}: %{message}
+          corl_error: |
+            There was a problem with batch %{process}: %{message}
+      mixins:
+        project:
+          options:
+            provider: |-
+              CORL plugin provider to use for this project (default %{default_value})
+            reference: |-
+              Project URL or reference string to set as primary remote (default %{default_value})
+            revision: |-
+              Revision or branch to load (default %{default_value})
+        commit:
+          options:
+            commit: |-
+              Commit any uncommitted changes (default %{default_value})
+            empty: |-
+              Allow commits with no changes (default %{default_value})
+            message: |-
+              Commit message (defaults to auto generated commit information)
+            author: |-
+              Author of the changes being committed if different from the committer
+            propogate: |-
+              Propogate commits throughout the project tree (default %{default_value})
+        push:
+          options:
+            push: |-
+              Push changes to remote server (default %{default_value})
+            propogate: |-
+              Propogate pushes to the remote throughout the project tree (default %{default_value})
+            remote: |-
+              Remote name to push to (default %{default_value})
+            revision: |-
+              Branch to push (default %{default_value})
+        node:
+          options:
+            parallel: |-
+              Enable parallelism of node action execution (default %{default_value})
+            net_provider: |-
+              CORL network provider to use for managing cloud nodes (default %{default_value})
+            node_provider: |-
+              Default to using a specific node provider but individual node references can override (default %{default_value})
+            nodes: |-
+              Optional nodes on which to execute this action
+          errors:
+            network_provider: |-
+              Network plugin provider %{value} is not loaded >> Pick from the following: %{choices}
+            node_provider: |-
+              Node plugin provider %{value} is not loaded >> Pick from the following: %{choices}
+            nodes: |-
+              Node reference %{value} failed to parse or provider %{provider} isn't loaded (%{name})
+        keypair:
+          options:
+            private_key: |-
+              Optional existing private SSH key to use for SSH communication (new keys are generated by default)
+            require_password: |-
+              Require and prompt for a password for generated keys (default %{default_value})
+            key_type: |-
+              Type of SSH key to generate (default %{default_value})
+            key_bits: |-
+              Strength of generated key encryption in bits (default %{default_value})
+            key_comment: |-
+              Optional key comment (attached at the end of the public key)
+          errors:
+            private_key_not_found: |-
+              Private key %{value} not found
+            private_key_parse_error: |-
+              Private key %{value} failed to parse and can not be accepted as a valid private SSH key
+            key_type: |-
+              SSH key type %{value} not supported >> Pick from the following: %{choices}
+            key_bits: |-
+              Encryption strength must be greater than %{required} bits (%{value} specified)
+            no_password: |-
+              Password verification of private key was terminated (verification required to use encrypted SSH keys)             
+      exec:
+        help:
+          usage: |-
+            Usage
+          header: |-
+            Available actions
+          footer: |-
+            For help on any individual action run `corl <action> -h`
+        errors:
+          missing_argument: |-
+            Argument <%{name}> must be specified
+    actions:
+      extract:
+        options:
+          path: |-
+            Base path in which to extract the encoded data
+          encoded: |-
+            Encoded data to be extracted into the base path
+        errors:
+          path: |-
+            "Base path for extracted files must be an existing directory"
+          encoded: |-
+            "Data is either not properly encoded or is empty %{value}"
+      create:
+        options:
+          reference: |-
+            Git repository URL of CORL cloud to start project from (default %{default_value})
+          revision: |-
+            Revision or branch to initialize the project with (default %{default_value})
+          path: |-
+            Project path (default %{default_value})
+          start: |-
+            Creating a new CORL cloud at %{path} from %{reference}
+      add:
+        options:
+          sub_reference: |-
+            Repository URL of CORL component (module or library) to include in the project
+          sub_path: |-
+            Subproject path
+          editable: |-
+            Whether or not this sub project should be added as an editable remote (default %{default_value})
+        start: |-
+          Adding new subproject from %{sub_reference} at %{sub_path}
+      remove:
+        options:
+          sub_path: |-
+            Subproject path
+        start: |-
+          Removing existing subproject at %{sub_path}
+      update:
+        start: |-
+          Starting update run from provider %{project_provider} (ref: %{reference} rev: %{revision})
+        provision: |-
+          Running provisioning updates on %{node_name} from node provider %{node_provider}
+      save:
+        options:
+          files: |-
+            Optional space separated list of files to save
+        start: |-
+          Saving project changes with provider %{project_provider} (ref: %{reference} rev: %{revision})
+      images:
+        options:
+          match_case: |-
+            Match case on any search terms given when searching for images (default %{default_value})
+          require_all: |-
+            Require all search terms to be present in image descriptions to be included (default %{default_value})
+          provider: |-
+            Node provider to retrieve images for
+          search: |-
+            Optional array of search terms to filter image results
+        start: |-
+          Retrieving a list of defined images from %{node_provider}
+        results: |-
+          Total of %{images} images found
+      machines:
+        options:
+          node_provider: |-
+            Node provider to retrieve machine types
+        start: |-
+          Retrieving a list of available machines from %{node_provider}
+        results: |-
+          Total of %{machines} machine types found
+      spawn:
+        options:
+          parallel: |-
+            Enable or disable parallelism of node creation (default %{default_value})
+          seed: |-
+            CORL project reference with cloud project to seed new machines with (default %{default_value})
+          region: |-
+            Machine provider region in which to create the machines (defaults to first defined in provider)
+          machine_type: |-
+            Provider ID of machine type to create (defaults to first defined in provider - usually smallest)
+          provider: |-
+            Create machines with this node provider
+          image: |-
+            Provider ID of operating system image on which to initialize the new machines           
+          hostnames: |-
+            Hostnames of machines to create on provider infrastructure
+        start: |-
+          Spawning new machines on %{provider}
+      bootstrap:
+        options:
+          bootstrap_path: |-
+            Bootstrap script top level local directory (default %{default_value})
+          bootstrap_init: |-
+            Gateway bootstrap script within the bootstrap project directory (default %{default_value})
+          bootstrap_glob: |-
+            Path glob to use in searching bootstrap scripts for remote execution (default %{default_value})
+          auth_files: |-
+            Any additional authorization or state files to pass to the node during bootstrap (relative to local home)
+          home_env_var: |-
+            Home directory environment variable on remote server (default %{default_value})
+          home: |-
+            Specified home directory on remote server (default %{default_value})
+          bootstrap_nodes: |-
+            Node references to bootstrap
+        errors:
+          bootstrap_path: |-
+            Bootstrap path must be an existing directory
+          auth_files: |-
+            Authorization file %{value} does not exist on the local system
+          bootstrap_nodes: |-
+            Provider %{node_provider} node %{name} is not a valid node to bootstrap (%{value} given)
+        start: |-
+          Starting bootstrap of machine %{hostname} (%{id})
+        success: |-
+          Machine %{hostname} (%{id}) successfully bootstrapped
+      exec:
+        options:
+          command: |-
+            Command line executable and arguments to execute on machine
+      seed:
+        options:
+          home: |-
+            Home directory in which to initialize the deploy SSH keys (default %default_value})
+        errors:
+          project_reference: |-
+            Project reference %{value} failed to parse or provider %{provider} isn't loaded >> Possible providers: %{choices}