lava-server-doc 2014.09.1-1 / usr / share / doc / lava-server-doc / html / lava-scheduler-device-help.html

This file is indexed.

/usr/share/doc/lava-server-doc/html/lava-scheduler-device-help.html is in lava-server-doc 2014.09.1-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Detailed device information in LAVA Scheduler &mdash; LAVA Server 2014.09.1 documentation</title>
    
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '2014.09.1',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="shortcut icon" href="_static/favicon.ico"/>
    <link rel="top" title="LAVA Server 2014.09.1 documentation" href="index.html" />
    <link rel="next" title="Device type information in LAVA Scheduler" href="lava-scheduler-device-type-help.html" />
    <link rel="prev" title="LAVA Scheduler summary help" href="lava-scheduler.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="lava-scheduler-device-type-help.html" title="Device type information in LAVA Scheduler"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="lava-scheduler.html" title="LAVA Scheduler summary help"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">LAVA Server 2014.09.1 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="detailed-device-information-in-lava-scheduler">
<span id="device-help"></span><h1>Detailed device information in LAVA Scheduler<a class="headerlink" href="#detailed-device-information-in-lava-scheduler" title="Permalink to this headline"></a></h1>
<div class="section" id="static-device-information">
<span id="id1"></span><h2>Static device information<a class="headerlink" href="#static-device-information" title="Permalink to this headline"></a></h2>
<blockquote>
<div><dl class="docutils">
<dt><strong>Hostname</strong></dt>
<dd>The unique name of this device in this LAVA instance, used to link all
jobs, results and device information to a specific device configuration.</dd>
<dt><strong>Device type</strong></dt>
<dd>See <a class="reference internal" href="glossary.html#term-device-type"><em class="xref std std-term">device type</em></a></dd>
<dt><strong>Device version</strong></dt>
<dd>Optional field which can be edited by the lab administrators.</dd>
<dt><strong>Device tags</strong></dt>
<dd>Device specific labels to allow test jobs to request specific
hardware capabilities. A <a class="reference internal" href="glossary.html#term-device-tag"><em class="xref std std-term">device tag</em></a> can only be used in
in TestJob if supported by a device of the relevant device type.</dd>
<dt><strong>Worker Hostname</strong></dt>
<dd>The dispatcher which has a configuration file for a device matching
the hostname. Note that this is the result of checking the network
communication between the dispatcher and the server, not the serial
connection between the dispatcher and the board.</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="device-ownership-information">
<span id="device-owner-help"></span><h2>Device ownership information<a class="headerlink" href="#device-ownership-information" title="Permalink to this headline"></a></h2>
<p>See also <a class="reference internal" href="device-capabilities.html#device-capabilities"><em>Device Capabilities Support</em></a></p>
<blockquote>
<div><dl class="docutils">
<dt><strong>Device owner</strong></dt>
<dd>The user or group of users who can administer this device. Note that
superusers of the LAVA instance are always able to administer any
devices on that instance. The device owner has limited administrative
control, see <a class="reference internal" href="#owner-actions"><em>Administrative controls</em></a>. Devices can only be assigned to
a device owner by the lab administrators.</dd>
<dt><strong>Physical access</strong></dt>
<dd>The user with <a class="reference internal" href="glossary.html#term-physical-access"><em class="xref std std-term">physical access</em></a> to the device.</dd>
<dt><strong>Description</strong></dt>
<dd>Free text description of this individual device. This field can be
used by the <a class="reference internal" href="glossary.html#term-device-owner"><em class="xref std std-term">device owner</em></a> to give more information about the device. See
<a class="reference internal" href="#edit-device-description"><em>Edit device description</em></a>.</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="device-status">
<span id="index-0"></span><span id="id2"></span><h2>Device status<a class="headerlink" href="#device-status" title="Permalink to this headline"></a></h2>
<blockquote>
<div><dl class="docutils">
<dt><strong>Status</strong></dt>
<dd><dl class="first last docutils">
<dt>Describes the current device status which can be one of:</dt>
<dd><ul class="first last simple">
<li><em>Offline</em> - temporarily offline, possibly for short term maintenance
or due to a <a class="reference internal" href="glossary.html#term-health-check"><em class="xref std std-term">health check</em></a> failure.</li>
<li><em>Idle</em> - available for job submissions, subject to device ownership
restrictions</li>
<li><em>Running</em> - the device is running a test job. A link to the job
will appear below this section of the page.</li>
<li><em>Offlining</em> - the device owner or administrator has taken the
device offline. The currently running job will complete normally
before the device goes offline.</li>
<li><em>Retired</em> - the device may have been relocated to another server,
or failed due to a hardware fault or some other physical problem
with the device. Contact the device owner or the user with
physical access for more information.</li>
<li><em>Reserved</em> - the device is part of a <a class="reference internal" href="glossary.html#term-multinode"><em class="xref std std-term">MultiNode</em></a> job but one
or more other devices in the same job is not currently available.
(Reserved is also used for single node jobs but the device quickly
moves into Running.)</li>
<li><em>Unreachable</em> - the network communication between this server and
the dispatcher has been temporarily broken. The current state of the
device or any currently running job may differ from that shown on the
server.</li>
</ul>
</dd>
</dl>
</dd>
<dt><strong>Health Status</strong></dt>
<dd>Status of the most recent <a class="reference internal" href="glossary.html#term-health-check"><em class="xref std std-term">health check</em></a> run. If the health
status is <tt class="docutils literal"><span class="pre">Unknown</span></tt>, a health check will be run as soon as the
device is put online or has finished any current job but before
starting any other submitted job.</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="administrative-controls">
<span id="owner-actions"></span><h2>Administrative controls<a class="headerlink" href="#administrative-controls" title="Permalink to this headline"></a></h2>
<p>A device owner has permission to change the status of a particular
device, including taking the device out of the general purpose pool
of devices and making submissions available only to the device owner
or group of users of which the device owner is a member. Device owners
can also update the free text description of a device.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Devices which are a <a class="reference internal" href="glossary.html#term-hidden-device-type"><em class="xref std std-term">hidden device type</em></a> cannot be
returned to the pool until the type itself is visible to
everyone.</p>
</div>
<div class="section" id="put-into-maintenance-mode">
<span id="maintenance-mode"></span><span id="index-1"></span><h3>Put into maintenance mode<a class="headerlink" href="#put-into-maintenance-mode" title="Permalink to this headline"></a></h3>
<p>A device in maintenance mode will be <em>Offline</em>, so any new job submissions
will wait in the submission queue until the device is online (<em>Idle</em>)
before starting. If the device was running a test job when the owner
or administrator put the device into maintenance mode, the device will
be in <em>Offlining</em> state until that job completes.</p>
</div>
<div class="section" id="put-into-looping-mode">
<span id="looping-mode"></span><span id="index-2"></span><h3>Put into looping mode<a class="headerlink" href="#put-into-looping-mode" title="Permalink to this headline"></a></h3>
<p>Devices already in maintenance mode can be put into looping mode where the device
continually runs the <a class="reference internal" href="glossary.html#term-health-check"><em class="xref std std-term">health check</em></a> defined for the <a class="reference internal" href="glossary.html#term-device-type"><em class="xref std std-term">device type</em></a>.
To cancel looping mode, either click the <em>Cancel Looping</em> button or
<a class="reference internal" href="#maintenance-mode"><em>Put into maintenance mode</em></a> - when the last health check completes, the device
will go into state <em>Offline</em>, the same as it was before looping mode
was enabled.</p>
</div>
<div class="section" id="put-online">
<span id="id3"></span><h3>Put online<a class="headerlink" href="#put-online" title="Permalink to this headline"></a></h3>
<p>Putting a device online involves running the <a class="reference internal" href="glossary.html#term-health-check"><em class="xref std std-term">health check</em></a> defined
for the <a class="reference internal" href="glossary.html#term-device-type"><em class="xref std std-term">device type</em></a>, if any, before moving to state <em>Idle</em> and
starting any jobs waiting in the submission queue. Device owners and
administrators are able to put devices which are <em>Offline</em> back online.
Only administrators can change the status of <em>Retired</em> devices.</p>
</div>
<div class="section" id="edit-device-description">
<span id="index-3"></span><span id="id4"></span><h3>Edit device description<a class="headerlink" href="#edit-device-description" title="Permalink to this headline"></a></h3>
<p>Device owners and administrators can edit a free text description of
this individual device. Suggested content includes more information about
the specific device, the reasons for restricting submissions, information
about the device owner and the purposes for which the device is used etc.
Text can include links to external sites for more information.</p>
<p>It can be particularly useful to expand on the <a class="reference internal" href="device-capabilities.html#device-capabilities"><em>Device Capabilities Support</em></a>
by adding details which cannot be easily identified at runtime, e.g.
big.LITTLE details or particular hardware features available on this
specific device.</p>
</div>
<div class="section" id="restrict-submissions">
<span id="restrict-device"></span><span id="index-4"></span><h3>Restrict submissions<a class="headerlink" href="#restrict-submissions" title="Permalink to this headline"></a></h3>
<p>An owned device can be restricted so that new job submissions will only
be accepted from the device owner. If the device owner is a group, any
user in that group will be able to submit new jobs.</p>
<p>Any currently running jobs will complete normally, unless the device
owner cancels the job.</p>
<p>Device owners are strongly recommended to edit the device description
in such a way as to explain why the restriction is necessary and how long
the restriction may last.</p>
</div>
<div class="section" id="return-a-device-to-the-pool">
<h3>Return a device to the pool<a class="headerlink" href="#return-a-device-to-the-pool" title="Permalink to this headline"></a></h3>
<p>Restricted devices can be returned to the common LAVA pool so that anyone
can submit jobs to the device. The device will be able to accept jobs
from any authorised user along with devices which have no device owner
assigned.</p>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/linaro.png" alt="Logo"/>
            </a></p>
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Detailed device information in LAVA Scheduler</a><ul>
<li><a class="reference internal" href="#static-device-information">Static device information</a></li>
<li><a class="reference internal" href="#device-ownership-information">Device ownership information</a></li>
<li><a class="reference internal" href="#device-status">Device status</a></li>
<li><a class="reference internal" href="#administrative-controls">Administrative controls</a><ul>
<li><a class="reference internal" href="#put-into-maintenance-mode">Put into maintenance mode</a></li>
<li><a class="reference internal" href="#put-into-looping-mode">Put into looping mode</a></li>
<li><a class="reference internal" href="#put-online">Put online</a></li>
<li><a class="reference internal" href="#edit-device-description">Edit device description</a></li>
<li><a class="reference internal" href="#restrict-submissions">Restrict submissions</a></li>
<li><a class="reference internal" href="#return-a-device-to-the-pool">Return a device to the pool</a></li>
</ul>
</li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="lava-scheduler.html"
                        title="previous chapter">LAVA Scheduler summary help</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="lava-scheduler-device-type-help.html"
                        title="next chapter">Device type information in LAVA Scheduler</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/lava-scheduler-device-help.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="lava-scheduler-device-type-help.html" title="Device type information in LAVA Scheduler"
             >next</a> |</li>
        <li class="right" >
          <a href="lava-scheduler.html" title="LAVA Scheduler summary help"
             >previous</a> |</li>
        <li><a href="index.html">LAVA Server 2014.09.1 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2010-2014, Linaro Limited.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
    </div>
  </body>
</html>

APT Browse - Built by Thomas Orozco.