This file is indexed.

/usr/share/doc/ganeti/html/design-lu-generated-jobs.html is in ganeti-doc 2.16.0~rc2-1build1.

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
<!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" lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Submitting jobs from logical units &#8212; Ganeti 2.16.0~rc2 documentation</title>
    <link rel="stylesheet" href="_static/style.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '2.16.0~rc2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true,
        SOURCELINK_SUFFIX: '.txt'
      };
    </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="search" title="Search" href="search.html" />
    <link rel="next" title="Ganeti monitoring agent" href="design-monitoring-agent.html" />
    <link rel="prev" title="Linux HA integration" href="design-linuxha.html" /> 
  </head>
  <body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="design-monitoring-agent.html" title="Ganeti monitoring agent"
             accesskey="N">next</a></li>
        <li class="right" >
          <a href="design-linuxha.html" title="Linux HA integration"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Ganeti 2.16.0~rc2 documentation</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="submitting-jobs-from-logical-units">
<h1><a class="toc-backref" href="#id1">Submitting jobs from logical units</a><a class="headerlink" href="#submitting-jobs-from-logical-units" title="Permalink to this headline"></a></h1>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Created:</th><td class="field-body">2011-Mar-23</td>
</tr>
<tr class="field-even field"><th class="field-name">Status:</th><td class="field-body">Implemented</td>
</tr>
<tr class="field-odd field"><th class="field-name">Ganeti-Version:</th><td class="field-body">2.5.0</td>
</tr>
</tbody>
</table>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#submitting-jobs-from-logical-units" id="id1">Submitting jobs from logical units</a><ul>
<li><a class="reference internal" href="#current-state-and-shortcomings" id="id2">Current state and shortcomings</a></li>
<li><a class="reference internal" href="#proposed-changes" id="id3">Proposed changes</a></li>
<li><a class="reference internal" href="#other-discussed-solutions" id="id4">Other discussed solutions</a></li>
</ul>
</li>
</ul>
</div>
<p>This is a design document about the innards of Ganeti’s job processing.
Readers are advised to study previous design documents on the topic:</p>
<ul class="simple">
<li><a class="reference internal" href="design-2.0.html#jqueue-original-design"><span class="std std-ref">Original job queue</span></a></li>
<li><a class="reference internal" href="design-2.3.html#jqueue-job-priority-design"><span class="std std-ref">Job priorities</span></a></li>
</ul>
<div class="section" id="current-state-and-shortcomings">
<h2><a class="toc-backref" href="#id2">Current state and shortcomings</a><a class="headerlink" href="#current-state-and-shortcomings" title="Permalink to this headline"></a></h2>
<p>Some Ganeti operations want to execute as many operations in parallel as
possible. Examples are evacuating or failing over a node (<code class="docutils literal"><span class="pre">gnt-node</span>
<span class="pre">evacuate</span></code>/<code class="docutils literal"><span class="pre">gnt-node</span> <span class="pre">failover</span></code>). Without changing large parts of the
code, e.g. the RPC layer, to be asynchronous, or using threads inside a
logical unit, only a single operation can be executed at a time per job.</p>
<p>Currently clients work around this limitation by retrieving the list of
desired targets and then re-submitting a number of jobs. This requires
logic to be kept in the client, in some cases leading to duplication
(e.g. CLI and RAPI).</p>
</div>
<div class="section" id="proposed-changes">
<h2><a class="toc-backref" href="#id3">Proposed changes</a><a class="headerlink" href="#proposed-changes" title="Permalink to this headline"></a></h2>
<p>The job queue lock is guaranteed to be released while executing an
opcode/logical unit. This means an opcode can talk to the job queue and
submit more jobs. It then receives the job IDs, like any job submitter
using the LUXI interface would. These job IDs are returned to the
client, who then will then proceed to wait for the jobs to finish.</p>
<p>Technically, the job queue already passes a number of callbacks to the
opcode processor. These are used for giving user feedback, notifying the
job queue of an opcode having gotten its locks, and checking whether the
opcode has been cancelled. A new callback function is added to submit
jobs. Its signature and result will be equivalent to the job queue’s
existing <code class="docutils literal"><span class="pre">SubmitManyJobs</span></code> function.</p>
<p>Logical units can submit jobs by returning an instance of a special
container class with a list of jobs, each of which is a list of opcodes
(e.g.  <code class="docutils literal"><span class="pre">[[op1,</span> <span class="pre">op2],</span> <span class="pre">[op3]]</span></code>). The opcode processor will recognize
instances of the special class when used a return value and will submit
the contained jobs. The submission status and job IDs returned by the
submission callback are used as the opcode’s result. It should be
encapsulated in a dictionary allowing for future extensions.</p>
<p>Example:</p>
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;jobs&quot;</span><span class="o">:</span> <span class="p">[</span>
    <span class="p">(</span><span class="nx">True</span><span class="p">,</span> <span class="s2">&quot;8149&quot;</span><span class="p">),</span>
    <span class="p">(</span><span class="nx">True</span><span class="p">,</span> <span class="s2">&quot;21019&quot;</span><span class="p">),</span>
    <span class="p">(</span><span class="nx">False</span><span class="p">,</span> <span class="s2">&quot;Submission failed&quot;</span><span class="p">),</span>
    <span class="p">(</span><span class="nx">True</span><span class="p">,</span> <span class="s2">&quot;31594&quot;</span><span class="p">),</span>
    <span class="p">],</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Job submissions can fail for variety of reasons, e.g. a full or drained
job queue. Lists of jobs can not be submitted atomically, meaning some
might fail while others succeed. The client is responsible for handling
such cases.</p>
</div>
<div class="section" id="other-discussed-solutions">
<h2><a class="toc-backref" href="#id4">Other discussed solutions</a><a class="headerlink" href="#other-discussed-solutions" title="Permalink to this headline"></a></h2>
<p>Instead of requiring the client to wait for the returned jobs, another
idea was to do so from within the submitting opcode in the master
daemon. While technically possible, doing so would have two major
drawbacks:</p>
<ul class="simple">
<li>Opcodes waiting for other jobs to finish block one job queue worker
thread</li>
<li>All locks must be released before starting the waiting process,
failure to do so can lead to deadlocks</li>
</ul>
<p>Instead of returning the job IDs as part of the normal opcode result,
introducing a new opcode field, e.g. <code class="docutils literal"><span class="pre">op_jobids</span></code>, was discussed and
dismissed. A new field would touch many areas and possibly break some
assumptions. There were also questions about the semantics.</p>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Submitting jobs from logical units</a><ul>
<li><a class="reference internal" href="#current-state-and-shortcomings">Current state and shortcomings</a></li>
<li><a class="reference internal" href="#proposed-changes">Proposed changes</a></li>
<li><a class="reference internal" href="#other-discussed-solutions">Other discussed solutions</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="design-linuxha.html"
                        title="previous chapter">Linux HA integration</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="design-monitoring-agent.html"
                        title="next chapter">Ganeti monitoring agent</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/design-lu-generated-jobs.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="design-monitoring-agent.html" title="Ganeti monitoring agent"
             >next</a></li>
        <li class="right" >
          <a href="design-linuxha.html" title="Linux HA integration"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Ganeti 2.16.0~rc2 documentation</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2018, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Google Inc..
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
    </div>
  </body>
</html>