1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
site_name: LAVA Documentation
repo_url: https://gitlab.com/lava/lava/
repo_name: GitLab
site_author: LAVA team
site_description: LAVA documentation
docs_dir: content/
extra_css:
- assets/stylesheets/extra.css
# https://squidfunk.github.io/mkdocs-material/
# python3 -m pip install mkdocs-material
theme:
name: "material"
language: "en"
include_sidebar: true
features:
- navigation.tabs
- content.code.copy
palette:
primary: "light-green"
accent: "light-green"
font: false
logo: assets/images/logo.png
favicon: assets/images/favicon.png
# https://squidfunk.github.io/mkdocs-material/getting-started/#customization
markdown_extensions:
- admonition
- codehilite
- toc:
permalink: true
- markdown.extensions.abbr
# https://github.com/simonrenger/markdown-include-lines
# https://squidfunk.github.io/mkdocs-material/extensions/pymdown/
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.snippets:
base_path: doc/content/_snippets/
check_paths: True
- pymdownx.tabbed:
alternate_style: true
- tables
# Debugging ?
# Job errors ?
nav:
- Introduction:
- Concepts: introduction/concepts.md
- Features: introduction/features.md
- Getting started: introduction/getting-started.md
- Glossary: introduction/glossary.md
- Use cases:
- Basic testing: introduction/use-cases/boot-testing.md
- Bootloader testing: introduction/use-cases/bootloader-testing.md
- IoT: introduction/use-cases/iot.md
- Power management: introduction/use-cases/power-management.md
- VTS/CTS: introduction/use-cases/vts-cts.md
- F.A.Q: introduction/faq.md
- Contact: introduction/contact.md
- User guide:
- First steps: user/first-steps.md
- Basic tutorials:
- Signing in: user/basic-tutorials/signing-in.md
- Submit a job: user/basic-tutorials/submit.md
- lavacli: user/basic-tutorials/lavacli.md
- Job definition: user/basic-tutorials/job-definition.md
- Test definition: user/basic-tutorials/test-definition.md
- Job output: user/basic-tutorials/job-output.md
- Advanced tutorials:
- Debugging Job: user/advanced-tutorials/debugging-job.md
- Interactive tests: user/advanced-tutorials/interactive-tests.md
- Job generation: user/advanced-tutorials/job-generation.md # Using jinja2
- Multinode: user/advanced-tutorials/multinode.md
- Notifications: user/advanced-tutorials/notifications.md
- Running arbitrary code with docker: user/advanced-tutorials/running-arbitrary-code-with-docker.md
- Secondary connection: user/advanced-tutorials/secondary-connection.md
- tmate-based hacking session: user/advanced-tutorials/tmate-based-hacking-session.md
- Admin guide:
- First steps: admin/first-steps.md
- Recommendations:
- Hardware: admin/recommendations/hardware.md
- Health-checks: admin/recommendations/health-checks.md
- Topology: admin/recommendations/topology.md
- Security: admin/recommendations/security.md # explain the security model
- Basic Tutorials:
- Instance:
- Install: admin/basic-tutorials/instance/install.md
- Configure: admin/basic-tutorials/instance/configure.md
- Upgrade: admin/basic-tutorials/instance/upgrade.md
- Backup: admin/basic-tutorials/instance/backup.md
- Permissions: admin/basic-tutorials/instance/permissions.md
- lavacli: admin/basic-tutorials/lavacli.md
- Device setup:
- Common: admin/basic-tutorials/device-setup/common.md
- AVH: admin/basic-tutorials/device-setup/avh.md
- docker: admin/basic-tutorials/device-setup/docker.md
- FVP: admin/basic-tutorials/device-setup/fvp.md
- QEMU: admin/basic-tutorials/device-setup/qemu.md
- RPi (u-boot): admin/basic-tutorials/device-setup/u-boot.md
- x15 (fastboot): admin/basic-tutorials/device-setup/fastboot.md
- Advanced tutorials:
- LDAP: admin/advanced-tutorials/ldap.md
- Proxy: admin/advanced-tutorials/proxy.md
- Remote database: admin/advanced-tutorials/remote-database.md
- Remote workers: admin/advanced-tutorials/remote-workers.md
- Docker worker: admin/advanced-tutorials/docker-worker.md
- Growing your lab: admin/advanced-tutorials/growing-your-lab.md
- Deploying RPi4 as worker: admin/advanced-tutorials/deploying-rpi4b-as-worker.md
- Device dictionary sync: admin/advanced-tutorials/sync-records-from-dictionary.md
- Logs in NoSQL: admin/advanced-tutorials/logging-database.md
- Trouble shooting: admin/advanced-tutorials/trouble-shooting.md
- Developer guide:
- First steps: developer/first-steps.md
- Development:
- Setup: developer/development/setup.md
- Build: developer/development/build.md
- Test: developer/development/test.md
- Methodology:
- Test: developer/methodology/test.md
- Release: developer/methodology/release.md
- Contribute: developer/methodology/contribute.md
- Distribute: developer/methodology/distribute.md
- Tutorials:
- Contribute: developer/tutorials/contributing.md
- New device-type: developer/tutorials/new-device-type.md
- New action: developer/tutorials/new-actions.md
- Technical references:
- Architecture: technical-references/architecture.md
- Authorization: technical-references/authorization.md
- Configuration:
- Device dictionary: technical-references/configuration/device-dictionary.md
- Device-type template: technical-references/configuration/device-type-template.md
- Dispatcher: technical-references/configuration/dispatcher.md
- Health-Check: technical-references/configuration/health-check.md
- Job definition:
- Job: technical-references/job-definition/job.md
- Actions:
- Command: technical-references/job-definition/actions/command.md
- Deploy:
- Common: technical-references/job-definition/actions/deploy/index.md
- AVH: technical-references/job-definition/actions/deploy/to-avh.md
- Docker: technical-references/job-definition/actions/deploy/to-docker.md
- Downloads: technical-references/job-definition/actions/deploy/to-downloads.md
- Fastboot: technical-references/job-definition/actions/deploy/to-fastboot.md
- FVP: technical-references/job-definition/actions/deploy/to-fvp.md
- TFTP: technical-references/job-definition/actions/deploy/to-tftp.md
- Boot:
- AVH: technical-references/job-definition/actions/boot/method-avh.md
- FVP: technical-references/job-definition/actions/boot/method-fvp.md
- U-Boot: technical-references/job-definition/actions/boot/method-u-boot.md
- Test: technical-references/job-definition/actions/test.md
- Notifications: technical-references/job-definition/notifications.md
- Protocols: technical-references/job-definition/protocols.md
- Timeouts: technical-references/job-definition/timeouts.md
- Results: technical-references/results.md
- State machine: technical-references/state-machine.md
- Services:
- server:
- apache2: technical-references/services/apache2.md
- lava-celerey-worker: technical-references/services/lava-celery-worker.md
- lava-coordinator: technical-references/services/lava-coordinator.md
- lava-publisher: technical-references/services/lava-publisher.md
- lava-scheduler: technical-references/services/lava-scheduler.md
- lava-server-gunicorn: technical-references/services/lava-server-gunicorn.md
- postgresql: technical-references/services/postgresql.md
- worker:
- lava-docker-worker: technical-references/services/lava-docker-worker.md
- lava-worker: technical-references/services/lava-worker.md
- Test definition: technical-references/test-definition.md
|
