hammer_cli_foreman 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3108251968e9b35a4e1a1ee37bf744bb08f1e383
-  data.tar.gz: 48d434939e0033fe7d593dd21eb03b168f33dfba
+  metadata.gz: 42450c6d2fad76c1f31ea6a860406c4a6511ccd8
+  data.tar.gz: d6b26b6896df8cd1db9b2f4e8d3f5a037d145167
 SHA512:
-  metadata.gz: c4e6d4167fc2916eb970123f97bd41f62eb0751c929b2392d448ab324fef651cbcbfb4ff7f54847be4c44716941d66bafd44a7e627f29a2fcf8438a32eb5f98a
-  data.tar.gz: 7a13a75d06913975322d17dca8411c70401571eede40e84fc00f01630391a24af8aba1ce26fc4ed5959ada591037ccd5edf4f466db4f7ba94b981cf78133a34e
+  metadata.gz: fa6ed7e0730233e68b0ee1c4894905a34b6352a9225f73536830ab993dfc9606454339e70173cbb20f122c0b258e2dde6b0e39a173df7f5b92e1c1435433378c
+  data.tar.gz: 34c6dc5106bf9d507927600b20c778e6272cf4a24d15eda085b25ac5aedfd6eb0b0d7891aaf5fea92fd482525a2da145e5c9c690417be3797c96111db85a8211

data/README.md

