Features/BoxGrinder

From FedoraProject

< Features(Difference between revisions)
Jump to: navigation, search
(updated Detailed Description section)
Line 20: Line 20:
 
* Last updated: 2010-11-12
 
* Last updated: 2010-11-12
 
* Percentage of completion: 60%
 
* Percentage of completion: 60%
 +
* Packages submitted for review:
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=652396 rubygem-boxgrinder-core] (NEW)
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=652400 rubygem-boxgrinder-build] (NEW)
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=652403 rubygem-boxgrinder-build-rpm-based-os-plugin] (NEW)
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=652406 rubygem-boxgrinder-build-fedora-os-plugin] (NEW)
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=652408 rubygem-boxgrinder-build-vmware-platform-plugin] (NEW)
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=652412 rubygem-boxgrinder-build-local-delivery-plugin] (NEW)
 +
** [https://bugzilla.redhat.com/show_bug.cgi?id=652414 rubygem-boxgrinder-build-sftp-delivery-plugin] (NEW)
  
 
<!-- CHANGE THE "FedoraVersion" TEMPLATES ABOVE TO PLAIN NUMBERS WHEN YOU COMPLETE YOUR PAGE. -->
 
<!-- CHANGE THE "FedoraVersion" TEMPLATES ABOVE TO PLAIN NUMBERS WHEN YOU COMPLETE YOUR PAGE. -->
Line 40: Line 48:
  
 
<pre>
 
<pre>
name: f13-basic
+
name: f14-jeos
summary: Just Enough Operating System based on Fedora 13
+
summary: Just Enough Operating System based on Fedora 14
 
os:
 
os:
 
   name: fedora
 
   name: fedora
   version: 13
+
   version: 14
 
hardware:
 
hardware:
 
   partitions:
 
   partitions:
Line 67: Line 75:
  
 
== 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 local delivery plugin configuration file, and store it as '''$HOME/.boxgrinder/plugins/local'''.
 +
# Install and run BoxGrinder.
  
A good "how to test" should answer these four questions:
+
=== Sample local delivery plugin 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
+
path: /home/goldmann/builds
need to be installed, config files edited, etc.?
+
overwrite: false              # default: false
2. What specific actions do I perform to check that the feature is
+
package: true                  # default: true
working like it's supposed to?
+
</pre>
3. What are the expected results of those actions?
+
 
-->
+
=== Commands to execute ===
 +
 
 +
<pre>
 +
yum install rubygem-boxgrinder-build-fedora-os-plugin rubygem-boxgrinder-build-vmware-platform-plugin
 +
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
  
 
== 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://community.jboss.org/docs/DOC-14358 Main BoxGrinder documentation page]
 +
* [http://community.jboss.org/docs/DOC-15214 BoxGrinder Build plugins]
 +
* [http://community.jboss.org/docs/DOC-15080 BoxGrinder Build Quick start]
 +
* [http://community.jboss.org/docs/DOC-14359 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. -->
*
+
* [https://jira.jboss.org/secure/ReleaseNote.jspa?projectId=12310920&version=12315624 0.6.3 Release notes]
 +
* [https://jira.jboss.org/browse/BGBUILD#selectedTab=com.atlassian.jira.plugin.system.project%3Aversions-panel Previous versions]
  
 
== 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:FeaturePageIncomplete]]

Revision as of 11:51, 12 November 2010


Contents

Feature Name BoxGrinder

Summary

Owner

  • Email: mgoldman@redhat.com

Current status


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.

Appliance definition file

Example appliance definition file:

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

BoxGrinder Build architecture

BoxGrinderBuild-architecture.png

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.

Benefit to Fedora

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

Scope

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

How To Test

  1. Save sample appliance definition file as f14-jeos.appl.
  2. Create local delivery plugin configuration file, and store it as $HOME/.boxgrinder/plugins/local.
  3. Install and run BoxGrinder.

Sample local delivery plugin configuration file

path: /home/goldmann/builds
overwrite: false               # default: false
package: true                  # default: true

Commands to execute

yum install rubygem-boxgrinder-build-fedora-os-plugin rubygem-boxgrinder-build-vmware-platform-plugin
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.

User Experience

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

Dependencies

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

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.

Documentation

Release Notes

Comments and Discussion

Help

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