Class BoxGrinder::VMwarePlugin
In: lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb
lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb
Parent: BasePlugin

Methods

Public Instance methods

[Source]

    # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 23
23:     def after_init
24:       set_default_config_value('thin_disk', false)
25:       validate_plugin_config(['type'], 'http://boxgrinder.org/tutorials/boxgrinder-build-plugins/#VMware_Platform_Plugin')
26: 
27:       register_deliverable(:vmx    => "#{@appliance_config.name}.vmx",
28:                            :readme => "README")
29: 
30:       if @plugin_config['type'].eql?('personal') and @plugin_config['thin_disk']
31:         register_deliverable(:disk => "#{@appliance_config.name}.vmdk")
32:       else
33:         register_deliverable(:disk => "#{@appliance_config.name}.raw",
34:                              :vmdk => "#{@appliance_config.name}.vmdk")
35:       end
36:     end

[Source]

    # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 23
23:     def after_init
24:       set_default_config_value('thin_disk', false)
25:       validate_plugin_config(['type'], 'http://boxgrinder.org/tutorials/boxgrinder-build-plugins/#VMware_Platform_Plugin')
26: 
27:       register_deliverable(:vmx    => "#{@appliance_config.name}.vmx",
28:                            :readme => "README")
29: 
30:       if @plugin_config['type'].eql?('personal') and @plugin_config['thin_disk']
31:         register_deliverable(:disk => "#{@appliance_config.name}.vmdk")
32:       else
33:         register_deliverable(:disk => "#{@appliance_config.name}.raw",
34:                              :vmdk => "#{@appliance_config.name}.vmdk")
35:       end
36:     end

[Source]

     # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 169
169:     def build_vmware_enterprise
170:       @log.debug "Building VMware enterprise image."
171: 
172:       copy_raw_image
173: 
174:       # defaults for ESXi (maybe for others too)
175:       @appliance_config.hardware.network = "VM Network" if @appliance_config.hardware.network.eql?("NAT")
176: 
177:       # create .vmx file
178:       vmx_data = change_common_vmx_values
179:       vmx_data += "ethernet0.networkName = \"#{@appliance_config.hardware.network}\""
180: 
181:       File.open(@deliverables.vmx, "w") { |f| f.write(vmx_data) }
182: 
183:       # create disk descriptor file
184:       File.open(@deliverables.vmdk, "w") { |f| f.write(change_vmdk_values("vmfs")) }
185: 
186:       @log.debug "VMware enterprise image was built."
187:     end

[Source]

     # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 169
169:     def build_vmware_enterprise
170:       @log.debug "Building VMware enterprise image."
171: 
172:       copy_raw_image
173: 
174:       # defaults for ESXi (maybe for others too)
175:       @appliance_config.hardware.network = "VM Network" if @appliance_config.hardware.network.eql?("NAT")
176: 
177:       # create .vmx file
178:       vmx_data = change_common_vmx_values
179:       vmx_data += "ethernet0.networkName = \"#{@appliance_config.hardware.network}\""
180: 
181:       File.open(@deliverables.vmx, "w") { |f| f.write(vmx_data) }
182: 
183:       # create disk descriptor file
184:       File.open(@deliverables.vmdk, "w") { |f| f.write(change_vmdk_values("vmfs")) }
185: 
186:       @log.debug "VMware enterprise image was built."
187:     end

[Source]

     # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 149
149:     def build_vmware_personal
150:       @log.debug "Building VMware personal image."
151: 
152:       if @plugin_config['thin_disk']
153:         @log.debug "Using qemu-img to convert the image..."
154:         @image_helper.convert_disk(@previous_deliverables.disk, :vmdk, @deliverables.disk)
155:         @log.debug "Conversion done."
156:       else
157:         copy_raw_image
158: 
159:         # create disk descriptor file
160:         File.open(@deliverables.vmdk, "w") { |f| f.write(change_vmdk_values("monolithicFlat")) }
161:       end
162: 
163:       # create .vmx file
164:       File.open(@deliverables.vmx, "w") { |f| f.write(change_common_vmx_values) }
165: 
166:       @log.debug "VMware personal image was built."
167:     end

[Source]

     # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 149
149:     def build_vmware_personal
150:       @log.debug "Building VMware personal image."
151: 
152:       if @plugin_config['thin_disk']
153:         @log.debug "Using qemu-img to convert the image..."
154:         @image_helper.convert_disk(@previous_deliverables.disk, :vmdk, @deliverables.disk)
155:         @log.debug "Conversion done."
156:       else
157:         copy_raw_image
158: 
159:         # create disk descriptor file
160:         File.open(@deliverables.vmdk, "w") { |f| f.write(change_vmdk_values("monolithicFlat")) }
161:       end
162: 
163:       # create .vmx file
164:       File.open(@deliverables.vmx, "w") { |f| f.write(change_common_vmx_values) }
165: 
166:       @log.debug "VMware personal image was built."
167:     end

[Source]

     # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 109
