blob: 2cb7884eb962f633751d787736b11c07a89ba84e [file] [log] [blame]
Andrew Geisslerf0343792020-11-18 10:42:21 -06001.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
Andrew Geisslerc9f78652020-09-18 14:11:35 -05002.. Set default pygment highlighting to 'shell' for this document
3.. highlight:: shell
4
5****************************
6Setting Up and Using Toaster
7****************************
8
9Starting Toaster for Local Development
10======================================
11
12Once you have set up the Yocto Project and installed the Toaster system
Andrew Geissler09209ee2020-12-13 08:44:15 -060013dependencies as described in the ":ref:`toaster-manual/start:Preparing to Use
Andrew Geisslerc9f78652020-09-18 14:11:35 -050014Toaster`" chapter, you are ready to start
15Toaster.
16
17Navigate to the root of your
18:term:`Source Directory` (e.g. ``poky``)::
19
20 $ cd poky
21
22Once in that directory, source the build environment script::
23
24 $ source oe-init-build-env
25
26Next, from the build directory (e.g.
27``poky/build``), start Toaster using this command::
28
29 $ source toaster start
30
31You can now run your builds from the command line, or with Toaster
32as explained in section
Andrew Geissler09209ee2020-12-13 08:44:15 -060033":ref:`toaster-manual/setup-and-use:using the toaster web interface`".
Andrew Geisslerc9f78652020-09-18 14:11:35 -050034
35To access the Toaster web interface, open your favorite browser and
36enter the following::
37
38 http://127.0.0.1:8000
39
40Setting a Different Port
41========================
42
43By default, Toaster starts on port 8000. You can use the ``WEBPORT``
44parameter to set a different port. For example, the following command
45sets the port to "8400"::
46
47 $ source toaster start webport=8400
48
49Setting Up Toaster Without a Web Server
50=======================================
51
52You can start a Toaster environment without starting its web server.
53This is useful for the following:
54
55- Capturing a command-line build's statistics into the Toaster database
56 for examination later.
57
58- Capturing a command-line build's statistics when the Toaster server
59 is already running.
60
61- Having one instance of the Toaster web server track and capture
62 multiple command-line builds, where each build is started in its own
63 "noweb" Toaster environment.
64
65The following commands show how to start a Toaster environment without
66starting its web server, perform BitBake operations, and then shut down
67the Toaster environment. Once the build is complete, you can close the
68Toaster environment. Before closing the environment, however, you should
69allow a few minutes to ensure the complete transfer of its BitBake build
70statistics to the Toaster database. If you have a separate Toaster web
71server instance running, you can watch this command-line build's
72progress and examine the results as soon as they are posted::
73
74 $ source toaster start noweb
75 $ bitbake target
76 $ source toaster stop
77
78Setting Up Toaster Without a Build Server
79=========================================
80
81You can start a Toaster environment with the "New Projects" feature
82disabled. Doing so is useful for the following:
83
84- Sharing your build results over the web server while blocking others
85 from starting builds on your host.
86
87- Allowing only local command-line builds to be captured into the
88 Toaster database.
89
90Use the following command to set up Toaster without a build server::
91
92 $ source toaster start nobuild webport=port
93
94Setting up External Access
95==========================
96
97By default, Toaster binds to the loop back address (i.e. ``localhost``),
98which does not allow access from external hosts. To allow external
99access, use the ``WEBPORT`` parameter to open an address that connects
100to the network, specifically the IP address that your NIC uses to
101connect to the network. You can also bind to all IP addresses the
102computer supports by using the shortcut "0.0.0.0:port".
103
104The following example binds to all IP addresses on the host::
105
106 $ source toaster start webport=0.0.0.0:8400
107
108This example binds to a specific IP address on the host's NIC::
109
110 $ source toaster start webport=192.168.1.1:8400
111
112The Directory for Cloning Layers
113================================
114
115Toaster creates a ``_toaster_clones`` directory inside your Source
116Directory (i.e. ``poky``) to clone any layers needed for your builds.
117
118Alternatively, if you would like all of your Toaster related files and
119directories to be in a particular location other than the default, you
120can set the ``TOASTER_DIR`` environment variable, which takes precedence
121over your current working directory. Setting this environment variable
122causes Toaster to create and use ``$TOASTER_DIR./_toaster_clones``.
123
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500124The Build Directory
125===================
126
127Toaster creates a build directory within your Source Directory (e.g.
128``poky``) to execute the builds.
129
130Alternatively, if you would like all of your Toaster related files and
131directories to be in a particular location, you can set the
132``TOASTER_DIR`` environment variable, which takes precedence over your
133current working directory. Setting this environment variable causes
134Toaster to use ``$TOASTER_DIR/build`` as the build directory.
135
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500136Creating a Django Superuser
137===========================
138
139Toaster is built on the `Django
140framework <https://www.djangoproject.com/>`__. Django provides an
141administration interface you can use to edit Toaster configuration
142parameters.
143
144To access the Django administration interface, you must create a
145superuser by following these steps:
146
147#. If you used ``pip3``, which is recommended, to set up the Toaster
148 system dependencies, you need be sure the local user path is in your
149 ``PATH`` list. To append the pip3 local user path, use the following
150 command::
151
152 $ export PATH=$PATH:$HOME/.local/bin
153
154#. From the directory containing the Toaster database, which by default
155 is the :term:`Build Directory`,
156 invoke the ``createsuperuser`` command from ``manage.py``::
157
158 $ cd ~/poky/build
159 $ ../bitbake/lib/toaster/manage.py createsuperuser
160
161#. Django prompts you for the username, which you need to provide.
162
163#. Django prompts you for an email address, which is optional.
164
165#. Django prompts you for a password, which you must provide.
166
167#. Django prompts you to re-enter your password for verification.
168
169After completing these steps, the following confirmation message
170appears::
171
172 Superuser created successfully.
173
174Creating a superuser allows you to access the Django administration
175interface through a browser. The URL for this interface is the same as
176the URL used for the Toaster instance with "/admin" on the end. For
177example, if you are running Toaster locally, use the following URL::
178
179 http://127.0.0.1:8000/admin
180
181You can use the Django administration interface to set Toaster configuration
182parameters such as the build directory, layer sources, default variable
183values, and BitBake versions.
184
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500185Setting Up a Production Instance of Toaster
186===========================================
187
188You can use a production instance of Toaster to share the Toaster
189instance with remote users, multiple users, or both. The production
190instance is also the setup that can handle heavier loads on the web
191service. Use the instructions in the following sections to set up
192Toaster to run builds through the Toaster web interface.
193
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500194Requirements
195------------
196
197Be sure you meet the following requirements:
198
199.. note::
200
201 You must comply with all Apache, ``mod-wsgi``, and Mysql requirements.
202
Andrew Geissler09209ee2020-12-13 08:44:15 -0600203- Have all the build requirements as described in the ":ref:`toaster-manual/start:Preparing to
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500204 Use Toaster`" chapter.
205
206- Have an Apache webserver.
207
208- Have ``mod-wsgi`` for the Apache webserver.
209
210- Use the Mysql database server.
211
212- If you are using Ubuntu, run the following::
213
214 $ sudo apt-get install apache2 libapache2-mod-wsgi-py3 mysql-server python3-pip libmysqlclient-dev
215
216- If you are using Fedora or a RedHat distribution, run the
217 following::
218
219 $ sudo dnf install httpd python3-mod_wsgi python3-pip mariadb-server mariadb-devel python3-devel
220
221- If you are using openSUSE, run the following::
222
223 $ sudo zypper install apache2 apache2-mod_wsgi-python3 python3-pip mariadb mariadb-client python3-devel
224
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500225Installation
226------------
227
228Perform the following steps to install Toaster:
229
230#. Create toaster user and set its home directory to
231 ``/var/www/toaster``::
232
233 $ sudo /usr/sbin/useradd toaster -md /var/www/toaster -s /bin/false
234 $ sudo su - toaster -s /bin/bash
235
236#. Checkout a copy of ``poky`` into the web server directory. You will
237 be using ``/var/www/toaster``::
238
239 $ git clone git://git.yoctoproject.org/poky
240 $ git checkout &DISTRO_NAME_NO_CAP;
241
242#. Install Toaster dependencies using the --user flag which keeps the
243 Python packages isolated from your system-provided packages::
244
245 $ cd /var/www/toaster/
246 $ pip3 install --user -r ./poky/bitbake/toaster-requirements.txt
247 $ pip3 install --user mysqlclient
248
249 .. note::
250
251 Isolating these packages is not required but is recommended.
252 Alternatively, you can use your operating system's package
253 manager to install the packages.
254
255#. Configure Toaster by editing
256 ``/var/www/toaster/poky/bitbake/lib/toaster/toastermain/settings.py``
257 as follows:
258
259 - Edit the
260 `DATABASES <https://docs.djangoproject.com/en/2.2/ref/settings/#databases>`__
261 settings:
262
263 .. code-block:: python
264
265 DATABASES = {
266 'default': {
267 'ENGINE': 'django.db.backends.mysql',
268 'NAME': 'toaster_data',
269 'USER': 'toaster',
270 'PASSWORD': 'yourpasswordhere',
271 'HOST': 'localhost',
272 'PORT': '3306',
273 }
274 }
275
276 - Edit the
277 `SECRET_KEY <https://docs.djangoproject.com/en/2.2/ref/settings/#std:setting-SECRET_KEY>`__:
278
279 .. code-block:: python
280
281 SECRET_KEY = 'your_secret_key'
282
283 - Edit the
284 `STATIC_ROOT <https://docs.djangoproject.com/en/2.2/ref/settings/#std:setting-STATIC_ROOT>`__:
285
286 .. code-block:: python
287
288 STATIC_ROOT = '/var/www/toaster/static_files/'
289
290#. Add the database and user to the ``mysql`` server defined earlier::
291
292 $ mysql -u root -p
293 mysql> CREATE DATABASE toaster_data;
294 mysql> CREATE USER 'toaster'@'localhost' identified by 'yourpasswordhere';
295 mysql> GRANT all on toaster_data.\* to 'toaster'@'localhost';
296 mysql> quit
297
298#. Get Toaster to create the database schema, default data, and gather
299 the statically-served files::
300
301 $ cd /var/www/toaster/poky/
302 $ ./bitbake/lib/toaster/manage.py migrate
303 $ TOASTER_DIR=`pwd\` TEMPLATECONF='poky' \
304 ./bitbake/lib/toaster/manage.py checksettings
305 $ ./bitbake/lib/toaster/manage.py collectstatic
306
307
308 In the previous
309 example, from the ``poky`` directory, the ``migrate`` command
310 ensures the database schema changes have propagated correctly (i.e.
311 migrations). The next line sets the Toaster root directory
312 ``TOASTER_DIR`` and the location of the Toaster configuration file
313 ``TOASTER_CONF``, which is relative to ``TOASTER_DIR``. The
314 ``TEMPLATECONF`` value reflects the contents of
315 ``poky/.templateconf``, and by default, should include the string
316 "poky". For more information on the Toaster configuration file, see
Andrew Geissler09209ee2020-12-13 08:44:15 -0600317 the ":ref:`toaster-manual/reference:Configuring Toaster`" section.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500318
319 This line also runs the ``checksettings`` command, which configures
320 the location of the Toaster :term:`Build Directory`.
321 The Toaster
322 root directory ``TOASTER_DIR`` determines where the Toaster build
323 directory is created on the file system. In the example above,
324 ``TOASTER_DIR`` is set as follows::
325
326 /var/www/toaster/poky
327
328
329 This setting causes the Toaster build directory to be::
330
331 /var/www/toaster/poky/build
332
333 Finally, the ``collectstatic`` command is a Django framework command
334 that collects all the statically served files into a designated
335 directory to be served up by the Apache web server as defined by
336 ``STATIC_ROOT``.
337
338#. Test and/or use the Mysql integration with Toaster's Django web
339 server. At this point, you can start up the normal Toaster Django
340 web server with the Toaster database in Mysql. You can use this web
341 server to confirm that the database migration and data population
342 from the Layer Index is complete.
343
344 To start the default Toaster Django web server with the Toaster
345 database now in Mysql, use the standard start commands::
346
347 $ source oe-init-build-env
348 $ source toaster start
349
350 Additionally, if Django is sufficient for your requirements, you can use
351 it for your release system and migrate later to Apache as your
352 requirements change.
353
354#. Add an Apache configuration file for Toaster to your Apache web
355 server's configuration directory. If you are using Ubuntu or Debian,
356 put the file here::
357
358 /etc/apache2/conf-available/toaster.conf
359
360
361 If you are using Fedora or RedHat, put it here::
362
363 /etc/httpd/conf.d/toaster.conf
364
365 If you are using OpenSUSE, put it here::
366
367 /etc/apache2/conf.d/toaster.conf
368
369 Following is a sample Apache configuration for Toaster you can follow:
370
371 .. code-block:: apache
372
373 Alias /static /var/www/toaster/static_files
374 <Directory /var/www/toaster/static_files>
375 <IfModule mod_access_compat.c>
376 Order allow,deny
377 Allow from all
378 </IfModule>
379 <IfModule !mod_access_compat.c>
380 Require all granted
381 </IfModule>
382 </Directory>
383
384 <Directory /var/www/toaster/poky/bitbake/lib/toaster/toastermain>
385 <Files "wsgi.py">
386 Require all granted
387 </Files>
388 </Directory>
389
390 WSGIDaemonProcess toaster_wsgi python-path=/var/www/toaster/poky/bitbake/lib/toaster:/var/www/toaster/.local/lib/python3.4/site-packages
391 WSGIScriptAlias / "/var/www/toaster/poky/bitbake/lib/toaster/toastermain/wsgi.py"
392 <Location />
393 WSGIProcessGroup toaster_wsgi
394 </Location>
395
396
397 If you are using Ubuntu or Debian, you will need to enable the config and
398 module for Apache::
399
400 $ sudo a2enmod wsgi
401 $ sudo a2enconf toaster
402 $ chmod +x bitbake/lib/toaster/toastermain/wsgi.py
403
404 Finally, restart Apache to make sure all new configuration is loaded. For Ubuntu,
405 Debian, and OpenSUSE use::
406
407 $ sudo service apache2 restart
408
409 For Fedora and RedHat use::
410
411 $ sudo service httpd restart
412
413#. Prepare the systemd service to run Toaster builds. Here is a sample
414 configuration file for the service:
415
416 .. code-block:: ini
417
418 [Unit]
419 Description=Toaster runbuilds
420
421 [Service]
422 Type=forking User=toaster
423 ExecStart=/usr/bin/screen -d -m -S runbuilds /var/www/toaster/poky/bitbake/lib/toaster/runbuilds-service.sh start
424 ExecStop=/usr/bin/screen -S runbuilds -X quit
425 WorkingDirectory=/var/www/toaster/poky
426
427 [Install]
428 WantedBy=multi-user.target
429
430
431 Prepare the ``runbuilds-service.sh`` script that you need to place in the
432 ``/var/www/toaster/poky/bitbake/lib/toaster/`` directory by setting
433 up executable permissions::
434
435 #!/bin/bash
436
437 #export http_proxy=http://proxy.host.com:8080
438 #export https_proxy=http://proxy.host.com:8080
439 #export GIT_PROXY_COMMAND=$HOME/bin/gitproxy
440 cd ~/poky/
441 source ./oe-init-build-env build
442 source ../bitbake/bin/toaster $1 noweb
443 [ "$1" == 'start' ] && /bin/bash
444
445#. Run the service::
446
447 $ sudo service runbuilds start
448
449 Since the service is running in a detached screen session, you can
450 attach to it using this command::
451
452 $ sudo su - toaster
453 $ screen -rS runbuilds
454
455 You can detach from the service again using "Ctrl-a" followed by "d" key
456 combination.
457
458You can now open up a browser and start using Toaster.
459
460Using the Toaster Web Interface
461===============================
462
463The Toaster web interface allows you to do the following:
464
465- Browse published layers in the `OpenEmbedded Layer
466 Index <http://layers.openembedded.org>`__ that are available for your
467 selected version of the build system.
468
469- Import your own layers for building.
470
471- Add and remove layers from your configuration.
472
473- Set configuration variables.
474
475- Select a target or multiple targets to build.
476
477- Start your builds.
478
479- See what was built (recipes and packages) and what packages were
480 installed into your final image.
481
482- Browse the directory structure of your image.
483
484- See the value of all variables in your build configuration, and which
485 files set each value.
486
487- Examine error, warning and trace messages to aid in debugging.
488
489- See information about the BitBake tasks executed and reused during
490 your build, including those that used shared state.
491
492- See dependency relationships between recipes, packages and tasks.
493
494- See performance information such as build time, task time, CPU usage,
495 and disk I/O.
496
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500497Toaster Web Interface Videos
498----------------------------
499
500Following are several videos that show how to use the Toaster GUI:
501
502- *Build Configuration:* This
503 `video <https://www.youtube.com/watch?v=qYgDZ8YzV6w>`__ overviews and
504 demonstrates build configuration for Toaster.
505
506- *Build Custom Layers:* This
507 `video <https://www.youtube.com/watch?v=QJzaE_XjX5c>`__ shows you how
508 to build custom layers that are used with Toaster.
509
510- *Toaster Homepage and Table Controls:* This
511 `video <https://www.youtube.com/watch?v=QEARDnrR1Xw>`__ goes over the
512 Toaster entry page, and provides an overview of the data manipulation
513 capabilities of Toaster, which include search, sorting and filtering
514 by different criteria.
515
516- *Build Dashboard:* This
517 `video <https://www.youtube.com/watch?v=KKqHYcnp2gE>`__ shows you the
518 build dashboard, a page providing an overview of the information
519 available for a selected build.
520
521- *Image Information:* This
522 `video <https://www.youtube.com/watch?v=XqYGFsmA0Rw>`__ walks through
523 the information Toaster provides about images: packages installed and
524 root file system.
525
526- *Configuration:* This
527 `video <https://www.youtube.com/watch?v=UW-j-T2TzIg>`__ provides
528 Toaster build configuration information.
529
530- *Tasks:* This `video <https://www.youtube.com/watch?v=D4-9vGSxQtw>`__
531 shows the information Toaster provides about the tasks run by the
532 build system.
533
534- *Recipes and Packages Built:* This
535 `video <https://www.youtube.com/watch?v=x-6dx4huNnw>`__ shows the
536 information Toaster provides about recipes and packages built.
537
538- *Performance Data:* This
539 `video <https://www.youtube.com/watch?v=qWGMrJoqusQ>`__ shows the
540 build performance data provided by Toaster.
541
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500542Additional Information About the Local Yocto Project Release
543------------------------------------------------------------
544
545This section only applies if you have set up Toaster for local
546development, as explained in the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600547":ref:`toaster-manual/setup-and-use:starting toaster for local development`"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500548section.
549
550When you create a project in Toaster, you will be asked to provide a
551name and to select a Yocto Project release. One of the release options
552you will find is called "Local Yocto Project".
553
554.. image:: figures/new-project.png
555 :align: center
556 :scale: 75%
557
558When you select the "Local Yocto Project" release, Toaster will run your
559builds using the local Yocto Project clone you have in your computer:
560the same clone you are using to run Toaster. Unless you manually update
561this clone, your builds will always use the same Git revision.
562
563If you select any of the other release options, Toaster will fetch the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600564tip of your selected release from the upstream :yocto_git:`Yocto Project
565repository <>` every time you run a build.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500566Fetching this tip effectively means that if your selected release is
567updated upstream, the Git revision you are using for your builds will
568change. If you are doing development locally, you might not want this
569change to happen. In that case, the "Local Yocto Project" release might
570be the right choice.
571
572However, the "Local Yocto Project" release will not provide you with any
573compatible layers, other than the three core layers that come with the
574Yocto Project:
575
576- `openembedded-core <http://layers.openembedded.org/layerindex/branch/master/layer/openembedded-core/>`__
577
578- `meta-poky <http://layers.openembedded.org/layerindex/branch/master/layer/meta-poky/>`__
579
580- `meta-yocto-bsp <http://layers.openembedded.org/layerindex/branch/master/layer/meta-yocto-bsp/>`__
581
582.. image:: figures/compatible-layers.png
583 :align: center
584 :scale: 75%
585
586If you want to build any other layers, you will need to manually import
587them into your Toaster project, using the "Import layer" page.
588
589.. image:: figures/import-layer.png
590 :align: center
591 :scale: 75%
592
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500593Building a Specific Recipe Given Multiple Versions
594--------------------------------------------------
595
596Occasionally, a layer might provide more than one version of the same
597recipe. For example, the ``openembedded-core`` layer provides two
598versions of the ``bash`` recipe (i.e. 3.2.48 and 4.3.30-r0) and two
599versions of the ``which`` recipe (i.e. 2.21 and 2.18). The following
600figure shows this exact scenario:
601
602.. image:: figures/bash-oecore.png
603 :align: center
604 :scale: 75%
605
606By default, the OpenEmbedded build system builds one of the two recipes.
607For the ``bash`` case, version 4.3.30-r0 is built by default.
608Unfortunately, Toaster as it exists, is not able to override the default
609recipe version. If you would like to build bash 3.2.48, you need to set
610the
611:term:`PREFERRED_VERSION`
612variable. You can do so from Toaster, using the "Add variable" form,
613which is available in the "BitBake variables" page of the project
614configuration section as shown in the following screen:
615
616.. image:: figures/add-variable.png
617 :align: center
618 :scale: 75%
619
620To specify ``bash`` 3.2.48 as the version to build, enter
621"PREFERRED_VERSION_bash" in the "Variable" field, and "3.2.48" in the
622"Value" field. Next, click the "Add variable" button:
623
624.. image:: figures/set-variable.png
625 :align: center
626 :scale: 75%
627
628After clicking the "Add variable" button, the settings for
629``PREFERRED_VERSION`` are added to the bottom of the BitBake variables
630list. With these settings, the OpenEmbedded build system builds the
631desired version of the recipe rather than the default version:
632
633.. image:: figures/variable-added.png
634 :align: center
635 :scale: 75%