Documentation

Contents:

Note: The documentation in the Fuego repository is dated. Please use the documentation on this wiki instead.

[edit section]

For a quick guide to getting started running a test, see the Fuego Quickstart Guide.

Here are some links to pages with more extensive documentation about Fuego

Here are pages that describe various aspects of Fuego

Core interfaces - describes the interface between Jenkins and the Fuego core system
Test Script APIs - describes the APIs available for test scripts
Parser module API - describes the API for parsing test results
Dependencies - describes the Fuego test dependency system
Test variables - describes test variables feature in Fuego
Jenkins Plugins - list of Jenkins plugins preinstalled and used by Fuego, and an explanation of their usage
Fuego Object Details - describes different objects in the Fuego system, where they reside, and how they are related
Fuego directories - list of different fuego directories, and what each is used for
Release Process - a description of the Fuego release process, to keep Tim sane
Benchmark parser notes - a description of the benchmark data flow and parser
Jenkins Visualization - notes about the visualization of Fuego results in the Jenkins interface
Overlay Generation - notes about the overlay generator (used for board and distribution operations abstractions)
Adding or Customizing a Distribution

Building Documentation - describes how to build the documentation
License And Contribution Policy - describes the license for using and contributing to Fuego
Integration with ttc - describes how to use 'ttc' with Fuego
- If you don't know what 'ttc' is, then you can skip this
Updating Fuego - describes when to update Fuego, and how
- In particular, you don't need to rebuild the docker container every time you update Fuego to a new release.
Raspberry Pi Fuego Setup - describes steps to set up a Raspberry Pi Model 3 board for user with Fuego
Using Fuego with LAVA - describes different options for using Fuego in conjunction with LAVA
Squad backend notes - describes the prototype system for integrating Fuego with a Squad backend
Using Fuego with fserver - describes the prototype fserver system, which supports remote Fuego operations
Working with remote boards - describes setup for performing tests on remote boards
Using Fuego with AGL - describes how to set up Fuego for user with Automotive Grade Linux