@@ -0,0 +1,27 @@
+Foreman commands for Hammer CLI
+===============================
+
+This Hammer CLI plugin contains set of commands for [Foreman](http://theforeman.org/).
+
+
+Documentation
+-------------
+
+ - [Host creation](doc/host_create.md#host-creation)
+
+How to run
+----------
+
+The work is still in progress and there are no builds ready yet. You can install the plugin from source.
+See [Hammer CLI readme](https://github.com/theforeman/hammer-cli/blob/master/README.md#how-to-run) for details.
+
+
+How to test
+------------
+
+    $ bundle install
+    $ bundle exec "rake test"
+
+Generated coverage reports are stored in ./coverage directory.
+
+

data/doc/host_create.md

@@ -0,0 +1,190 @@
+Host Creation
+=============
+
+Host creation is one of the most complex commands in the hammer's foreman plugin. The majority of its parameters
+is obvious but there are some that need further explanation as their values differ with the type of a compute resource.
+
+```
+$ hammer host create -h
+Usage:
+    hammer host create [OPTIONS]
+
+Options:
+    --name NAME
+    --ip IP                       Not required if using a subnet with dhcp proxy.
+    --mac MAC                     Not required if it's a virtual machine.
+    --puppet-class-ids PUPPET_CLASS_IDS Comma separated list of values.
+    --medium-id MEDIUM_ID
+    --subnet-id SUBNET_ID
+    --sp-subnet-id SP_SUBNET_ID
+    --model-id MODEL_ID
+    --hostgroup-id HOSTGROUP_ID
+    --owner-id OWNER_ID
+    --puppet-ca-proxy-id PUPPET_CA_PROXY_ID
+    --security-groups SECURITY_GROUPS
+    --environment-id ENVIRONMENT_ID
+    --architecture-id ARCHITECTURE_ID
+    --domain-id DOMAIN_ID
+    --puppet-proxy-id PUPPET_PROXY_ID
+    --operatingsystem-id OPERATINGSYSTEM_ID
+    --partition-table-id PARTITION_TABLE_ID
+    --compute-resource-id COMPUTE_RESOURCE
+    --partition-table-id PARTITION_TABLE
+    --build BUILD                 One of true/false, yes/no, 1/0.
+                                  Default: "true"
+    --managed MANAGED             One of true/false, yes/no, 1/0.
+                                  Default: "true"
+    --enabled ENABLED             One of true/false, yes/no, 1/0.
+                                  Default: "true"
+    --parameters PARAMS           Host parameters.
+                                  Comma-separated list of key=value.
+    --compute-attributes COMPUTE_ATTRS Compute resource attributes.
+                                  Comma-separated list of key=value.
+    --volume VOLUME               Volume parameters
+                                  Comma-separated list of key=value.
+                                  Can be specified multiple times.
+    --interface INTERFACE         Interface parameters.
+                                  Comma-separated list of key=value.
+                                  Can be specified multiple times.
+    -h, --help                    print help
+```
+
+Example
+=======
+
+An example command for creating a host with 2 volumes (5GB raw + 10 GB qcow2) using
+a default network interface on a libvirt provider can look like this:
+```bash
+hammer host create
+  --hostgroup-id=4                           # most of the settings is done in the hostgroup
+  --compute-resource-id=1                    # set the libvirt provider
+  --compute-attributes="cpus=2"              # specify the provider specific options, see the list below
+  --interface="type=network,network=default" # add a network interface, can be passed multiple times
+  --volume="capacity=5G"                     # add a volume, can be passed multiple times
+  --volume="capacity=10G,format_type=qcow2"  # add another volume with different size and type
+  --name="test-host"
+  --ip="1.2.3.4"
+```
+
+See the list of all possible option keys below.
+
+
+Provider specific options
+=========================
+
+## Bare Metal
+Available keys for `--interface`:
+```
+type       # one of Nic::Managed, Nic::BMC
+mac
+name
+domain_id
+subnet_id
+ip
+provider   # always IPMI
+username   # BMC only
+password   # BMC only
+```
+
+## EC2
+Available keys for `--compute-attributes`:
+```
+flavor_id          # select one of available flavours
+image_id           # select one of available images
+availability_zone
+security_group_ids
+managed_ip
+```
+
+## GCE
+Available keys for `--compute-attributes`:
+```
+machine_type # one of available flavors
+image_id
+network
+external_ip
+```
+
+## Libvirt
+Available keys for `--compute-attributes`:
+```
+cpus          # number of CPUs
+memory        # string, amount of memory, value in bytes
+start         # boolean, whether to start the machine or not
+```
+
+Available keys for `--interface`:
+```
+type              # one of [:bridge, :network]
+network / :bridge # name of interface according to type
+model             # one of [virtio, rtl8139, ne2k_pci, pcnet, e1000]
+```
+
+Available keys for `--volume`:
+```
+pool_name   # list of available storage pools
+capacity    # string value, eg. 10G
+format_type # one of [raw, qcow2]
+```
+
+## OpenStack
+Available keys for `--compute-attributes`:
+```
+flavor_ref
+image_ref
+tenant_id
+security_groups
+network
+```
+
+## oVirt
+Available keys for `--compute-attributes`:
+```
+cluster
+template   # hardware profile to use
+cores      # int value, number of cores
+memory     # amount of memory, int value in bytes
+start      # boolean, whether to start the machine or not
+```
+
+Available keys for `--interface`:
+```
+name         # eg. eth0
+network      # select one of available networks for a cluster
+```
+
+Available keys for `--volume`:
+```
+size_gb          # volume size in GB, integer value
+storage_domain   # select one of available storage domains
+bootable         # boolean, only one volume can be bootable
+```
+
+## Rackspace
+Available keys for `--compute-attributes`:
+```
+flavor_id
+image_id
+```
+
+## vmWare
+Available keys for `--compute-attributes`:
+```
+cpus       # cpu count
+memory_mb  # integer number
+cluster
+path
+```
+
+Available keys for `--interface`:
+```
+network
+```
+
+Available keys for `--volume`:
+```
+datastore
+name
+size_gb    # integer number
+```
+

data/lib/hammer_cli_foreman.rb

@@ -28,6 +28,7 @@ module HammerCLIForeman
   require 'hammer_cli_foreman/report'
   require 'hammer_cli_foreman/puppet_class'
   require 'hammer_cli_foreman/smart_proxy'
+  require 'hammer_cli_foreman/smart_class_parameter'
   require 'hammer_cli_foreman/subnet'
   require 'hammer_cli_foreman/template'
   require 'hammer_cli_foreman/user'

data/lib/hammer_cli_foreman/commands.rb

@@ -2,6 +2,20 @@ require 'hammer_cli'
 
 module HammerCLIForeman
 
+  class WriteCommand < HammerCLI::Apipie::WriteCommand
+
+    def success_message_params(response)
+      if response
+        if response.is_a?(Hash) and !response.empty?
+          response[response.keys[0]]
+        else
+          response
+        end
+      end
+    end
+
+  end
+
   class ListCommand < HammerCLI::Apipie::ReadCommand
 
     action :index
@@ -19,7 +33,7 @@ module HammerCLIForeman
 
   class InfoCommand < HammerCLI::Apipie::ReadCommand
 
-   action :show
+    action :show
 
     def self.command_name(name=nil)
       super(name) || "info"
@@ -38,7 +52,7 @@ module HammerCLIForeman
   end
 
 
-  class CreateCommand < HammerCLI::Apipie::WriteCommand
+  class CreateCommand < WriteCommand
 
     action :create
 
@@ -49,7 +63,7 @@ module HammerCLIForeman
   end
 
 
-  class UpdateCommand < HammerCLI::Apipie::WriteCommand
+  class UpdateCommand < WriteCommand
 
     action :update
 
@@ -77,7 +91,7 @@ module HammerCLIForeman
   end
 
 
-  class DeleteCommand < HammerCLI::Apipie::WriteCommand
+  class DeleteCommand < WriteCommand
 
     action :destroy
 
@@ -98,7 +112,7 @@ module HammerCLIForeman
   end
 
 
-  class AssociatedCommand < HammerCLI::Apipie::WriteCommand
+  class AssociatedCommand < WriteCommand
 
     identifiers :name, :id
     action :update
@@ -175,7 +189,7 @@ module HammerCLIForeman
   class AddAssociatedCommand < AssociatedCommand
 
     def self.command_name(name=nil)
-      super(name) || "add_"+associated_resource.name
+      super(name) || (associated_resource ? "add_"+associated_resource.name : nil)
     end
 
     def self.desc(desc=nil)
@@ -195,7 +209,7 @@ module HammerCLIForeman
   class RemoveAssociatedCommand < AssociatedCommand
 
     def self.command_name(name=nil)
-      super(name) || "remove_"+associated_resource.name
+      super(name) || (associated_resource ? "remove_"+associated_resource.name : nil)
     end
 
     def self.desc(desc=nil)

data/lib/hammer_cli_foreman/common_parameter.rb

@@ -19,36 +19,30 @@ module HammerCLIForeman
       apipie_options
     end
 
-    class SetCommand < HammerCLI::Apipie::WriteCommand
+    class SetCommand < HammerCLIForeman::WriteCommand
 
       command_name "set"
       desc "Set a global parameter."
 
+      success_message_for :create, "Created parameter [%{name}s] with value [%{value}s]."
+      success_message_for :update, "Parameter [%{name}s] updated to [%{value}s]."
+
       resource ForemanApi::Resources::CommonParameter
 
       option "--name", "NAME", "parameter name", :required => true
       option "--value", "VALUE", "parameter value", :required => true
 
-      def execute
-        if parameter_exist?
-          self.class.action :update
-        else
-          self.class.action :create
-        end
-        super
+      def action
+        @action ||= parameter_exist? ? :update : :create
+        @action
       end
 
-      def print_message
-        if self.class.action == :create
-          msg = "Global parameter created"
-        else
-          msg = "Global parameter updated"
-        end
-        print_message msg
+      def success_message
+        success_message_for(action)
       end
 
       def parameter_exist?
-        params = resource.index(resource_config)[0]
+        params = resource.call(:index)[0]
         params.find { |p| p["common_parameter"]["name"] == name }
       end
 
@@ -65,8 +59,8 @@ module HammerCLIForeman
 
       identifiers :name
 
-      success_message "Global parameter deleted"
-      failure_message "Could not delete the global parameter"
+      success_message "Global parameter [%{name}s] deleted."
+      failure_message "Could not delete the global parameter [%{name}s]"
       resource ForemanApi::Resources::CommonParameter, "destroy"
 
       apipie_options :without => :id

data/lib/hammer_cli_foreman/domain.rb

@@ -32,7 +32,7 @@ module HammerCLIForeman
 
       output ListCommand.output_definition do
         from "domain" do
-          field :fullname, "Full Name"
+          field :fullname, "Description"
           field :dns_id, "DNS Id"
           field :created_at, "Created at", Fields::Date
           field :updated_at, "Updated at", Fields::Date
@@ -47,27 +47,29 @@ module HammerCLIForeman
 
     class CreateCommand < HammerCLIForeman::CreateCommand
 
-      success_message "Domain created"
+      success_message "Domain [%{name}s] created"
       failure_message "Could not create the domain"
       resource ForemanApi::Resources::Domain, "create"
 
-      apipie_options :without => ['domain_parameters_attributes']
+      apipie_options :without => [:domain_parameters_attributes, :fullname]
+      option "--description", "DESC", "Full name describing the domain", :attribute_name => :fullname
     end
 
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
 
-      success_message "Domain updated"
+      success_message "Domain [%{name}s] updated"
       failure_message "Could not update the domain"
       resource ForemanApi::Resources::Domain, "update"
 
-      apipie_options :without => ['domain_parameters_attributes', 'name', 'id']
+      apipie_options :without => [:domain_parameters_attributes, :name, :id, :fullname]
+      option "--description", "DESC", "Full name describing the domain", :attribute_name => :fullname
     end
 
 
     class DeleteCommand < HammerCLIForeman::DeleteCommand
 
-      success_message "Domain deleted"
+      success_message "Domain [%{name}s] deleted"
       failure_message "Could not delete the domain"
       resource ForemanApi::Resources::Domain, "destroy"
 

data/lib/hammer_cli_foreman/environment.rb

@@ -1,5 +1,7 @@
 require 'hammer_cli'
 require 'foreman_api'
+require 'hammer_cli_foreman/smart_class_parameter'
+
 
 module HammerCLIForeman
 
@@ -61,6 +63,14 @@ module HammerCLIForeman
       apipie_options
     end
 
+    class SCParamsCommand < HammerCLIForeman::SmartClassParametersList
+
+      apipie_options :without => [:host_id, :hostgroup_id, :puppetclass_id, :environment_id]
+      option ['--id', '--name'], 'ENVIRONMENT_ID', 'environment id/name', 
+            :required => true, :attribute_name => :environment_id 
+    end
+
+
     autoload_subcommands
   end