Toaster: Difference between revisions

From Yocto Project
Jump to navigationJump to search
m (Correcting pip install line.)
(Updated dead link to old Yocto Project 1.0 docs)
 
(80 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:Toaster]]
[[Category:Toaster]]
[[Toaster]] is a Web-based interface to the Bitbake build system and the Poky distribution inside the Yocto Project.
[[Toaster]] is a web-based interface to OpenEmbedded and BitBake.
This project was formely known as Web Hob / Webhob / webhob, and you may still find references to the old name in the documentation.
[[File:Screenshot toaster.png|thumb|Screenshot of Toaster 2.1]]
 
General discussion about '''Toaster''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/toaster https://lists.yoctoproject.org/listinfo/toaster]
General discussion about '''Toaster''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/toaster https://lists.yoctoproject.org/listinfo/toaster]


Project planning is available below, are the design documents we follow.
=== Using Toaster ===
 
== User interface ==
The design of the 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
 
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%26T]] - The outcome of the design project with the external agency Tobias&Tobias
* [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]
 
== 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 [https://www.yoctoproject.org/download/toaster-web-interface 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]]
 
== Installation and Running ==
 
Before you start, make sure you install the [http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#intro-requirements packages required by the Yocto Project]


=== Using the master branch ===
Toaster can run in various modes and setups.


==== You need this stuff ready ====
* '''Local mode''' - in this mode Toaster is setup for use as a local development tool. It can be used to configure builds or just as a receiver for builds done on the command line with bitbake. You can launch it like this:


* Django 1.5; easiest way is to install system wide with <code> pip install django=="1.5" </code>
  $ source oe-init-build-env
* Make sure that port 8000 and 8200 are free, i.e. no servers on them
  $ source toaster start


==== To get it up and running ====
You then navigate to the link in your browser (e.g. http://localhost:8000) and configure a project. Or start building in the normal way with bitbake via the command line. Toaster will automatically pick up the builds and you will be able to see them on the build dashboard in your browser.


* clone the master tree: http://git.yoctoproject.org/git/poky
* '''Production mode''' - All the same functionality as the local mode but with the web server setup as a shared service for multiple developers to use, this sets up Toaster as a wsgi application and [[Setting up a production instance of Toaster|requires additional configuration]].
* set up a build as normal: <code>  source poky/oe-init-build-env </code>
* at this point edit <code>local.conf</code>, or layers, etc.
* start Toaster system:  <code> source toaster start </code>
* run builds normally:  <code> bitbake core-image-minimal </code>
* to see the web interface: <code> xdg-open http://localhost:8000/ </code>
* to stop Toaster:  <code> source toaster stop </code>


=== Using the Dora + Toaster release (part of Yocto Project 1.5) ===
=== Toaster How-to's ===


==== You need this stuff ready ====
Specific pages with Toaster how-tos are available below.
 
* Django 1.4.5; easiest way is to install system wide with <code>  pip install django=="1.4.5"  </code>
* Make sure that port 8000 and 8200 are free, i.e. no servers on them
 
==== To get it up and running ====
 
* checkout the Dora + Toaster release tree: http://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=dora-toaster
* set up a build as normal: <code>  source poky/oe-init-build-env </code>
* at this point edit <code>local.conf</code>, or layers, etc.
* start Toaster system:  <code> source toaster start </code>
* run builds normally:  <code> bitbake core-image-minimal </code>
* to see the web interface: <code> xdg-open http://localhost:8000/ </code>
* to stop Toaster:  <code> source toaster stop </code>
 
===Bitbake extra options ===
 
This is an overview of extra options needed for Bitbake. These should be automatically added by Toaster
in a conf/toaster.conf file that is enabled when the system starts through the toaster command.
 
The gritty details are here:
 
[[Toaster]] needs the '''toaster''' bbclass enabled in Bitbake in order to record target image package information.
<code>  INHERIT += "toaster" </code>
 
This enables the '''toaster''' bbclass in Bitbake, needed to record target image package information.
 
<code>  INHERIT += "buildhistory"  </code>
<br />
<code>  BUILDHISTORY_COMMIT = "1" </code>
 
This enables '''buildhistory''' in Bitbake, needed to record target image package information.
This last command is not strictly needed, yet without it '''buildhistory''' will not work right in it's own right.
 
==== A bunch of files are created and used under the build/ directory: ====
 
* toaster.sqlite - the database file
* toaster_web.log - the log file of the web server
* toaster_ui.log - the log file of the ui component
* .toastermain.pid - contains the pid of the web server
* .toasterui.pid    - contains the pid of the DSI data bridge
* bitbake-cookerdaemon.log - the log file of the bitbake server
 
== 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]]
* [[Contribute to Toaster]]
* [[Testing Toaster]]
* [[Setting up a local instance of Toaster]]
* [[Setting up a production instance of Toaster]] - documentation for Interactive mode
* [https://docs.yoctoproject.org/dunfell/toaster-manual/toaster-manual-setup-and-use.html#using-the-toaster-web-interface How to use the Toaster web interface]
* [[How to delete information from the Toaster database]]
* [[How to  support permission management in Build Mode for Toaster]]
* [[ToasterTable]]: Toaster's internal API for adding sortable, filterable, paged tables


== Old page content ==
=== About Toaster ===
 
[[File:Screenshot toaster analyis.png|thumb|Analysis of builds using Toaster]]
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 https://lists.yoctoproject.org/listinfo/webhob]
 
There have been 2 main pieces of work related to Web Hob so far:
 
* [[Web Hob design project with T&T|A design project with the London-based agency Tobias & Tobias]]
* [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ 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:Working_with_design.pdf]]
* [https://bugzilla.yoctoproject.org/buglist.cgi?list_id=213820&columnlist=status_whiteboard%2Cassigned_to%2Ctarget_milestone%2Cbug_status%2Cshort_desc%2Cbug_severity%2Cpriority&classification=Build%20System%20%26%20Metadata&query_based_on=Toaster-Opens&query_format=advanced&bug_status=NEW&bug_status=ACCEPTED&bug_status=IN%20PROGRESS%20DESIGN&bug_status=IN%20PROGRESS%20DESIGN%20COMPLETE&bug_status=IN%20PROGRESS%20IMPLEMENTATION&bug_status=REOPENED&bug_status=NEEDINFO&bug_status=WaitForUpstream&component=toaster&product=Toaster&known_name=Toaster-Opens Bug list]
* [[Toaster architecture design]]
* [[Toaster and bitbake communications]]
* [[Toaster database]]
* [[Toaster testing plan]]


* [[File:Multiuser_support_in_Web_Hob.pdf]]
=== In progress documentation ===


=== Visualisations index ===
We are currently preparing the documentation for the Toaster build functionality. The content here is just a brain dump of what we need to cover (in no particular order). Feel free to add and create content as you see fit:


The build analysis functionality in Web Hob will include several graphical presentations of build data. The first step to design them is [[visualisations |listing them all]].
*[[Using virtualenv]]
*[[Setting up a production instance of Toaster]]
*[[manage.py commands]] - this should include an explanation of lsupdates
*[[Start Toaster in managed mode]]

Latest revision as of 21:51, 30 November 2023

Toaster is a web-based interface to OpenEmbedded and BitBake.

Screenshot of Toaster 2.1

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

Using Toaster

Toaster can run in various modes and setups.

  • Local mode - in this mode Toaster is setup for use as a local development tool. It can be used to configure builds or just as a receiver for builds done on the command line with bitbake. You can launch it like this:
$ source oe-init-build-env
$ source toaster start

You then navigate to the link in your browser (e.g. http://localhost:8000) and configure a project. Or start building in the normal way with bitbake via the command line. Toaster will automatically pick up the builds and you will be able to see them on the build dashboard in your browser.

  • Production mode - All the same functionality as the local mode but with the web server setup as a shared service for multiple developers to use, this sets up Toaster as a wsgi application and requires additional configuration.

Toaster How-to's

Specific pages with Toaster how-tos are available below.

About Toaster

Analysis of builds using Toaster

In progress documentation

We are currently preparing the documentation for the Toaster build functionality. The content here is just a brain dump of what we need to cover (in no particular order). Feel free to add and create content as you see fit:

Retrieved from "https://wiki.yoctoproject.org/wiki/index.php?title=Toaster&oldid=86095"