Toaster

Toaster is a web-based interface to the Bitbake build system and the Poky distribution inside the Yocto Project. This project was formely known as Web Hob / Webhob / webhob, and you may still find references to the old name in the documentation.

General discussion about Toaster happens on a dedicated mailing list: https://lists.yoctoproject.org/listinfo/toaster

Using Toaster

• Setting up a local instance of Toaster
• Setting up a production instance of Toaster
• How to use the Toaster web interface
• How to delete information from the Toaster database

About Toaster

• How to contribute to Toaster
• Architecture design
• Toaster QA
• 1.7 scope and design
• Archive

User interface

The design of the Toaster user interface takes place in iterations, and most recent designs supersede older ones.

The latest iteration is always available at: http://www.yoctoproject.org/toaster

Detailed design documentation is attached to Bugzilla features. Features with design documentation attached have "GUI design available" written in the Whiteboard field, so it is easy to search for them.

Toaster 1.7 scope and design discussions

We are currently planning work for the Yocto Project 1.7 release. Get involved.

Architecture and component design

We are planning the capabilities of Toaster based on evolutive stages of implementation, using community feedback on each stage to plan, design and implement a set of capabilities for the next stage. In the first stage, synchronized with the planning of Yocto Project 1.5 release, we implemented the back end of a build analysis / image inspection module. As part of the Yocto Project 1.6 release, we are building a web-based graphical user interface for the build analysis / image inspection module.

Toaster is designed as a collection of components that will run independently performing isolated functions. The interfaces between components are documented on this wiki as to ease interoperability with newer components. From design phase, we've taken care to account for further expansion needs, and account for scalability problems.

• Data store investigation results and choices

• Django models

• REST API Contracts

• Bugzilla feature list

Deleting a Build from the Toaster Database

By default, Toaster stores all build data in a toaster.sqlite database file located in the Build Directory.

You can delete builds from the Toaster database using two bespoke commands (buildslist and builddelete) added to

/poky/bitbake/lib/toaster/manage.py

Follow these steps to delete a build:

1. Identify the build: Run the following command from your Build Directory to display a user-readable, tabbed list of build IDs and identification information:

    $ python ../bitbake/lib/toaster/manage.py buildslist

2. Delete a specific build: Using the build ID displayed in the previous step, run the following command to delete a specific build:

    $ python ../bitbake/lib/toaster/manage.py builddelete <build_id>

The build and all related information is deleted from the Toaster database. The deletion operation traverses the ForeignKey relationships recursively.

When using the buildslist and builddelete commands, you need to consider the following:

• For default configurations, your working directory must be the Build Directory. Using these command from the Build Directory allows Toaster to find the toaster.sqlite file, which is located in the Build Directory.

• For other database configurations, it is possible that you can use these commands from a directory other than the Build directory. To do so, the toastermain/settings.py file must be configured to point to the correct database backend.

It is recommended to always call manage.py from the Build Directory.

Testing

Documentation and results related to Toaster Quality Assurance.

• Toaster testing plan

Contributing to Toaster

Toaster is a community effort and welcomes your contribution.

• Contribute to Toaster

Old page content

Design documentation for the Yocto Project 1.5 and 1.6 releases

The document File:Toaster 1.6 content structure.pdf shows the content structure of Toaster in the 1.6 release.

Other design documentation

• Visualisations - an inventory of data visualisations we aim to include in the first release of Toaster
• File:WH roadmap.pdf - the roadmap for Toaster development produced by the London-based agency Tobias&Tobias
• File:Multiuser support in Web Hob.pdf - different design approaches to handle multi-user scenarios
• File:Web Hob content structure.pdf - Toaster information architecture, as it came out from the design project with Tobias&Tobias

Old design documents

• Web_Hob_design_project_with_T&T - The outcome of the design project with the external agency Tobias&Tobias
• A preliminary design project by Jim Kosem

This page is about the Web Hob project. Web Hob is a web-based interface to the Yocto Project.

General discussion about Web Hob happens on a dedicated mailing list: https://lists.yoctoproject.org/listinfo/webhob

There have been 2 main pieces of work related to Web Hob so far:

• A design project with the London-based agency Tobias & Tobias
• A preliminary design project by Jim Kosem

Web Hob information architecture

This document represents the content structure of the Web Hob application.

File:Web Hob content structure.pdf

Different approaches to multi-user workflows

This document outlines the different approaches we have uncovered so far to facilitate multi-user and team work with Web Hob.

• File:Multiuser support in Web Hob.pdf

Visualisations index

The build analysis functionality in Web Hob will include several graphical presentations of build data. The first step to design them is listing them all.