109:     def change_common_vmx_values
110:       vmx_data = File.open("#{File.dirname(__FILE__)}/src/base.vmx").read
111: 
112:       # replace version with current appliance version
113:       vmx_data.gsub!(/#VERSION#/, "#{@appliance_config.version}.#{@appliance_config.release}")
114:       # change name
115:       vmx_data.gsub!(/#NAME#/, @appliance_config.name.to_s)
116:       # and summary
117:       vmx_data.gsub!(/#SUMMARY#/, @appliance_config.summary.to_s)
118:       # replace guestOS informations to: linux or otherlinux-64, this seems to be the savests values
119:       vmx_data.gsub!(/#GUESTOS#/, "#{@appliance_config.hardware.arch == "x86_64" ? "otherlinux-64" : "linux"}")
120:       # memory size
121:       vmx_data.gsub!(/#MEM_SIZE#/, @appliance_config.hardware.memory.to_s)
122:       # memory size
123:       vmx_data.gsub!(/#VCPU#/, @appliance_config.hardware.cpus.to_s)
124:       # network name
125:       # vmx_data.gsub!( /#NETWORK_NAME#/, @image_config.network_name )
126: 
127:       vmx_data
128:     end

[Source]

     # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 109
109:     def change_common_vmx_values
110:       vmx_data = File.open("#{File.dirname(__FILE__)}/src/base.vmx").read
111: 
112:       # replace version with current appliance version
113:       vmx_data.gsub!(/#VERSION#/, "#{@appliance_config.version}.#{@appliance_config.release}")
114:       # change name
115:       vmx_data.gsub!(/#NAME#/, @appliance_config.name.to_s)
116:       # and summary
117:       vmx_data.gsub!(/#SUMMARY#/, @appliance_config.summary.to_s)
118:       # replace guestOS informations to: linux or otherlinux-64, this seems to be the savests values
119:       vmx_data.gsub!(/#GUESTOS#/, "#{@appliance_config.hardware.arch == "x86_64" ? "otherlinux-64" : "linux"}")
120:       # memory size
121:       vmx_data.gsub!(/#MEM_SIZE#/, @appliance_config.hardware.memory.to_s)
122:       # memory size
123:       vmx_data.gsub!(/#VCPU#/, @appliance_config.hardware.cpus.to_s)
124:       # network name
125:       # vmx_data.gsub!( /#NETWORK_NAME#/, @image_config.network_name )
126: 
127:       vmx_data
128:     end

[Source]

     # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 88
 88:     def change_vmdk_values(type)
 89:       vmdk_data = File.open("#{File.dirname(__FILE__)}/src/base.vmdk").read
 90: 
 91:       c, h, s, total_sectors = generate_scsi_chs
 92: 
 93:       is_enterprise = type.eql?("vmfs")
 94: 
 95:       vmdk_data.gsub!(/#NAME#/, @appliance_config.name)
 96:       vmdk_data.gsub!(/#TYPE#/, type)
 97:       vmdk_data.gsub!(/#EXTENT_TYPE#/, is_enterprise ? "VMFS" : "FLAT")
 98:       vmdk_data.gsub!(/#NUMBER#/, is_enterprise ? "" : "0")
 99:       vmdk_data.gsub!(/#HW_VERSION#/, "7")
100:       vmdk_data.gsub!(/#CYLINDERS#/, c.to_s)
101:       vmdk_data.gsub!(/#HEADS#/, h.to_s)
102:       vmdk_data.gsub!(/#SECTORS#/, s.to_s)
103:       vmdk_data.gsub!(/#TOTAL_SECTORS#/, total_sectors.to_s)
104:       vmdk_data.gsub!(/#THIN_PROVISIONED#/, @plugin_config['thin_disk'] ? "1" : "0")
105: 
106:       vmdk_data
107:     end

[Source]

     # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 88
 88:     def change_vmdk_values(type)
 89:       vmdk_data = File.open("#{File.dirname(__FILE__)}/src/base.vmdk").read
 90: 
 91:       c, h, s, total_sectors = generate_scsi_chs
 92: 
 93:       is_enterprise = type.eql?("vmfs")
 94: 
 95:       vmdk_data.gsub!(/#NAME#/, @appliance_config.name)
 96:       vmdk_data.gsub!(/#TYPE#/, type)
 97:       vmdk_data.gsub!(/#EXTENT_TYPE#/, is_enterprise ? "VMFS" : "FLAT")
 98:       vmdk_data.gsub!(/#NUMBER#/, is_enterprise ? "" : "0")
 99:       vmdk_data.gsub!(/#HW_VERSION#/, "7")
100:       vmdk_data.gsub!(/#CYLINDERS#/, c.to_s)
101:       vmdk_data.gsub!(/#HEADS#/, h.to_s)
102:       vmdk_data.gsub!(/#SECTORS#/, s.to_s)
103:       vmdk_data.gsub!(/#TOTAL_SECTORS#/, total_sectors.to_s)
104:       vmdk_data.gsub!(/#THIN_PROVISIONED#/, @plugin_config['thin_disk'] ? "1" : "0")
105: 
106:       vmdk_data
107:     end

[Source]

     # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 143
143:     def copy_raw_image
144:       @log.debug "Copying VMware image file, this may take several minutes..."
145:       @exec_helper.execute "cp '#{@previous_deliverables.disk}' '#{@deliverables.disk}'"
146:       @log.debug "VMware image copied."
147:     end

[Source]

     # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 143
143:     def copy_raw_image
144:       @log.debug "Copying VMware image file, this may take several minutes..."
145:       @exec_helper.execute "cp '#{@previous_deliverables.disk}' '#{@deliverables.disk}'"
146:       @log.debug "VMware image copied."
147:     end

[Source]

    # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 57
57:     def create_readme
58:       readme = File.open("#{File.dirname(__FILE__)}/src/README-#{@plugin_config['type']}").read
59:       readme.gsub!(/#APPLIANCE_NAME#/, @appliance_config.name)
60: 
61:       readme
62:     end

[Source]

    # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 57
57:     def create_readme
58:       readme = File.open("#{File.dirname(__FILE__)}/src/README-#{@plugin_config['type']}").read
59:       readme.gsub!(/#APPLIANCE_NAME#/, @appliance_config.name)
60: 
61:       readme
62:     end

[Source]

     # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 130
130:     def customize_image
131:       unless @appliance_config.post['vmware'].nil? or @appliance_config.post['vmware'].empty?
132:         @image_helper.customize(@deliverables.disk) do |guestfs, guestfs_helper|
133:           @appliance_config.post['vmware'].each do |cmd|
134:             guestfs_helper.sh(cmd, :arch => @appliance_config.hardware.arch)
135:           end
136:           @log.debug "Post commands from appliance definition file executed."
137:         end
138:       else
139:         @log.debug "No commands specified, skipping."
140:       end
141:     end

[Source]

     # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 130
130:     def customize_image
131:       unless @appliance_config.post['vmware'].nil? or @appliance_config.post['vmware'].empty?
132:         @image_helper.customize(@deliverables.disk) do |guestfs, guestfs_helper|
133:           @appliance_config.post['vmware'].each do |cmd|
134:             guestfs_helper.sh(cmd, :arch => @appliance_config.hardware.arch)
135:           end
136:           @log.debug "Post commands from appliance definition file executed."
137:         end
138:       else
139:         @log.debug "No commands specified, skipping."
140:       end
141:     end

[Source]

    # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 38
38:     def execute
39:       @log.info "Converting image to VMware #{@plugin_config['type']} format..."
40: 
41:       case @plugin_config['type']
42:         when 'personal'
43:           build_vmware_personal
44:         when 'enterprise'
45:           build_vmware_enterprise
46:         else
47:           raise "Not known VMware format specified. Available are: personal and enterprise. See http://boxgrinder.org/tutorials/boxgrinder-build-plugins/#VMware_Platform_Plugin for more info."
48:       end
49: 
50:       customize_image
51: 
52:       File.open(@deliverables.readme, "w") { |f| f.write(create_readme) }
53: 
54:       @log.info "Image converted to VMware format."
55:     end

[Source]

    # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 38
38:     def execute
39:       @log.info "Converting image to VMware #{@plugin_config['type']} format..."
40: 
41:       case @plugin_config['type']
42:         when 'personal'
43:           build_vmware_personal
44:         when 'enterprise'
45:           build_vmware_enterprise
46:         else
47:           raise "Not known VMware format specified. Available are: personal and enterprise. See http://boxgrinder.org/tutorials/boxgrinder-build-plugins/#VMware_Platform_Plugin for more info."
48:       end
49: 
50:       customize_image
51: 
52:       File.open(@deliverables.readme, "w") { |f| f.write(create_readme) }
53: 
54:       @log.info "Image converted to VMware format."
55:     end

returns value of cylinders, heads and sector for selected disk size (in GB) kb.vmware.com/kb/1026254

[Source]

    # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 66
66:     def generate_scsi_chs
67:       disk_size = File.stat(@previous_deliverables.disk).size
68: 
69:       if disk_size < 1073741824
70:         h = 64
71:         s = 32
72:       else
73:         if disk_size < 2147483648
74:           h = 128
75:           s = 32
76:         else
77:           h = 255
78:           s = 63
79:         end
80:       end
81: 
82:       c             = disk_size / (h*s*512)
83:       total_sectors = disk_size / 512
84: 
85:       [c.to_i, h.to_i, s.to_i, total_sectors.to_i]
86:     end

returns value of cylinders, heads and sector for selected disk size (in GB) kb.vmware.com/kb/1026254

[Source]

    # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 66
66:     def generate_scsi_chs
67:       disk_size = File.stat(@previous_deliverables.disk).size
68: 
69:       if disk_size < 1073741824
70:         h = 64
71:         s = 32
72:       else
73:         if disk_size < 2147483648
74:           h = 128
75:           s = 32
76:         else
77:           h = 255
78:           s = 63
79:         end
80:       end
81: 
82:       c             = disk_size / (h*s*512)
83:       total_sectors = disk_size / 512
84: 
85:       [c.to_i, h.to_i, s.to_i, total_sectors.to_i]
86:     end

[Validate]