Toaster: Difference between revisions

From Yocto Project
Jump to navigationJump to search
No edit summary
(Updated dead link to old Yocto Project 1.0 docs)
 
(148 intermediate revisions by 11 users not shown)
Line 1: Line 1:
WebHob is a Web-based interface to the Bitbake build system and the Poky distribution inside the Yocto Project.
[[Category:Toaster]]
[[Toaster]] is a web-based interface to OpenEmbedded and BitBake.
[[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 '''Web Hob''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/webhob https://lists.yoctoproject.org/listinfo/webhob]
=== Using Toaster ===


Here are the design documents we follow.
Toaster can run in various modes and setups.


== User Experience Design ==
* '''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:


Design takes place in evolutive steps, and most recent design usually supersedes older ones.
$ source oe-init-build-env
Here is a set of links to the UEx Design pages.
$ source toaster start
* [[Web_Hob_design_project_with_T%26T]] - the current design to be followed in terms of UEx and UI
* [[Visualisations]] - different ways to run visualisations
* [[File:Multiuser_support_in_Web_Hob.pdf]] - preliminary design document
* [[File:Web_Hob_content_structure.pdf]]


=== WebHob mockups ===
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.
* [https://github.com/tobiasandtobias/yocto-clickable-prototype Clickable prototype]


* '''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]].


=== Old  UEx documents ===
=== Toaster How-to's ===
* [[WebHob_Design]]
* [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]


== Architecture and component design ==
Specific pages with Toaster how-tos are available below.
We are planning the capabilities of WebHob 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 1.5, we'll implement a build analysis / image inspection module.


WebHob 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.
* [[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


=== About Toaster ===
[[File:Screenshot toaster analyis.png|thumb|Analysis of builds using Toaster]]


* [[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]]


* [[ WebHob general architecture ]]
=== In progress documentation ===


* [[ WebHob source code repository details ]]
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:


== Installation and Running ==
*[[Using virtualenv]]
 
*[[Setting up a production instance of Toaster]]
We provide a manual for installation and running WebHob as part of this wiki.
*[[manage.py commands]] - this should include an explanation of lsupdates
 
*[[Start Toaster in managed mode]]
== Testing ==
* [[WebHob testing plan ]]
 
 
 
 
== Old page content ==
 
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: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 [[visualisations |listing them all]].

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"