Features/BoxGrinder

From FedoraProject

< Features(Difference between revisions)
Jump to: navigation, search
m
m
 
(31 intermediate revisions by 3 users not shown)
Line 7: Line 7:
  
 
== Summary ==
 
== Summary ==
<!-- A sentence or two summarizing what this feature is and what it will do.  This information is used for the overall feature summary page for each release. -->
+
BoxGrinder creates appliances (virtual machines) from simple plain text appliance definition files for various virtual platforms.
  
 
== Owner ==
 
== Owner ==
Line 18: Line 18:
 
== Current status ==
 
== Current status ==
 
* Targeted release: [[Releases/15 | Fedora 15 ]]  
 
* Targeted release: [[Releases/15 | Fedora 15 ]]  
* Last updated: 2010-11-05
+
* Last updated: 2011-01-30
* Percentage of completion: 10%
+
* Percentage of completion: 100%
 +
* Packages submitted for review:
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=652396 rubygem-boxgrinder-core] ('''done''' – in stable for all OS versions)
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=652400 rubygem-boxgrinder-build] ('''done''' – in stable for all OS versions)
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=652403 rubygem-boxgrinder-build-rpm-based-os-plugin] ('''done''' – in stable for all OS versions)
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=652406 rubygem-boxgrinder-build-fedora-os-plugin] ('''done''' – in stable for all OS versions)
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=652408 rubygem-boxgrinder-build-vmware-platform-plugin] ('''done''' – in stable for all OS versions)
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=652412 rubygem-boxgrinder-build-local-delivery-plugin] ('''done''' – in stable for all OS versions)
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=663983 rubygem-boxgrinder-build-ec2-platform-plugin] ('''done''' – in stable for all OS versions)
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=664111 rubygem-boxgrinder-build-s3-delivery-plugin] ('''done''' – in stable for all OS versions)
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=664113 rubygem-boxgrinder-build-ebs-delivery-plugin] ('''done''' – in stable for all OS versions)
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=652414 rubygem-boxgrinder-build-sftp-delivery-plugin] ('''done''' – in stable for all OS versions)
  
<!-- CHANGE THE "FedoraVersion" TEMPLATES ABOVE TO PLAIN NUMBERS WHEN YOU COMPLETE YOUR PAGE. -->
+
=== Updates: ===
 +
 
 +
* '''As of 2011-03-11 with [https://admin.fedoraproject.org/updates/rubygem-boxgrinder-build-0.9.0-3.fc15,rubygem-boxgrinder-core-0.3.0-1.fc15 this update] - plugin packages are now removed and only rubygem-boxgrinder-core and rubygem-boxgrinder-build packages are required. All plugins are now included in rubygem-boxgrinder-build package.''' --[[User:Goldmann|Goldmann]] 17:32, 21 March 2011 (UTC)
 +
* All packages available in stable repo! --[[User:Goldmann|Goldmann]] 17:29, 30 January 2011 (UTC)
 +
* All packages available in stable or testing repos --[[User:Goldmann|Goldmann]] 08:05, 22 January 2011 (UTC)
 +
* One plugin (SFTP) left in review queue --[[User:Goldmann|Goldmann]] 16:36, 17 January 2011 (UTC)
 +
* Three plugins (S3, EBS, SFTP) left in review queue, other plugins in stable --[[User:Goldmann|Goldmann]] 19:49, 28 December 2010 (UTC)
 +
