Outreach Program Projects: Difference between revisions
Lars.kurth (talk | contribs) |
Lars.kurth (talk | contribs) No edit summary |
||
| Line 119: | Line 119: | ||
|Outcomes=Code is submitted to xen-devel@xen.org for inclusion in the xen-unstable project. |
|Outcomes=Code is submitted to xen-devel@xen.org for inclusion in the xen-unstable project. |
||
|GSoC=yes}} |
|GSoC=yes}} |
||
| ⚫ | |||
{{InfoLeft|These should just point to [https://github.com/mirage/mirage-www/wiki/Pioneer-Projects https://github.com/mirage/mirage-www/wiki/Pioneer-Projects] from here and be deleted from here. Also see [http://lists.xenproject.org/archives/html/mirageos-devel/2015-09/msg00048.html].}} |
|||
{{project |
|||
|Project=Create a tiny VM for easy load testing |
|||
|Date=01/30/2014 |
|||
|Contact=Dave Scott <dave.scott@eu.citrix.com> |
|||
|Difficulty=Medium |
|||
|Skills=OCaml |
|||
|Desc=The Mirage OS framework (see http://xenproject.org/developers/teams/mirage-os.html, http://www.openmirage.org/) can be used to create tiny 'unikernels': entire software stacks which run directly on the Xen hypervisor. These VMs have such a small memory footprint (16 MiB or less) that many of them can be run even on relatively small hosts. The goal of this project is to create a specific unikernel that can be configured to generate a specific I/O pattern, and to create configurations that mimic the boot sequence of Linux and Windows guests. The resulting unikernel will then enable cheap system load testing. |
|||
The first task is to generate an I/O trace from a VM. For this we could use 'xen-disk', a userspace Mirage application which acts as a block backend for xen guests (see http://openmirage.org/wiki/xen-synthesize-virtual-disk). Following the wiki instructions we could modify a 'file' backend to log the request timestamps, offsets, buffer lengths. |
|||
The second task is to create a simple kernel based on one of the MirageOS examples (see http://github.com/mirage/mirage-skeleton). The 'block' example shows how reads and writes are done. The previously-generated log could be statically compiled into the kernel and executed to generate load. |
|||
|Outcomes=1. a repository containing an 'unikernel' (see http://github.com/mirage/mirage-skeleton) |
|||
2. at least 2 I/O traces, one for Windows boot and one for Linux boot (any version) |
|||
|GSoC=yes}} |
|||
{{project |
|||
|Project=Fuzz testing Xen with Mirage |
|||
|Date=28/11/2013 |
|||
|Contact=Anil Madhavapeddy <anil@recoil.org> |
|||
|Skills=OCaml, Xen |
|||
|Difficulty=medium |
|||
|Desc= |
|||
Mirage OS (see http://xenproject.org/developers/teams/mirage-os.html, http://www.openmirage.org/) is a type-safe unikernel written in OCaml which generates highly specialised "appliance" VMs that run directly on Xen without requiring an intervening guest kernel. We would like to use the Mirage/Xen libraries to fuzz test all levels of a typical cloud toolstack. Mirage has low-level bindings for Xen hypercalls, mid-level bindings for domain management, and high-level bindings to XCP for cluster management. This project would build a QuickCheck-style fuzzing mechanism that would perform millions of random operations against a real cluster, and identify bugs with useful backtraces. |
|||
The first task would be to become familiar with a specification-based testing tool like Kaputt (see http://kaputt.x9c.fr/). The second task would be to choose an interface for testing; perhaps one of the hypercall ones. |
|||
[[GSoC_2013#fuzz-testing-mirage]] |
|||
|Outcomes=1. a repo containing a fuzz testing tool; 2. some unexpected behaviour with a backtrace (NB it's not required that we find a critical bug, we just need to show the approach works) |
|||
|GSoC=yes |
|||
}} |
|||
{{project |
|||
|Project=Mirage OS web stack testing |
|||
|Date=25/02/2014 |
|||
|Contact=Anil Madhavapeddy <anil@recoil.org> |
|||
|Skills=OCaml, shell scripting |
|||
|Difficulty=medium |
|||
|Desc= |
|||
MirageOS has an emerging web toolstack that's broken up as a series of libraries -- for example, Cohttp, Uri, Cow, Ipaddr, RSS and Cowabloga. This project will get you familiar with them by building a protocol testing framework that can generate traffic using off-the-shelf tools such as httperf, and evaluate the results vs applications such as Apache or Nginx. |
|||
|Outcomes=1. a test harness for HTTP; 2. some results of the evaluation using the test harness |
|||
|GSoC=yes |
|||
}} |
|||
== List of projects that need more work == |
|||
{{Anchor|Unreviewed Project Ideas}} |
|||
=== Domain support (PVOPS and Linux) === |
|||
{{project |
|||
|Project=Implement Xen PVSCSI support in xl/libxl toolstack |
|||
|Date=01/12/2012 |
|||
|Contact=Pasi Karkkainen <pasik@iki.fi> |
|||
|GSoC=Yes |
|||
|Desc= |
|||
xl/libxl does not currently support Xen PVSCSI functionality. Port the feature from xm/xend to xl/libxl. Necessary operations include: |
|||
* Task 1: Implement PVSCSI in xl/libxl, make it functionally equivalent to xm/xend. |
|||
* Send to xen-devel mailinglist for review, comments. |
|||
* Fix any upcoming issues. |
|||
* Repeat until merged to xen-unstable. |
|||
* See above for PVSCSI drivers for dom0/domU. |
|||
* Xen PVSCSI supports both PV domUs and HVM guests with PV drivers. |
|||
* More info: http://wiki.xen.org/xenwiki/XenPVSCSI |
|||
{{Comment|[[User:Lars.kurth|Lars.kurth]] 14:14, 23 January 2013 (UTC):}} Should be suitable, but desc needs. Rate in terms of challenges, size and skill. Also kernel functionality is not yet upstreamed. Maybe Suse kernel. |
|||
}} |
|||
=== Xen Hypervisor === |
=== Xen Hypervisor === |
||
| Line 270: | Line 202: | ||
|GSoC=Yes |
|GSoC=Yes |
||
}} |
}} |
||
| ⚫ | |||
For Mirage OS, please check out the [https://github.com/mirage/mirage-www/wiki/Pioneer-Projects Mirage OS Pioneer-Projects page]. If you are interested in one of these projects, please e-mail [http://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel mirageos-devel@lists.xenproject.org] and CC the mentor from the page (the project will contain a link to the mentor's GitHub account, which normally contains an email address and IRC information). You can also ask questions on the #mirage [http://xenproject.org/help/irc.html IRC] channel and usually find mentors on there. |
|||
=== XAPI === |
=== XAPI === |
||
No projects at this stage. |
|||
== New Project Ideas == |
== New Project Ideas == |
||
Revision as of 11:14, 22 September 2015
|
The links below need to be updated before September 28th 2015 |
The Xen Project is a Linux Foundation collaborative project that develops the
- Xen Hypervisor (for x86 and ARM)
- The XAPI toolstack
- Mirage OS
The project also has excellent relationships with its upstreams (Linux Kernel, the BSDs, QEMU and other projects) and upstreams such as Linux distributions. This is reflected in the project list, which contains many interesting cross-project development projects for applicants.
Finding a project that fits you
This page lists Xen Project development projects for Outreachy (formerly the Outreach Program for Women) that can be picked up by anyone! If you're interesting in hacking Xen Project code and want to become a part of our friendly developer community this is the place to start! Ready for the challenge?
To work on a project:
- Find a project that looks interesting (or a bug if you want to start with something simple)
- Send an email to the relevant mailing list (see Developer Mailing Lists) and let us know if you are interested in starting to work or applying on a specific project.
- Post your ideas, questions, RFCs to the relevant mailing list sooner than later so you can get comments and feedback.
You have your own project idea: no problem!
- If you have your own project idea, outline what you are trying to do on the mailing list. If you know the right list, post your project idea on mailing list. Failing that post on xen-devel and we can redirect you to the right list. Make sure you add OPW 2014 to the subject line.
It is a good idea to ...
The Xen Project has also participated in the Gnome Outreach Program for Women (OPW) and Google Summer of Code (GSoC) in the past. One of the things we learned by participating in these programs is that you will be more successful, happier and get more out of participating in internship programs, if you do a bit of prep-work before writing an application. Here is some stuff you can do:
- Contact your mentor early and get to know him or her
- Start hanging out on our IRC channel. You can use the #xen-opw IRC channel on freenode.net for now
- You may want to ask the mentor for a couple of small bitesize work-items (such as reviewing someones patch, a bitesize bug, ...) and start communicating on the relevant mailing list. That helps you become familiar with our development process, the mentor and other community members and will help you chose the right project and help you decide whether the Xen project is for you.
- Note that quite a few Xen maintainers used to be GSoC participants once. Feel free to ask community dot manager at xenproject dot org to put you in touch with them if you have questions about their experience.
- Any work you submit before applying for a project should be based on xen-unstable development tree, if the project is Xen Hypervisor and/or tools related. Linux kernel related patches should be based on upstream kernel.org Linux git tree (latest version). XAPI and Mirage OS patches should be based on the right codeline too. Check out the navigation by audience section on the left to find resources.
More resources
Quick links to changelogs of the various Xen related repositories/trees: Please see XenRepositories wiki page!
Before to submit patches, please look at Submitting Xen Patches wiki page and the relevant Xen Project team page. This will contain more information.
If you have new ideas, suggestions or development plans let us know and we'll update this list!
Aspiring Participants
- Please contact the mentor and CC the most appropriate mailing list
- Get a bite-size task from the mentor before the application starts
- If you feel comfortable with an idea, please put your name to an idea using the following format
{{project
...
|Review=(delete as addressed)
* {{Comment|~~~~:}} I am interested in this idea ...
(note that you may also want to link to the e-mail thread with the mentor)
- You will need to request write access to the wiki by filling out this form
Outreach Program Project Ideas
List of peer reviewed Projects
Domain support (PVOPS and Linux)
Enabling the 9P File System transport as a paravirt device
|
Xen Hypervisor Userspace Tools
CPU/RAM/PCI diagram tool
|
KDD (Windows Debugger Stub) enhancements
|
Xen Hypervisor
Introducing PowerClamp-like driver for Xen
|
Xen Hypervisor Userspace Tools
Refactor Linux hotplug scripts
|
Advanced Scheduling Parameters
|
PCI Pass-through improvements
Allowing guests to boot with a passed-through GPU as the primary display
|
Improve PCIe Advanced Error Reporting (AER) handling for passed-through devices
|
Mirage OS
For Mirage OS, please check out the Mirage OS Pioneer-Projects page. If you are interested in one of these projects, please e-mail mirageos-devel@lists.xenproject.org and CC the mentor from the page (the project will contain a link to the mentor's GitHub account, which normally contains an email address and IRC information). You can also ask questions on the #mirage IRC channel and usually find mentors on there.
XAPI
No projects at this stage.
New Project Ideas
Please add new project ideas here, following
Conventions for Projects and Project Mentors
Rules and Advice for Adding Ideas
- Be creative
- Add projects into New Project Ideas or improve projects in Project Ideas that Need Review or more work through review comments.
- Use the {{GSoC Project}} template to encode ideas on this page. Please read the Template Documentation before you do so.
- Be specific: what do you want to be implemented; if at all possible provide an indication of size and complexity as described above to make it easier for an applicant to choose ideas
- If you are willing to mentors those ideas, add your name and email to the idea.
- Aspiring mentors should introduce themselves on the most appropriate Xen Project mailing list
Peer Review Goals
We strongly recommend and invite project proposers and project mentors to review each others proposals. When you review, please look out for
- Can an intern get going and started with the information in the project description
- Are any unstated assumptions in the proposal, is there undefined terminology, etc. in the proposal
- Can the project completed in 3 months (assume that one month is needed for preparation)
- Does the project meet Google Summer of Code goals, which are
- Create and release open source code for the benefit of all
- Inspire young developers to begin participating in open source development
- Help open source projects identify and bring in new developers and committers
- Provide interns the opportunity to do work related to their academic pursuits (think "flip bits, not burgers")
- Give interns more exposure to real-world software development scenarios (e.g., distributed development, software licensing questions, mailing-list etiquette)
Peer Review Conventions
The {{GSoC Project}} template used to encode project listings, contains some review functionality. Please read the Template Documentation before you add a template, also please use the conventions below to make comments.
|Review=(delete as addressed)
* {{Comment|~~~~:}} Comment 1
* {{Comment|~~~~:}} Comment 2
Choosing Projects
We have a bi-weekly mentor meeting overlooked by our program management team, which are a core team of 2-3 mentors and a program administrator. This group will work with mentors to ensure that project proposals are of good quality and whether mentors are engaging with the program management team and particpants in the weeks before the application period ends.
