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

[Source]

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

[Source]

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

[Source]

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

[Source]

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

[Source]

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

[Source]

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

[Source]

     # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 112
112:     def change_common_vmx_values
113:       vmx_data = File.open("#{File.dirname(__FILE__)}/src/base.vmx").read
114: 
115:       # replace version with current appliance version
116:       vmx_data.gsub!(/#VERSION#/, "#{@appliance_config.version}.#{@appliance_config.release}")
117:       # change name
118:       vmx_data.gsub!(/#NAME#/, @appliance_config.name.to_s)
119:       # and summary
120:       vmx_data.gsub!(/#SUMMARY#/, @appliance_config.summary.to_s)
121:       # replace guestOS informations to: linux or otherlinux-64, this seems to be the savests values
122:       vmx_data.gsub!(/#GUESTOS#/, "#{@appliance_config.hardware.arch == "x86_64" ? "otherlinux-64" : "linux"}")
123:       # memory size
124:       vmx_data.gsub!(/#MEM_SIZE#/, @appliance_config.hardware.memory.to_s)
125:       # memory size
126:       vmx_data.gsub!(/#VCPU#/, @appliance_config.hardware.cpus.to_s)
127:       # network name
128:       # vmx_data.gsub!( /#NETWORK_NAME#/, @image_config.network_name )
129: 
130:       vmx_data
131:     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:       disk_size = 0.0
 92:       @appliance_config.hardware.partitions.values.each { |part| disk_size += part['size'].to_f }
 93: 
 94:       c, h, s, total_sectors = generate_scsi_chs(disk_size)
 95: 
 96:       is_enterprise = type.eql?("vmfs")
 97: 
 98:       vmdk_data.gsub!(/#NAME#/, @appliance_config.name)
 99:       vmdk_data.gsub!(/#TYPE#/, type)
100:       vmdk_data.gsub!(/#EXTENT_TYPE#/, is_enterprise ? "VMFS" : "FLAT")
101:       vmdk_data.gsub!(/#NUMBER#/, is_enterprise ? "" : "0")
102:       vmdk_data.gsub!(/#HW_VERSION#/, "7")
103:       vmdk_data.gsub!(/#CYLINDERS#/, c.to_s)
104:       vmdk_data.gsub!(/#HEADS#/, h.to_s)
105:       vmdk_data.gsub!(/#SECTORS#/, s.to_s)
106:       vmdk_data.gsub!(/#TOTAL_SECTORS#/, total_sectors.to_s)
107:       vmdk_data.gsub!(/#THIN_PROVISIONED#/, @plugin_config['thin_disk'] ? "1" : "0")
108: 
109:       vmdk_data
110:     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:       disk_size = 0.0
 92:       @appliance_config.hardware.partitions.values.each { |part| disk_size += part['size'].to_f }
 93: 
 94:       c, h, s, total_sectors = generate_scsi_chs(disk_size)
 95: 
 96:       is_enterprise = type.eql?("vmfs")
 97: 
 98:       vmdk_data.gsub!(/#NAME#/, @appliance_config.name)
 99:       vmdk_data.gsub!(/#TYPE#/, type)
100:       vmdk_data.gsub!(/#EXTENT_TYPE#/, is_enterprise ? "VMFS" : "FLAT")
101:       vmdk_data.gsub!(/#NUMBER#/, is_enterprise ? "" : "0")
102:       vmdk_data.gsub!(/#HW_VERSION#/, "7")
103:       vmdk_data.gsub!(/#CYLINDERS#/, c.to_s)
104:       vmdk_data.gsub!(/#HEADS#/, h.to_s)
105:       vmdk_data.gsub!(/#SECTORS#/, s.to_s)
106:       vmdk_data.gsub!(/#TOTAL_SECTORS#/, total_sectors.to_s)
107:       vmdk_data.gsub!(/#THIN_PROVISIONED#/, @plugin_config['thin_disk'] ? "1" : "0")
108: 
109:       vmdk_data
110:     end

[Source]

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

[Source]

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

[Source]

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

[Source]

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

[Source]

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

[Source]

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

[Source]

    # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 39
39:     def execute
40:       @log.info "Converting image to VMware #{@plugin_config['type']} format..."
41: 
42:       case @plugin_config['type']
43:         when 'personal'
44:           build_vmware_personal
45:         when 'enterprise'
46:           build_vmware_enterprise
47:         else
48:           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."
49:       end
50: 
51:       customize_image
52: 
53:       File.open(@deliverables.readme, "w") { |f| f.write(create_readme) }
54: 
55:       @log.info "Image converted to VMware format."
56:     end

[Source]

    # File lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb, line 39
39:     def execute
40:       @log.info "Converting image to VMware #{@plugin_config['type']} format..."
41: 
42:       case @plugin_config['type']
43:         when 'personal'
44:           build_vmware_personal
45:         when 'enterprise'
46:           build_vmware_enterprise
47:         else
48:           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."
49:       end
50: 
51:       customize_image
52: 
53:       File.open(@deliverables.readme, "w") { |f| f.write(create_readme) }
54: 
55:       @log.info "Image converted to VMware format."
56:     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 67
67:     def generate_scsi_chs(disk_size)
68:       if disk_size < 1
69:         h = 64
70:         s = 32
71:       else
72:         if disk_size < 2
73:           h = 128
74:           s = 32
75:         else
76:           h = 255
77:           s = 63
78:         end
79:       end
80: 
81:       #               GB          MB     KB     B
82:       c             = disk_size * 1024 * 1024 * 1024 / (h*s*512)
83:       total_sectors = disk_size * 1024 * 1024 * 1024 / 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 67
67:     def generate_scsi_chs(disk_size)
68:       if disk_size < 1
69:         h = 64
70:         s = 32
71:       else
72:         if disk_size < 2
73:           h = 128
74:           s = 32
75:         else
76:           h = 255
77:           s = 63
78:         end
79:       end
80: 
81:       #               GB          MB     KB     B
82:       c             = disk_size * 1024 * 1024 * 1024 / (h*s*512)
83:       total_sectors = disk_size * 1024 * 1024 * 1024 / 512
84: 
85:       [c.to_i, h.to_i, s.to_i, total_sectors.to_i]
86:     end

[Validate]