* Most plugins are in stable. [https://jira.jboss.org/browse/BGBUILD-55 BGBUILD-55] was fixed! I submitted last plugins now. --[[User:Goldmann|Goldmann]] 10:24, 18 December 2010 (UTC)
 +
* Almost all packages are in stable or testing repos now. --[[User:Goldmann|Goldmann]] 13:09, 9 December 2010 (UTC)
 +
* Most of packages were approved. Doing last cleanups in spec files. --[[User:Goldmann|Goldmann]] 11:06, 29 November 2010 (UTC)
 +
* All spec files recreated and all review requests updated with new files. Everything builds fine in my mock environment now. --[[User:Goldmann|Goldmann]] 11:09, 26 November 2010 (UTC)
  
 
== Detailed Description ==
 
== Detailed Description ==
 
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
 
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
 +
 +
[http://boxgrinder.org BoxGrinder] is a set of tools used for building appliances (virtual machines) for various platforms (KVM, Xen, VMware, EC2).
 +
 +
BoxGrinder creates appliances (images/virtual machines) from simple plain text Appliance Definition Files. There are only two simple steps to create an appliance:
 +
 +
# [http://boxgrinder.org/tutorials/appliance-definition/ Create Appliance Definition File]
 +
# Run BoxGrinder. BoxGrinder will download all necessary artifact, build the instance, convert it to selected platform and upload it to selected destination. All in one process!
 +
 +
See [http://boxgrinder.org/tutorials/boxgrinder-build-quick-start/ Quick start] page for more info.
 +
 +
=== Appliance definition file ===
 +
 +
Example appliance definition file:
 +
 +
<pre>
 +
name: f14-jeos
 +
summary: Just Enough Operating System based on Fedora 14 with PostgreSQL
 +
os:
 +
  name: fedora
 +
  version: 14
 +
hardware:
 +
  partitions:
 +
    "/":
 +
      size: 2
 +
packages:
 +
  - @core
 +
  - postgresql-server
 +
</pre>
 +
 +
=== BoxGrinder Build architecture ===
 +
 +
[[File:BoxGrinderBuild-architecture.png]]
 +
 +
=== How it works ===
 +
 +
BoxGrinder Build has a plugin architecture. We can distinguish three types:
 +
 +
# Operating System plugins – generating base appliance for selected OS,
 +
# Platform plugins – creating converted base appliance for selected platform (VMware, EC2),
 +
# Delivery plugins – designed to deliver your new appliance to a specified location. For example as a tar file to a remote server or just register as AMI on EC2.
  
 
== Benefit to Fedora ==
 
== Benefit to Fedora ==
<!-- What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new feature, what capabilities does it bring? Why will Fedora become a better distribution or project because of this feature?-->
+
Creating and delivering Fedora-based appliances to various virtual platforms like KVM, VMware, EC2.
  
 
== Scope ==
 
== Scope ==
<!-- What work do the developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
+
Watch review request, fix all specs to meets Fedora Guidelines.
  
 
== How To Test ==
 
== How To Test ==
<!-- This does not need to be a full-fledged document.  Describe the dimensions of tests that this feature is expected to pass when it is done.  If it needs to be tested with different hardware or software configurations, indicate them.  The more specific you can be, the better the community testing can be.
 
  
Remember that you are writing this how to for interested testers to use to check out your feature - documenting what you do for testing is OK, but it's much better to document what *I* can do to test your feature.
+
# Save sample [[#Appliance definition file|appliance definition file]] as '''f14-jeos.appl'''.
 +
# Create BoxGrinder configuration file '''$HOME/.boxgrinder/config'''.
 +
# Install and run BoxGrinder.
  
A good "how to test" should answer these four questions:
+
=== Sample BoxGrinder configuration file ===
  
0. What special hardware / data / etc. is needed (if any)?
+
<pre>
1. How do I prepare my system to test this feature? What packages
+
log_level: debug
need to be installed, config files edited, etc.?
+
plugins:
2. What specific actions do I perform to check that the feature is
+
  local:
working like it's supposed to?
+
    path: /home/goldmann/builds
3. What are the expected results of those actions?
+
    overwrite: false              # default: false
-->
+
    package: true                  # default: true
 +
  vmware:
 +
    type: personal
 +
    thin_disk: true                # default: false
 +
</pre>
 +
 
 +
=== Commands to execute ===
 +
 
 +
<pre>
 +
yum install rubygem-boxgrinder-build
 +
boxgrinder-build jeos-f14.appl -p vmware -d local
 +
</pre>
 +
 
 +
It should produce a virtual machine, convert it to VMware format and store in /home/goldmann/builds dir as tarred file.
  
 
== User Experience ==
 
== User Experience ==
<!-- If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
+
BoxGrinder will allow for easy and fast appliance creation and delivery.
  
 
== Dependencies ==
 
== Dependencies ==
<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this feature depends?  In other words, completion of another feature owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel feature)? -->
+
 
 +
* ruby
 +
* appliance-tools
 +
* libguestfs
 +
* yum-utils
 +
* various rubygems
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=653407 rubygem-hashery] (CLOSED, pushed to F13/F14/rawhide)
  
 
== Contingency Plan ==
 
== Contingency Plan ==
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour."  Or it might not.  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy. -->
+
BoxGrinder is already released and packaged. It only needs to be reviewed and included, but if this fails we're still able to install BoxGrinder using RubyGems and gem install command.
  
 
== Documentation ==
 
== Documentation ==
<!-- Is there upstream documentation on this feature, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
+
 
* http://community.jboss.org/docs/DOC-14358
+
* [http://boxgrinder.org/tutorials/ Main BoxGrinder documentation page]
 +
* [http://boxgrinder.org/tutorials/boxgrinder-build-plugins/ BoxGrinder Build plugins]
 +
* [http://boxgrinder.org/tutorials/boxgrinder-build-quick-start/ BoxGrinder Build Quick start]
 +
* [http://boxgrinder.org/tutorials/appliance-definition/ BoxGrinder appliance definition file explained]
  
 
== Release Notes ==
 
== Release Notes ==
 
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
 
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
 
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
 
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
*
+
 
 +
BoxGrinder Build is an easy to use command line tool to create appliances (virtual images) from simple plaintext appliance definition files. BoxGrinder can produce appliances for a variety of virtual and cloud platforms using plugins supporting technologies such as VMware or EC2.
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==
 
* See [[Talk:Features/BoxGrinder]]  <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->
 
* See [[Talk:Features/BoxGrinder]]  <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->
  
 +
== Help ==
 +
If you need help – please contact us. We're available on IRC (#boxgrinder/irc.freenode.net) and on [http://community.jboss.org/en/boxgrinder?view=discussions forums].
  
[[Category:FeaturePageIncomplete]]
+
[[Category:FeatureAcceptedF15]] [[Category:JBoss]]
 
<!-- When your feature page is completed and ready for review -->
 
<!-- When your feature page is completed and ready for review -->
 
<!-- remove Category:FeaturePageIncomplete and change it to Category:FeatureReadyForWrangler -->
 
<!-- remove Category:FeaturePageIncomplete and change it to Category:FeatureReadyForWrangler -->
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->

Latest revision as of 07:22, 4 August 2011


Contents

[edit] Feature Name BoxGrinder

[edit] Summary

BoxGrinder creates appliances (virtual machines) from simple plain text appliance definition files for various virtual platforms.

[edit] Owner

  • Email: mgoldman@redhat.com

[edit] Current status

[edit] Updates:

  • As of 2011-03-11 with this update - plugin packages are now removed and only rubygem-boxgrinder-core and rubygem-boxgrinder-build packages are required. All plugins are now included in rubygem-boxgrinder-build package. --Goldmann 17:32, 21 March 2011 (UTC)
  • All packages available in stable repo! --Goldmann 17:29, 30 January 2011 (UTC)
  • All packages available in stable or testing repos --Goldmann 08:05, 22 January 2011 (UTC)
  • One plugin (SFTP) left in review queue --Goldmann 16:36, 17 January 2011 (UTC)
  • Three plugins (S3, EBS, SFTP) left in review queue, other plugins in stable --Goldmann 19:49, 28 December 2010 (UTC)
  • Most plugins are in stable. BGBUILD-55 was fixed! I submitted last plugins now. --Goldmann 10:24, 18 December 2010 (UTC)
  • Almost all packages are in stable or testing repos now. --Goldmann 13:09, 9 December 2010 (UTC)
  • Most of packages were approved. Doing last cleanups in spec files. --Goldmann 11:06, 29 November 2010 (UTC)
  • All spec files recreated and all review requests updated with new files. Everything builds fine in my mock environment now. --Goldmann 11:09, 26 November 2010 (UTC)

[edit] Detailed Description

BoxGrinder is a set of tools used for building appliances (virtual machines) for various platforms (KVM, Xen, VMware, EC2).

BoxGrinder creates appliances (images/virtual machines) from simple plain text Appliance Definition Files. There are only two simple steps to create an appliance:

  1. Create Appliance Definition File
  2. Run BoxGrinder. BoxGrinder will download all necessary artifact, build the instance, convert it to selected platform and upload it to selected destination. All in one process!

See Quick start page for more info.

[edit] Appliance definition file

Example appliance definition file:

name: f14-jeos
summary: Just Enough Operating System based on Fedora 14 with PostgreSQL
os:
  name: fedora
  version: 14
hardware:
  partitions:
    "/":
      size: 2
packages:
  - @core
  - postgresql-server

[edit] BoxGrinder Build architecture

BoxGrinderBuild-architecture.png

[edit] How it works

BoxGrinder Build has a plugin architecture. We can distinguish three types:

  1. Operating System plugins – generating base appliance for selected OS,
  2. Platform plugins – creating converted base appliance for selected platform (VMware, EC2),
  3. Delivery plugins – designed to deliver your new appliance to a specified location. For example as a tar file to a remote server or just register as AMI on EC2.

[edit] Benefit to Fedora

Creating and delivering Fedora-based appliances to various virtual platforms like KVM, VMware, EC2.

[edit] Scope

Watch review request, fix all specs to meets Fedora Guidelines.

[edit] How To Test

  1. Save sample appliance definition file as f14-jeos.appl.
  2. Create BoxGrinder configuration file $HOME/.boxgrinder/config.
  3. Install and run BoxGrinder.

[edit] Sample BoxGrinder configuration file

log_level: debug
plugins:
  local:
    path: /home/goldmann/builds
    overwrite: false               # default: false
    package: true                  # default: true
  vmware:
    type: personal
    thin_disk: true                # default: false

[edit] Commands to execute

yum install rubygem-boxgrinder-build
boxgrinder-build jeos-f14.appl -p vmware -d local

It should produce a virtual machine, convert it to VMware format and store in /home/goldmann/builds dir as tarred file.

[edit] User Experience

BoxGrinder will allow for easy and fast appliance creation and delivery.

[edit] Dependencies

  • ruby
  • appliance-tools
  • libguestfs
  • yum-utils
  • various rubygems

[edit] Contingency Plan

BoxGrinder is already released and packaged. It only needs to be reviewed and included, but if this fails we're still able to install BoxGrinder using RubyGems and gem install command.

[edit] Documentation

[edit] Release Notes

BoxGrinder Build is an easy to use command line tool to create appliances (virtual images) from simple plaintext appliance definition files. BoxGrinder can produce appliances for a variety of virtual and cloud platforms using plugins supporting technologies such as VMware or EC2.

[edit] Comments and Discussion

[edit] Help

If you need help – please contact us. We're available on IRC (#boxgrinder/irc.freenode.net) and on forums.