summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-06-26 19:10:51 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:33 +0100
commit9bd69b1f1d71a9692189beeac75af9dfbad816cc (patch)
tree305347fca899074aed5610e0e82eaec180bf630c /documentation/toaster-manual
parentc40a8d5904c29046f1cbbeb998e6cd7c24f9b206 (diff)
downloadpoky-9bd69b1f1d71a9692189beeac75af9dfbad816cc.tar.gz
sphinx: initial sphinx support
This commit is autogenerated pandoc to generate an inital set of reST files based on DocBook XML files. A .rst file is generated for each .xml files in all manuals with this command: cd <manual> for i in *.xml; do \ pandoc -f docbook -t rst --shift-heading-level-by=-1 \ $i -o $(basename $i .xml).rst \ done The conversion was done with: pandoc 2.9.2.1-91 (Arch Linux). Also created an initial top level index file for each document, and added all 'books' to the top leve index.rst file. The YP manuals layout is organized as: Book Chapter Section Section Section Sphinx uses section headers to create the document structure. ReStructuredText defines sections headers like that: To break longer text up into sections, you use section headers. These are a single line of text (one or more words) with adornment: an underline alone, or an underline and an overline together, in dashes "-----", equals "======", tildes "~~~~~~" or any of the non-alphanumeric characters = - ` : ' " ~ ^ _ * + # < > that you feel comfortable with. An underline-only adornment is distinct from an overline-and-underline adornment using the same character. The underline/overline must be at least as long as the title text. Be consistent, since all sections marked with the same adornment style are deemed to be at the same level: Let's define the following convention when converting from Docbook: Book => overline === (Title) Chapter => overline *** (1.) Section => ==== (1.1) Section => ---- (1.1.1) Section => ~~~~ (1.1.1.1) Section => ^^^^ (1.1.1.1.1) During the conversion with pandoc, we used --shift-heading-level=-1 to convert most of DocBook headings automatically. However with this setting, the Chapter header was removed, so I added it back manually. Without this setting all headings were off by one, which was more difficult to manually fix. At least with this change, we now have the same TOC with Sphinx and DocBook. (From yocto-docs rev: 3c73d64a476d4423ee4c6808c685fa94d88d7df8) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/toaster-manual')
-rw-r--r--documentation/toaster-manual/toaster-manual-intro.rst97
-rw-r--r--documentation/toaster-manual/toaster-manual-reference.rst515
-rw-r--r--documentation/toaster-manual/toaster-manual-setup-and-use.rst495
-rw-r--r--documentation/toaster-manual/toaster-manual-start.rst46
-rw-r--r--documentation/toaster-manual/toaster-manual.rst12
5 files changed, 1165 insertions, 0 deletions
diff --git a/documentation/toaster-manual/toaster-manual-intro.rst b/documentation/toaster-manual/toaster-manual-intro.rst
new file mode 100644
index 0000000000..92d8c94c52
--- /dev/null
+++ b/documentation/toaster-manual/toaster-manual-intro.rst
@@ -0,0 +1,97 @@
1************
2Introduction
3************
4
5Toaster is a web interface to the Yocto Project's `OpenEmbedded build
6system <&YOCTO_DOCS_REF_URL;#build-system-term>`__. The interface
7enables you to configure and run your builds. Information about builds
8is collected and stored in a database. You can use Toaster to configure
9and start builds on multiple remote build servers.
10
11.. _intro-features:
12
13Toaster Features
14================
15
16Toaster allows you to configure and run builds, and it provides
17extensive information about the build process.
18
19- *Configure and Run Builds:* You can use the Toaster web interface to
20 configure and start your builds. Builds started using the Toaster web
21 interface are organized into projects. When you create a project, you
22 are asked to select a release, or version of the build system you
23 want to use for the project builds. As shipped, Toaster supports
24 Yocto Project releases 1.8 and beyond. With the Toaster web
25 interface, you can:
26
27 - Browse layers listed in the various `layer
28 sources <#layer-source>`__ that are available in your project
29 (e.g. the OpenEmbedded Layer Index at
30 ` <http://layers.openembedded.org/layerindex/>`__).
31
32 - Browse images, recipes, and machines provided by those layers.
33
34 - Import your own layers for building.
35
36 - Add and remove layers from your configuration.
37
38 - Set configuration variables.
39
40 - Select a target or multiple targets to build.
41
42 - Start your builds.
43
44 Toaster also allows you to configure and run your builds from the
45 command line, and switch between the command line and the web
46 interface at any time. Builds started from the command line appear
47 within a special Toaster project called "Command line builds".
48
49- *Information About the Build Process:* Toaster also records extensive
50 information about your builds. Toaster collects data for builds you
51 start from the web interface and from the command line as long as
52 Toaster is running.
53
54 .. note::
55
56 You must start Toaster before the build or it will not collect
57 build data.
58
59 With Toaster you can:
60
61 - See what was built (recipes and packages) and what packages were
62 installed into your final image.
63
64 - Browse the directory structure of your image.
65
66 - See the value of all variables in your build configuration, and
67 which files set each value.
68
69 - Examine error, warning, and trace messages to aid in debugging.
70
71 - See information about the BitBake tasks executed and reused during
72 your build, including those that used shared state.
73
74 - See dependency relationships between recipes, packages, and tasks.
75
76 - See performance information such as build time, task time, CPU
77 usage, and disk I/O.
78
79For an overview of Toaster shipped with the Yocto Project DISTRO
80Release, see the "`Toaster - Yocto Project
812.2 <https://youtu.be/BlXdOYLgPxA>`__" video.
82
83.. _toaster-installation-options:
84
85Installation Options
86====================
87
88You can set Toaster up to run as a local instance or as a shared hosted
89service.
90
91When Toaster is set up as a local instance, all the components reside on
92a single build host. Fundamentally, a local instance of Toaster is
93suited for a single user developing on a single build host.
94
95Toaster as a hosted service is suited for multiple users developing
96across several build hosts. When Toaster is set up as a hosted service,
97its components can be spread across several machines:
diff --git a/documentation/toaster-manual/toaster-manual-reference.rst b/documentation/toaster-manual/toaster-manual-reference.rst
new file mode 100644
index 0000000000..bc39903adf
--- /dev/null
+++ b/documentation/toaster-manual/toaster-manual-reference.rst
@@ -0,0 +1,515 @@
1**********************
2Concepts and Reference
3**********************
4
5In order to configure and use Toaster, you should understand some
6concepts and have some basic command reference material available. This
7final chapter provides conceptual information on layer sources,
8releases, and JSON configuration files. Also provided is a quick look at
9some useful ``manage.py`` commands that are Toaster-specific.
10Information on ``manage.py`` commands does exist across the Web and the
11information in this manual by no means attempts to provide a command
12comprehensive reference.
13
14Layer Source
15============
16
17In general, a "layer source" is a source of information about existing
18layers. In particular, we are concerned with layers that you can use
19with the Yocto Project and Toaster. This chapter describes a particular
20type of layer source called a "layer index."
21
22A layer index is a web application that contains information about a set
23of custom layers. A good example of an existing layer index is the
24OpenEmbedded Layer Index. A public instance of this layer index exists
25at ` <http://layers.openembedded.org>`__. You can find the code for this
26layer index's web application at
27` <http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/>`__.
28
29When you tie a layer source into Toaster, it can query the layer source
30through a
31`REST <http://en.wikipedia.org/wiki/Representational_state_transfer>`__
32API, store the information about the layers in the Toaster database, and
33then show the information to users. Users are then able to view that
34information and build layers from Toaster itself without worrying about
35cloning or editing the BitBake layers configuration file
36``bblayers.conf``.
37
38Tying a layer source into Toaster is convenient when you have many
39custom layers that need to be built on a regular basis by a community of
40developers. In fact, Toaster comes pre-configured with the OpenEmbedded
41Metadata Index.
42
43.. note::
44
45 You do not have to use a layer source to use Toaster. Tying into a
46 layer source is optional.
47
48.. _layer-source-using-with-toaster:
49
50Setting Up and Using a Layer Source
51-----------------------------------
52
53To use your own layer source, you need to set up the layer source and
54then tie it into Toaster. This section describes how to tie into a layer
55index in a manner similar to the way Toaster ties into the OpenEmbedded
56Metadata Index.
57
58Understanding Your Layers
59~~~~~~~~~~~~~~~~~~~~~~~~~
60
61The obvious first step for using a layer index is to have several custom
62layers that developers build and access using the Yocto Project on a
63regular basis. This set of layers needs to exist and you need to be
64familiar with where they reside. You will need that information when you
65set up the code for the web application that "hooks" into your set of
66layers.
67
68For general information on layers, see the "`The Yocto Project Layer
69Model <&YOCTO_DOCS_OM_URL;#the-yocto-project-layer-model>`__" section in
70the Yocto Project Overview and Concepts Manual. For information on how
71to create layers, see the "`Understanding and Creating
72Layers <&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers>`__"
73section in the Yocto Project Development Tasks Manual.
74
75.. _configuring-toaster-to-hook-into-your-layer-source:
76
77Configuring Toaster to Hook Into Your Layer Index
78~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
79
80If you want Toaster to use your layer index, you must host the web
81application in a server to which Toaster can connect. You also need to
82give Toaster the information about your layer index. In other words, you
83have to configure Toaster to use your layer index. This section
84describes two methods by which you can configure and use your layer
85index.
86
87In the previous section, the code for the OpenEmbedded Metadata Index
88(i.e. ` <http://layers.openembedded.org>`__) was referenced. You can use
89this code, which is at
90` <http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/>`__, as a
91base to create your own layer index.
92
93Use the Administration Interface
94^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
95
96Access the administration interface through a browser by entering the
97URL of your Toaster instance and adding "``/admin``" to the end of the
98URL. As an example, if you are running Toaster locally, use the
99following URL: http://127.0.0.1:8000/admin
100
101The administration interface has a "Layer sources" section that includes
102an "Add layer source" button. Click that button and provide the required
103information. Make sure you select "layerindex" as the layer source type.
104
105Use the Fixture Feature
106^^^^^^^^^^^^^^^^^^^^^^^
107
108The Django fixture feature overrides the default layer server when you
109use it to specify a custom URL. To use the fixture feature, create (or
110edit) the file ``bitbake/lib/toaster.orm/fixtures/custom.xml``, and then
111set the following Toaster setting to your custom URL: <?xml
112version="1.0" ?> <django-objects version="1.0"> <object
113model="orm.toastersetting" pk="100"> <field name="name"
114type="CharField">CUSTOM_LAYERINDEX_SERVER</field> <field name="value"
115type="CharField">https://layers.my_organization.org/layerindex/branch/master/layers/</field>
116</object> <django-objects> When you start Toaster for the first time, or
117if you delete the file ``toaster.sqlite`` and restart, the database will
118populate cleanly from this layer index server.
119
120Once the information has been updated, verify the new layer information
121is available by using the Toaster web interface. To do that, visit the
122"All compatible layers" page inside a Toaster project. The layers from
123your layer source should be listed there.
124
125If you change the information in your layer index server, refresh the
126Toaster database by running the following command: $
127bitbake/lib/toaster/manage.py lsupdates If Toaster can reach the API
128URL, you should see a message telling you that Toaster is updating the
129layer source information.
130
131.. _toaster-releases:
132
133Releases
134========
135
136When you create a Toaster project using the web interface, you are asked
137to choose a "Release." In the context of Toaster, the term "Release"
138refers to a set of layers and a BitBake version the OpenEmbedded build
139system uses to build something. As shipped, Toaster is pre-configured
140with releases that correspond to Yocto Project release branches.
141However, you can modify, delete, and create new releases according to
142your needs. This section provides some background information on
143releases.
144
145.. _toaster-releases-supported:
146
147Pre-Configured Releases
148-----------------------
149
150As shipped, Toaster is configured to use a specific set of releases. Of
151course, you can always configure Toaster to use any release. For
152example, you might want your project to build against a specific commit
153of any of the "out-of-the-box" releases. Or, you might want your project
154to build against different revisions of OpenEmbedded and BitBake.
155
156As shipped, Toaster is configured to work with the following releases:
157
158- *Yocto Project DISTRO "DISTRO_NAME" or OpenEmbedded "DISTRO_NAME":*
159 This release causes your Toaster projects to build against the head
160 of the DISTRO_NAME_NO_CAP branch at
161 ` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/log/?h=rocko>`__ or
162 ` <http://git.openembedded.org/openembedded-core/commit/?h=rocko>`__.
163
164- *Yocto Project "Master" or OpenEmbedded "Master":* This release
165 causes your Toaster Projects to build against the head of the master
166 branch, which is where active development takes place, at
167 ` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/log/>`__ or
168 ` <http://git.openembedded.org/openembedded-core/log/>`__.
169
170- *Local Yocto Project or Local OpenEmbedded:* This release causes your
171 Toaster Projects to build against the head of the ``poky`` or
172 ``openembedded-core`` clone you have local to the machine running
173 Toaster.
174
175Configuring Toaster
176===================
177
178In order to use Toaster, you must configure the database with the
179default content. The following subsections describe various aspects of
180Toaster configuration.
181
182Configuring the Workflow
183------------------------
184
185The ``bldcontrol/management/commands/checksettings.py`` file controls
186workflow configuration. The following steps outline the process to
187initially populate this database.
188
1891. The default project settings are set from
190 ``orm/fixtures/settings.xml``.
191
1922. The default project distro and layers are added from
193 ``orm/fixtures/poky.xml`` if poky is installed. If poky is not
194 installed, they are added from ``orm/fixtures/oe-core.xml``.
195
1963. If the ``orm/fixtures/custom.xml`` file exists, then its values are
197 added.
198
1994. The layer index is then scanned and added to the database.
200
201Once these steps complete, Toaster is set up and ready to use.
202
203Customizing Pre-Set Data
204------------------------
205
206The pre-set data for Toaster is easily customizable. You can create the
207``orm/fixtures/custom.xml`` file to customize the values that go into to
208the database. Customization is additive, and can either extend or
209completely replace the existing values.
210
211You use the ``orm/fixtures/custom.xml`` file to change the default
212project settings for the machine, distro, file images, and layers. When
213creating a new project, you can use the file to define the offered
214alternate project release selections. For example, you can add one or
215more additional selections that present custom layer sets or distros,
216and any other local or proprietary content.
217
218Additionally, you can completely disable the content from the
219``oe-core.xml`` and ``poky.xml`` files by defining the section shown
220below in the ``settings.xml`` file. For example, this option is
221particularly useful if your custom configuration defines fewer releases
222or layers than the default fixture files.
223
224The following example sets "name" to "CUSTOM_XML_ONLY" and its value to
225"True". <object model="orm.toastersetting" pk="99"> <field
226type="CharField" name="name">CUSTOM_XML_ONLY</field> <field
227type="CharField" name="value">True</field> </object>
228
229Understanding Fixture File Format
230---------------------------------
231
232The following is an overview of the file format used by the
233``oe-core.xml``, ``poky.xml``, and ``custom.xml`` files.
234
235The following subsections describe each of the sections in the fixture
236files, and outline an example section of the XML code. you can use to
237help understand this information and create a local ``custom.xml`` file.
238
239Defining the Default Distro and Other Values
240~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
241
242This section defines the default distro value for new projects. By
243default, it reserves the first Toaster Setting record "1". The following
244demonstrates how to set the project default value for
245```DISTRO`` <&YOCTO_DOCS_REF_URL;#var-DISTRO>`__: <!-- Set the project
246default value for DISTRO --> <object model="orm.toastersetting" pk="1">
247<field type="CharField" name="name">DEFCONF_DISTRO</field> <field
248type="CharField" name="value">poky</field> </object> You can override
249other default project values by adding additional Toaster Setting
250sections such as any of the settings coming from the ``settings.xml``
251file. Also, you can add custom values that are included in the BitBake
252environment. The "pk" values must be unique. By convention, values that
253set default project values have a "DEFCONF" prefix.
254
255Defining BitBake Version
256~~~~~~~~~~~~~~~~~~~~~~~~
257
258The following defines which version of BitBake is used for the following
259release selection: <!-- Bitbake versions which correspond to the
260metadata release --> <object model="orm.bitbakeversion" pk="1"> <field
261type="CharField" name="name">rocko</field> <field type="CharField"
262name="giturl">git://git.yoctoproject.org/poky</field> <field
263type="CharField" name="branch">rocko</field> <field type="CharField"
264name="dirpath">bitbake</field> </object>
265
266.. _defining-releases:
267
268Defining Release
269~~~~~~~~~~~~~~~~
270
271The following defines the releases when you create a new project. <!--
272Releases available --> <object model="orm.release" pk="1"> <field
273type="CharField" name="name">rocko</field> <field type="CharField"
274name="description">Yocto Project 2.4 "Rocko"</field> <field
275rel="ManyToOneRel" to="orm.bitbakeversion"
276name="bitbake_version">1</field> <field type="CharField"
277name="branch_name">rocko</field> <field type="TextField"
278name="helptext">Toaster will run your builds using the tip of the <a
279href="http://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=rocko">Yocto
280Project Rocko branch</a>.</field> </object> The "pk" value must match
281the above respective BitBake version record.
282
283Defining the Release Default Layer Names
284~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
285
286The following defines the default layers for each release: <!-- Default
287project layers for each release --> <object
288model="orm.releasedefaultlayer" pk="1"> <field rel="ManyToOneRel"
289to="orm.release" name="release">1</field> <field type="CharField"
290name="layer_name">openembedded-core</field> </object> The 'pk' values in
291the example above should start at "1" and increment uniquely. You can
292use the same layer name in multiple releases.
293
294Defining Layer Definitions
295~~~~~~~~~~~~~~~~~~~~~~~~~~
296
297Layer definitions are the most complex. The following defines each of
298the layers, and then defines the exact layer version of the layer used
299for each respective release. You must have one ``orm.layer`` entry for
300each layer. Then, with each entry you need a set of
301``orm.layer_version`` entries that connects the layer with each release
302that includes the layer. In general all releases include the layer.
303<object model="orm.layer" pk="1"> <field type="CharField"
304name="name">openembedded-core</field> <field type="CharField"
305name="layer_index_url"></field> <field type="CharField"
306name="vcs_url">git://git.yoctoproject.org/poky</field> <field
307type="CharField"
308name="vcs_web_url">http://git.yoctoproject.org/cgit/cgit.cgi/poky</field>
309<field type="CharField"
310name="vcs_web_tree_base_url">http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/%path%?h=%branch%</field>
311<field type="CharField"
312name="vcs_web_file_base_url">http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/%path%?h=%branch%</field>
313</object> <object model="orm.layer_version" pk="1"> <field
314rel="ManyToOneRel" to="orm.layer" name="layer">1</field> <field
315type="IntegerField" name="layer_source">0</field> <field
316rel="ManyToOneRel" to="orm.release" name="release">1</field> <field
317type="CharField" name="branch">rocko</field> <field type="CharField"
318name="dirpath">meta</field> </object> <object model="orm.layer_version"
319pk="2"> <field rel="ManyToOneRel" to="orm.layer" name="layer">1</field>
320<field type="IntegerField" name="layer_source">0</field> <field
321rel="ManyToOneRel" to="orm.release" name="release">2</field> <field
322type="CharField" name="branch">HEAD</field> <field type="CharField"
323name="commit">HEAD</field> <field type="CharField"
324name="dirpath">meta</field> </object> <object model="orm.layer_version"
325pk="3"> <field rel="ManyToOneRel" to="orm.layer" name="layer">1</field>
326<field type="IntegerField" name="layer_source">0</field> <field
327rel="ManyToOneRel" to="orm.release" name="release">3</field> <field
328type="CharField" name="branch">master</field> <field type="CharField"
329name="dirpath">meta</field> </object> The layer "pk" values above must
330be unique, and typically start at "1". The layer version "pk" values
331must also be unique across all layers, and typically start at "1".
332
333Remote Toaster Monitoring
334=========================
335
336Toaster has an API that allows remote management applications to
337directly query the state of the Toaster server and its builds in a
338machine-to-machine manner. This API uses the
339`REST <http://en.wikipedia.org/wiki/Representational_state_transfer>`__
340interface and the transfer of JSON files. For example, you might monitor
341a build inside a container through well supported known HTTP ports in
342order to easily access a Toaster server inside the container. In this
343example, when you use this direct JSON API, you avoid having web page
344parsing against the display the user sees.
345
346Checking Health
347---------------
348
349Before you use remote Toaster monitoring, you should do a health check.
350To do this, ping the Toaster server using the following call to see if
351it is still alive: http://host:port/health Be sure to provide values for
352host and port. If the server is alive, you will get the response HTML:
353<!DOCTYPE html> <html lang="en"> <head><title>Toaster
354Health</title></head> <body>Ok</body> </html>
355
356Determining Status of Builds in Progress
357----------------------------------------
358
359Sometimes it is useful to determine the status of a build in progress.
360To get the status of pending builds, use the following call:
361http://host:port/toastergui/api/building Be sure to provide values for
362host and port. The output is a JSON file that itemizes all builds in
363progress. This file includes the time in seconds since each respective
364build started as well as the progress of the cloning, parsing, and task
365execution. The following is sample output for a build in progress:
366{"count": 1, "building": [ {"machine": "beaglebone", "seconds":
367"463.869", "task": "927:2384", "distro": "poky", "clone": "1:1", "id":
3682, "start": "2017-09-22T09:31:44.887Z", "name": "20170922093200",
369"parse": "818:818", "project": "my_rocko", "target":
370"core-image-minimal" }] } The JSON data for this query is returned in a
371single line. In the previous example the line has been artificially
372split for readability.
373
374Checking Status of Builds Completed
375-----------------------------------
376
377Once a build is completed, you get the status when you use the following
378call: http://host:port/toastergui/api/builds Be sure to provide values
379for host and port. The output is a JSON file that itemizes all complete
380builds, and includes build summary information. The following is sample
381output for a completed build: {"count": 1, "builds": [ {"distro":
382"poky", "errors": 0, "machine": "beaglebone", "project": "my_rocko",
383"stop": "2017-09-22T09:26:36.017Z", "target": "quilt-native", "seconds":
384"78.193", "outcome": "Succeeded", "id": 1, "start":
385"2017-09-22T09:25:17.824Z", "warnings": 1, "name": "20170922092618" }] }
386The JSON data for this query is returned in a single line. In the
387previous example the line has been artificially split for readability.
388
389Determining Status of a Specific Build
390--------------------------------------
391
392Sometimes it is useful to determine the status of a specific build. To
393get the status of a specific build, use the following call:
394http://host:port/toastergui/api/build/ID Be sure to provide values for
395host, port, and ID. You can find the value for ID from the Builds
396Completed query. See the "`Checking Status of Builds
397Completed <#checking-status-of-builds-completed>`__" section for more
398information.
399
400The output is a JSON file that itemizes the specific build and includes
401build summary information. The following is sample output for a specific
402build: {"build": {"distro": "poky", "errors": 0, "machine":
403"beaglebone", "project": "my_rocko", "stop": "2017-09-22T09:26:36.017Z",
404"target": "quilt-native", "seconds": "78.193", "outcome": "Succeeded",
405"id": 1, "start": "2017-09-22T09:25:17.824Z", "warnings": 1, "name":
406"20170922092618", "cooker_log":
407"/opt/user/poky/build-toaster-2/tmp/log/cooker/beaglebone/build_20170922_022607.991.log"
408} } The JSON data for this query is returned in a single line. In the
409previous example the line has been artificially split for readability.
410
411.. _toaster-useful-commands:
412
413Useful Commands
414===============
415
416In addition to the web user interface and the scripts that start and
417stop Toaster, command-line commands exist through the ``manage.py``
418management script. You can find general documentation on ``manage.py``
419at the
420`Django <https://docs.djangoproject.com/en/1.7/topics/settings/>`__
421site. However, several ``manage.py`` commands have been created that are
422specific to Toaster and are used to control configuration and back-end
423tasks. You can locate these commands in the `Source
424Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ (e.g. ``poky``) at
425``bitbake/lib/manage.py``. This section documents those commands.
426
427.. note::
428
429 - When using ``manage.py`` commands given a default configuration,
430 you must be sure that your working directory is set to the `Build
431 Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__. Using
432 ``manage.py`` commands from the Build Directory allows Toaster to
433 find the ``toaster.sqlite`` file, which is located in the Build
434 Directory.
435
436 - For non-default database configurations, it is possible that you
437 can use ``manage.py`` commands from a directory other than the
438 Build Directory. To do so, the ``toastermain/settings.py`` file
439 must be configured to point to the correct database backend.
440
441.. _toaster-command-buildslist:
442
443``buildslist``
444--------------
445
446The ``buildslist`` command lists all builds that Toaster has recorded.
447Access the command as follows: $ bitbake/lib/toaster/manage.py
448buildslist The command returns a list, which includes numeric
449identifications, of the builds that Toaster has recorded in the current
450database.
451
452You need to run the ``buildslist`` command first to identify existing
453builds in the database before using the
454```builddelete`` <#toaster-command-builddelete>`__ command. Here is an
455example that assumes default repository and build directory names: $ cd
456~/poky/build $ python ../bitbake/lib/toaster/manage.py buildslist If
457your Toaster database had only one build, the above ``buildslist``
458command would return something like the following: 1: qemux86 poky
459core-image-minimal
460
461.. _toaster-command-builddelete:
462
463``builddelete``
464---------------
465
466The ``builddelete`` command deletes data associated with a build. Access
467the command as follows: $ bitbake/lib/toaster/manage.py builddelete
468build_id The command deletes all the build data for the specified
469build_id. This command is useful for removing old and unused data from
470the database.
471
472Prior to running the ``builddelete`` command, you need to get the ID
473associated with builds by using the
474```buildslist`` <#toaster-command-buildslist>`__ command.
475
476.. _toaster-command-perf:
477
478``perf``
479--------
480
481The ``perf`` command measures Toaster performance. Access the command as
482follows: $ bitbake/lib/toaster/manage.py perf The command is a sanity
483check that returns page loading times in order to identify performance
484problems.
485
486.. _toaster-command-checksettings:
487
488``checksettings``
489-----------------
490
491The ``checksettings`` command verifies existing Toaster settings. Access
492the command as follows: $ bitbake/lib/toaster/manage.py checksettings
493Toaster uses settings that are based on the database to configure the
494building tasks. The ``checksettings`` command verifies that the database
495settings are valid in the sense that they have the minimal information
496needed to start a build.
497
498In order for the ``checksettings`` command to work, the database must be
499correctly set up and not have existing data. To be sure the database is
500ready, you can run the following: $ bitbake/lib/toaster/mana​ge.py
501syncdb $ bitbake/lib/toaster/mana​ge.py migrate orm $
502bitbake/lib/toaster/mana​ge.py migrate bldcontrol After running these
503commands, you can run the ``checksettings`` command.
504
505.. _toaster-command-runbuilds:
506
507``runbuilds``
508-------------
509
510The ``runbuilds`` command launches scheduled builds. Access the command
511as follows: $ bitbake/lib/toaster/manage.py runbuilds The ``runbuilds``
512command checks if scheduled builds exist in the database and then
513launches them per schedule. The command returns after the builds start
514but before they complete. The Toaster Logging Interface records and
515updates the database when the builds complete.
diff --git a/documentation/toaster-manual/toaster-manual-setup-and-use.rst b/documentation/toaster-manual/toaster-manual-setup-and-use.rst
new file mode 100644
index 0000000000..b36160b697
--- /dev/null
+++ b/documentation/toaster-manual/toaster-manual-setup-and-use.rst
@@ -0,0 +1,495 @@
1****************************
2Setting Up and Using Toaster
3****************************
4
5Starting Toaster for Local Development
6======================================
7
8Once you have set up the Yocto Project and installed the Toaster system
9dependencies as described in the "`Preparing to Use
10Toaster <#toaster-manual-start>`__" chapter, you are ready to start
11Toaster.
12
13Navigate to the root of your `Source
14Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ (e.g. ``poky``): $
15cd poky Once in that directory, source the build environment script: $
16source oe-init-build-env Next, from the build directory (e.g.
17``poky/build``), start Toaster using this command: $ source toaster
18start You can now run your builds from the command line, or with Toaster
19as explained in section "`Using the Toaster Web
20Interface <#using-the-toaster-web-interface>`__".
21
22To access the Toaster web interface, open your favorite browser and
23enter the following: http://127.0.0.1:8000
24
25Setting a Different Port
26========================
27
28By default, Toaster starts on port 8000. You can use the ``WEBPORT``
29parameter to set a different port. For example, the following command
30sets the port to "8400": $ source toaster start webport=8400
31
32Setting Up Toaster Without a Web Server
33=======================================
34
35You can start a Toaster environment without starting its web server.
36This is useful for the following:
37
38- Capturing a command-line build’s statistics into the Toaster database
39 for examination later.
40
41- Capturing a command-line build’s statistics when the Toaster server
42 is already running.
43
44- Having one instance of the Toaster web server track and capture
45 multiple command-line builds, where each build is started in its own
46 “noweb” Toaster environment.
47
48The following commands show how to start a Toaster environment without
49starting its web server, perform BitBake operations, and then shut down
50the Toaster environment. Once the build is complete, you can close the
51Toaster environment. Before closing the environment, however, you should
52allow a few minutes to ensure the complete transfer of its BitBake build
53statistics to the Toaster database. If you have a separate Toaster web
54server instance running, you can watch this command-line build’s
55progress and examine the results as soon as they are posted: $ source
56toaster start noweb $ bitbake target $ source toaster stop
57
58Setting Up Toaster Without a Build Server
59=========================================
60
61You can start a Toaster environment with the “New Projects” feature
62disabled. Doing so is useful for the following:
63
64- Sharing your build results over the web server while blocking others
65 from starting builds on your host.
66
67- Allowing only local command-line builds to be captured into the
68 Toaster database.
69
70Use the following command to set up Toaster without a build server: $
71source toaster start nobuild webport=port
72
73Setting up External Access
74==========================
75
76By default, Toaster binds to the loop back address (i.e. localhost),
77which does not allow access from external hosts. To allow external
78access, use the ``WEBPORT`` parameter to open an address that connects
79to the network, specifically the IP address that your NIC uses to
80connect to the network. You can also bind to all IP addresses the
81computer supports by using the shortcut "0.0.0.0:port".
82
83The following example binds to all IP addresses on the host: $ source
84toaster start webport=0.0.0.0:8400 This example binds to a specific IP
85address on the host's NIC: $ source toaster start
86webport=192.168.1.1:8400
87
88The Directory for Cloning Layers
89================================
90
91Toaster creates a ``_toaster_clones`` directory inside your Source
92Directory (i.e. ``poky``) to clone any layers needed for your builds.
93
94Alternatively, if you would like all of your Toaster related files and
95directories to be in a particular location other than the default, you
96can set the ``TOASTER_DIR`` environment variable, which takes precedence
97over your current working directory. Setting this environment variable
98causes Toaster to create and use ``$TOASTER_DIR./_toaster_clones``.
99
100.. _toaster-the-build-directory:
101
102The Build Directory
103===================
104
105Toaster creates a build directory within your Source Directory (e.g.
106``poky``) to execute the builds.
107
108Alternatively, if you would like all of your Toaster related files and
109directories to be in a particular location, you can set the
110``TOASTER_DIR`` environment variable, which takes precedence over your
111current working directory. Setting this environment variable causes
112Toaster to use ``$TOASTER_DIR/build`` as the build directory.
113
114.. _toaster-creating-a-django-super-user:
115
116Creating a Django Superuser
117===========================
118
119Toaster is built on the `Django
120framework <https://www.djangoproject.com/>`__. Django provides an
121administration interface you can use to edit Toaster configuration
122parameters.
123
124To access the Django administration interface, you must create a
125superuser by following these steps:
126
1271. If you used ``pip3``, which is recommended, to set up the Toaster
128 system dependencies, you need be sure the local user path is in your
129 ``PATH`` list. To append the pip3 local user path, use the following
130 command: $ export PATH=$PATH:$HOME/.local/bin
131
1322. From the directory containing the Toaster database, which by default
133 is the `Build Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__,
134 invoke the ``createsuperuser`` command from ``manage.py``: $ cd
135 ~/poky/build $ ../bitbake/lib/toaster/manage.py createsuperuser
136
1373. Django prompts you for the username, which you need to provide.
138
1394. Django prompts you for an email address, which is optional.
140
1415. Django prompts you for a password, which you must provide.
142
1436. Django prompts you to re-enter your password for verification.
144
145After completing these steps, the following confirmation message
146appears: Superuser created successfully.
147
148Creating a superuser allows you to access the Django administration
149interface through a browser. The URL for this interface is the same as
150the URL used for the Toaster instance with "/admin" on the end. For
151example, if you are running Toaster locally, use the following URL:
152http://127.0.0.1:8000/admin You can use the Django administration
153interface to set Toaster configuration parameters such as the build
154directory, layer sources, default variable values, and BitBake versions.
155
156.. _toaster-setting-up-a-production-instance-of-toaster:
157
158Setting Up a Production Instance of Toaster
159===========================================
160
161You can use a production instance of Toaster to share the Toaster
162instance with remote users, multiple users, or both. The production
163instance is also the setup that can handle heavier loads on the web
164service. Use the instructions in the following sections to set up
165Toaster to run builds through the Toaster web interface.
166
167.. _toaster-production-instance-requirements:
168
169Requirements
170------------
171
172Be sure you meet the following requirements:
173
174.. note::
175
176 You must comply with all Apache,
177 mod-wsgi
178 , and Mysql requirements.
179
180- Have all the build requirements as described in the "`Preparing to
181 Use Toaster <#toaster-manual-start>`__" chapter.
182
183- Have an Apache webserver.
184
185- Have ``mod-wsgi`` for the Apache webserver.
186
187- Use the Mysql database server.
188
189- If you are using Ubuntu 16.04, run the following: $ sudo apt-get
190 install apache2 libapache2-mod-wsgi-py3 mysql-server python3-pip
191 libmysqlclient-dev
192
193- If you are using Fedora 24 or a RedHat distribution, run the
194 following: $ sudo dnf install httpd python3-mod_wsgi python3-pip
195 mariadb-server mariadb-devel python3-devel
196
197- If you are using openSUSE Leap 42.1, run the following: $ sudo zypper
198 install apache2 apache2-mod_wsgi-python3 python3-pip mariadb
199 mariadb-client python3-devel
200
201.. _toaster-installation-steps:
202
203Installation
204------------
205
206Perform the following steps to install Toaster:
207
2081. Create toaster user and set its home directory to
209 ``/var/www/toaster``: $ sudo /usr/sbin/useradd toaster -md
210 /var/www/toaster -s /bin/false $ sudo su - toaster -s /bin/bash
211
2122. Checkout a copy of ``poky`` into the web server directory. You will
213 be using ``/var/www/toaster``: $ git clone
214 git://git.yoctoproject.org/poky $ git checkout DISTRO_NAME_NO_CAP
215
2163. Install Toaster dependencies using the --user flag which keeps the
217 Python packages isolated from your system-provided packages: $ cd
218 /var/www/toaster/ $ pip3 install --user -r
219 ./poky/bitbake/toaster-requirements.txt $ pip3 install --user
220 mysqlclient
221
222 .. note::
223
224 Isolating these packages is not required but is recommended.
225 Alternatively, you can use your operating system's package
226 manager to install the packages.
227
2284. Configure Toaster by editing
229 ``/var/www/toaster/poky/bitbake/lib/toaster/toastermain/settings.py``
230 as follows:
231
232 - Edit the
233 `DATABASES <https://docs.djangoproject.com/en/1.11/ref/settings/#databases>`__
234 settings: DATABASES = { 'default': { 'ENGINE':
235 'django.db.backends.mysql', 'NAME': 'toaster_data', 'USER':
236 'toaster', 'PASSWORD': 'yourpasswordhere', 'HOST': 'localhost',
237 'PORT': '3306', } }
238
239 - Edit the
240 `SECRET_KEY <https://docs.djangoproject.com/en/1.11/ref/settings/#std:setting-SECRET_KEY>`__:
241 SECRET_KEY = 'your_secret_key'
242
243 - Edit the
244 `STATIC_ROOT <https://docs.djangoproject.com/en/1.11/ref/settings/#std:setting-STATIC_ROOT>`__:
245 STATIC_ROOT = '/var/www/toaster/static_files/'
246
2475. Add the database and user to the ``mysql`` server defined earlier: $
248 mysql -u root -p mysql> CREATE DATABASE toaster_data; mysql> CREATE
249 USER 'toaster'@'localhost' identified by 'yourpasswordhere'; mysql>
250 GRANT all on toaster_data.\* to 'toaster'@'localhost'; mysql> quit
251
2526. Get Toaster to create the database schema, default data, and gather
253 the statically-served files: $ cd /var/www/toaster/poky/ $
254 ./bitbake/lib/toaster/manage.py migrate $ TOASTER_DIR=`pwd\`
255 TEMPLATECONF='poky' \\ ./bitbake/lib/toaster/manage.py checksettings
256 $ ./bitbake/lib/toaster/manage.py collectstatic In the previous
257 example, from the ``poky`` directory, the ``migrate`` command
258 ensures the database schema changes have propagated correctly (i.e.
259 migrations). The next line sets the Toaster root directory
260 ``TOASTER_DIR`` and the location of the Toaster configuration file
261 ``TOASTER_CONF``, which is relative to ``TOASTER_DIR``. The
262 ``TEMPLATECONF`` value reflects the contents of
263 ``poky/.templateconf``, and by default, should include the string
264 "poky". For more information on the Toaster configuration file, see
265 the "`Configuring Toaster <#configuring-toaster>`__" section.
266
267 This line also runs the ``checksettings`` command, which configures
268 the location of the Toaster `Build
269 Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__. The Toaster
270 root directory ``TOASTER_DIR`` determines where the Toaster build
271 directory is created on the file system. In the example above,
272 ``TOASTER_DIR`` is set as follows: /var/www/toaster/poky This
273 setting causes the Toaster build directory to be:
274 /var/www/toaster/poky/build
275
276 Finally, the ``collectstatic`` command is a Django framework command
277 that collects all the statically served files into a designated
278 directory to be served up by the Apache web server as defined by
279 ``STATIC_ROOT``.
280
2817. Test and/or use the Mysql integration with Toaster’s Django web
282 server. At this point, you can start up the normal Toaster Django
283 web server with the Toaster database in Mysql. You can use this web
284 server to confirm that the database migration and data population
285 from the Layer Index is complete.
286
287 To start the default Toaster Django web server with the Toaster
288 database now in Mysql, use the standard start commands: $ source
289 oe-init-build-env $ source toaster start Additionally, if Django is
290 sufficient for your requirements, you can use it for your release
291 system and migrate later to Apache as your requirements change.
292
2938. Add an Apache configuration file for Toaster to your Apache web
294 server's configuration directory. If you are using Ubuntu or Debian,
295 put the file here: /etc/apache2/conf-available/toaster.conf If you
296 are using Fedora or RedHat, put it here:
297 /etc/httpd/conf.d/toaster.conf If you are using OpenSUSE, put it
298 here: /etc/apache2/conf.d/toaster.conf Following is a sample Apache
299 configuration for Toaster you can follow: Alias /static
300 /var/www/toaster/static_files <Directory
301 /var/www/toaster/static_files> <IfModule mod_access_compat.c> Order
302 allow,deny Allow from all </IfModule> <IfModule
303 !mod_access_compat.c> Require all granted </IfModule> </Directory>
304 <Directory /var/www/toaster/poky/bitbake/lib/toaster/toastermain>
305 <Files "wsgi.py"> Require all granted </Files> </Directory>
306 WSGIDaemonProcess toaster_wsgi
307 python-path=/var/www/toaster/poky/bitbake/lib/toaster:/var/www/toaster/.local/lib/python3.4/site-packages
308 WSGIScriptAlias /
309 "/var/www/toaster/poky/bitbake/lib/toaster/toastermain/wsgi.py"
310 <Location /> WSGIProcessGroup toaster_wsgi </Location> If you are
311 using Ubuntu or Debian, you will need to enable the config and
312 module for Apache: $ sudo a2enmod wsgi $ sudo a2enconf toaster $
313 chmod +x bitbake/lib/toaster/toastermain/wsgi.py Finally, restart
314 Apache to make sure all new configuration is loaded. For Ubuntu,
315 Debian, and OpenSUSE use: $ sudo service apache2 restart For Fedora
316 and RedHat use: $ sudo service httpd restart
317
3189. Prepare the systemd service to run Toaster builds. Here is a sample
319 configuration file for the service: [Unit] Description=Toaster
320 runbuilds [Service] Type=forking User=toaster
321 ExecStart=/usr/bin/screen -d -m -S runbuilds
322 /var/www/toaster/poky/bitbake/lib/toaster/runbuilds-service.sh start
323 ExecStop=/usr/bin/screen -S runbuilds -X quit
324 WorkingDirectory=/var/www/toaster/poky [Install]
325 WantedBy=multi-user.target Prepare the ``runbuilds-service.sh``
326 script that you need to place in the
327 ``/var/www/toaster/poky/bitbake/lib/toaster/`` directory by setting
328 up executable permissions: #!/bin/bash #export
329 http_proxy=http://proxy.host.com:8080 #export
330 https_proxy=http://proxy.host.com:8080 #export
331 GIT_PROXY_COMMAND=$HOME/bin/gitproxy cd ~/poky/ source
332 ./oe-init-build-env build source ../bitbake/bin/toaster $1 noweb [
333 "$1" == 'start' ] && /bin/bash
334
33510. Run the service: # service runbuilds start Since the service is
336 running in a detached screen session, you can attach to it using
337 this command: $ sudo su - toaster $ screen -rS runbuilds You can
338 detach from the service again using "Ctrl-a" followed by "d" key
339 combination.
340
341You can now open up a browser and start using Toaster.
342
343Using the Toaster Web Interface
344===============================
345
346The Toaster web interface allows you to do the following:
347
348- Browse published layers in the `OpenEmbedded Layer
349 Index <http://layers.openembedded.org>`__ that are available for your
350 selected version of the build system.
351
352- Import your own layers for building.
353
354- Add and remove layers from your configuration.
355
356- Set configuration variables.
357
358- Select a target or multiple targets to build.
359
360- Start your builds.
361
362- See what was built (recipes and packages) and what packages were
363 installed into your final image.
364
365- Browse the directory structure of your image.
366
367- See the value of all variables in your build configuration, and which
368 files set each value.
369
370- Examine error, warning and trace messages to aid in debugging.
371
372- See information about the BitBake tasks executed and reused during
373 your build, including those that used shared state.
374
375- See dependency relationships between recipes, packages and tasks.
376
377- See performance information such as build time, task time, CPU usage,
378 and disk I/O.
379
380.. _web-interface-videos:
381
382Toaster Web Interface Videos
383----------------------------
384
385Following are several videos that show how to use the Toaster GUI:
386
387- *Build Configuration:* This
388 `video <https://www.youtube.com/watch?v=qYgDZ8YzV6w>`__ overviews and
389 demonstrates build configuration for Toaster.
390
391- *Build Custom Layers:* This
392 `video <https://www.youtube.com/watch?v=QJzaE_XjX5c>`__ shows you how
393 to build custom layers that are used with Toaster.
394
395- *Toaster Homepage and Table Controls:* This
396 `video <https://www.youtube.com/watch?v=QEARDnrR1Xw>`__ goes over the
397 Toaster entry page, and provides an overview of the data manipulation
398 capabilities of Toaster, which include search, sorting and filtering
399 by different criteria.
400
401- *Build Dashboard:* This
402 `video <https://www.youtube.com/watch?v=KKqHYcnp2gE>`__ shows you the
403 build dashboard, a page providing an overview of the information
404 available for a selected build.
405
406- *Image Information:* This
407 `video <https://www.youtube.com/watch?v=XqYGFsmA0Rw>`__ walks through
408 the information Toaster provides about images: packages installed and
409 root file system.
410
411- *Configuration:* This
412 `video <https://www.youtube.com/watch?v=UW-j-T2TzIg>`__ provides
413 Toaster build configuration information.
414
415- *Tasks:* This `video <https://www.youtube.com/watch?v=D4-9vGSxQtw>`__
416 shows the information Toaster provides about the tasks run by the
417 build system.
418
419- *Recipes and Packages Built:* This
420 `video <https://www.youtube.com/watch?v=x-6dx4huNnw>`__ shows the
421 information Toaster provides about recipes and packages built.
422
423- *Performance Data:* This
424 `video <https://www.youtube.com/watch?v=qWGMrJoqusQ>`__ shows the
425 build performance data provided by Toaster.
426
427.. _a-note-on-the-local-yocto-project-release:
428
429Additional Information About the Local Yocto Project Release
430------------------------------------------------------------
431
432This section only applies if you have set up Toaster for local
433development, as explained in the "`Starting Toaster for Local
434Development <#starting-toaster-for-local-development>`__" section.
435
436When you create a project in Toaster, you will be asked to provide a
437name and to select a Yocto Project release. One of the release options
438you will find is called "Local Yocto Project".
439
440When you select the "Local Yocto Project" release, Toaster will run your
441builds using the local Yocto Project clone you have in your computer:
442the same clone you are using to run Toaster. Unless you manually update
443this clone, your builds will always use the same Git revision.
444
445If you select any of the other release options, Toaster will fetch the
446tip of your selected release from the upstream `Yocto Project
447repository <https://git.yoctoproject.org>`__ every time you run a build.
448Fetching this tip effectively means that if your selected release is
449updated upstream, the Git revision you are using for your builds will
450change. If you are doing development locally, you might not want this
451change to happen. In that case, the "Local Yocto Project" release might
452be the right choice.
453
454However, the "Local Yocto Project" release will not provide you with any
455compatible layers, other than the three core layers that come with the
456Yocto Project:
457
458- `openembedded-core <http://layers.openembedded.org/layerindex/branch/master/layer/openembedded-core/>`__
459
460- `meta-poky <http://layers.openembedded.org/layerindex/branch/master/layer/meta-poky/>`__
461
462- `meta-yocto-bsp <http://layers.openembedded.org/layerindex/branch/master/layer/meta-yocto-bsp/>`__
463
464If you want to build any other layers, you will need to manually import
465them into your Toaster project, using the "Import layer" page.
466
467.. _toaster-web-interface-preferred-version:
468
469Building a Specific Recipe Given Multiple Versions
470--------------------------------------------------
471
472Occasionally, a layer might provide more than one version of the same
473recipe. For example, the ``openembedded-core`` layer provides two
474versions of the ``bash`` recipe (i.e. 3.2.48 and 4.3.30-r0) and two
475versions of the ``which`` recipe (i.e. 2.21 and 2.18). The following
476figure shows this exact scenario:
477
478By default, the OpenEmbedded build system builds one of the two recipes.
479For the ``bash`` case, version 4.3.30-r0 is built by default.
480Unfortunately, Toaster as it exists, is not able to override the default
481recipe version. If you would like to build bash 3.2.48, you need to set
482the
483```PREFERRED_VERSION`` <&YOCTO_DOCS_REF_URL;#var-PREFERRED_VERSION>`__
484variable. You can do so from Toaster, using the "Add variable" form,
485which is available in the "BitBake variables" page of the project
486configuration section as shown in the following screen:
487
488To specify ``bash`` 3.2.48 as the version to build, enter
489"PREFERRED_VERSION_bash" in the "Variable" field, and "3.2.48" in the
490"Value" field. Next, click the "Add variable" button:
491
492After clicking the "Add variable" button, the settings for
493``PREFERRED_VERSION`` are added to the bottom of the BitBake variables
494list. With these settings, the OpenEmbedded build system builds the
495desired version of the recipe rather than the default version:
diff --git a/documentation/toaster-manual/toaster-manual-start.rst b/documentation/toaster-manual/toaster-manual-start.rst
new file mode 100644
index 0000000000..54f290590b
--- /dev/null
+++ b/documentation/toaster-manual/toaster-manual-start.rst
@@ -0,0 +1,46 @@
1************************
2Preparing to Use Toaster
3************************
4
5This chapter describes how you need to prepare your system in order to
6use Toaster.
7
8.. _toaster-setting-up-the-basic-system-requirements:
9
10Setting Up the Basic System Requirements
11========================================
12
13Before you can use Toaster, you need to first set up your build system
14to run the Yocto Project. To do this, follow the instructions in the
15"`Preparing the Build
16Host <&YOCTO_DOCS_DEV_URL;#dev-preparing-the-build-host>`__" section of
17the Yocto Project Development Tasks Manual. For Ubuntu/Debian, you might
18also need to do an additional install of pip3. $ sudo apt-get install
19python3-pip
20
21.. _toaster-establishing-toaster-system-dependencies:
22
23Establishing Toaster System Dependencies
24========================================
25
26Toaster requires extra Python dependencies in order to run. A Toaster
27requirements file named ``toaster-requirements.txt`` defines the Python
28dependencies. The requirements file is located in the ``bitbake``
29directory, which is located in the root directory of the `Source
30Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ (e.g.
31``poky/bitbake/toaster-requirements.txt``). The dependencies appear in a
32``pip``, install-compatible format.
33
34.. _toaster-load-packages:
35
36Install Toaster Packages
37------------------------
38
39You need to install the packages that Toaster requires. Use this
40command: $ pip3 install --user -r bitbake/toaster-requirements.txt The
41previous command installs the necessary Toaster modules into a local
42python 3 cache in your ``$HOME`` directory. The caches is actually
43located in ``$HOME/.local``. To see what packages have been installed
44into your ``$HOME`` directory, do the following: $ pip3 list installed
45--local If you need to remove something, the following works: $ pip3
46uninstall PackageNameToUninstall
diff --git a/documentation/toaster-manual/toaster-manual.rst b/documentation/toaster-manual/toaster-manual.rst
new file mode 100644
index 0000000000..4b0342c578
--- /dev/null
+++ b/documentation/toaster-manual/toaster-manual.rst
@@ -0,0 +1,12 @@
1===================
2Toaster User Manual
3===================
4
5.. toctree::
6 :caption: Table of Contents
7 :numbered:
8
9 toaster-manual-intro
10 toaster-manual-start
11 toaster-manual-setup-and-use
12 toaster-manual-reference