<!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>horizon.api.glance — Horizon 2012.2.3 documentation</title> <link rel="stylesheet" href="../../../_static/nature.css" type="text/css" /> <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../../../_static/tweaks.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../../../', VERSION: '2012.2.3', 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> <script type="text/javascript" src="../../../_static/jquery.tweet.js"></script> <link rel="top" title="Horizon 2012.2.3 documentation" href="../../../index.html" /> <link rel="up" title="horizon" href="../../horizon.html" /> </head> <body> <div id="header"> <h1 id="logo"><a href="http://www.openstack.org/">OpenStack</a></h1> <ul id="navigation"> <li><a href="http://www.openstack.org/" title="Go to the Home page" class="link">Home</a></li> <li><a href="http://www.openstack.org/projects/" title="Go to the OpenStack Projects page">Projects</a></li> <li><a href="http://www.openstack.org/user-stories/" title="Go to the User Stories page" class="link">User Stories</a></li> <li><a href="http://www.openstack.org/community/" title="Go to the Community page" class="link">Community</a></li> <li><a href="http://www.openstack.org/blog/" title="Go to the OpenStack Blog">Blog</a></li> <li><a href="http://wiki.openstack.org/" title="Go to the OpenStack Wiki">Wiki</a></li> <li><a href="http://docs.openstack.org/" title="Go to OpenStack Documentation" class="current">Documentation</a></li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <h1>Source code for horizon.api.glance</h1><div class="highlight"><pre> <span class="c"># vim: tabstop=4 shiftwidth=4 softtabstop=4</span> <span class="c"># Copyright 2012 United States Government as represented by the</span> <span class="c"># Administrator of the National Aeronautics and Space Administration.</span> <span class="c"># All Rights Reserved.</span> <span class="c">#</span> <span class="c"># Copyright 2012 Nebula, Inc.</span> <span class="c">#</span> <span class="c"># Licensed under the Apache License, Version 2.0 (the "License"); you may</span> <span class="c"># not use this file except in compliance with the License. You may obtain</span> <span class="c"># a copy of the License at</span> <span class="c">#</span> <span class="c"># http://www.apache.org/licenses/LICENSE-2.0</span> <span class="c">#</span> <span class="c"># Unless required by applicable law or agreed to in writing, software</span> <span class="c"># distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span> <span class="c"># WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the</span> <span class="c"># License for the specific language governing permissions and limitations</span> <span class="c"># under the License.</span> <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">absolute_import</span> <span class="kn">import</span> <span class="nn">logging</span> <span class="kn">import</span> <span class="nn">thread</span> <span class="kn">import</span> <span class="nn">urlparse</span> <span class="kn">from</span> <span class="nn">django.conf</span> <span class="kn">import</span> <span class="n">settings</span> <span class="kn">import</span> <span class="nn">glanceclient</span> <span class="kn">as</span> <span class="nn">glance_client</span> <span class="kn">from</span> <span class="nn">horizon.api.base</span> <span class="kn">import</span> <span class="n">url_for</span> <span class="n">LOG</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="n">__name__</span><span class="p">)</span> <div class="viewcode-block" id="glanceclient"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.api.glance.html#horizon.api.glance.glanceclient">[docs]</a><span class="k">def</span> <span class="nf">glanceclient</span><span class="p">(</span><span class="n">request</span><span class="p">):</span> <span class="n">o</span> <span class="o">=</span> <span class="n">urlparse</span><span class="o">.</span><span class="n">urlparse</span><span class="p">(</span><span class="n">url_for</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="s">'image'</span><span class="p">))</span> <span class="n">url</span> <span class="o">=</span> <span class="s">"://"</span><span class="o">.</span><span class="n">join</span><span class="p">((</span><span class="n">o</span><span class="o">.</span><span class="n">scheme</span><span class="p">,</span> <span class="n">o</span><span class="o">.</span><span class="n">netloc</span><span class="p">))</span> <span class="n">insecure</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">settings</span><span class="p">,</span> <span class="s">'OPENSTACK_SSL_NO_VERIFY'</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span> <span class="n">LOG</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">'glanceclient connection created using token "</span><span class="si">%s</span><span class="s">" and url "</span><span class="si">%s</span><span class="s">"'</span> <span class="o">%</span> <span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">token</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="n">url</span><span class="p">))</span> <span class="k">return</span> <span class="n">glance_client</span><span class="o">.</span><span class="n">Client</span><span class="p">(</span><span class="s">'1'</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">token</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">token</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="n">insecure</span><span class="o">=</span><span class="n">insecure</span><span class="p">)</span> </div> <div class="viewcode-block" id="image_delete"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.api.glance.html#horizon.api.glance.image_delete">[docs]</a><span class="k">def</span> <span class="nf">image_delete</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">image_id</span><span class="p">):</span> <span class="k">return</span> <span class="n">glanceclient</span><span class="p">(</span><span class="n">request</span><span class="p">)</span><span class="o">.</span><span class="n">images</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">image_id</span><span class="p">)</span> </div> <div class="viewcode-block" id="image_get"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.api.glance.html#horizon.api.glance.image_get">[docs]</a><span class="k">def</span> <span class="nf">image_get</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">image_id</span><span class="p">):</span> <span class="sd">"""</span> <span class="sd"> Returns an Image object populated with metadata for image</span> <span class="sd"> with supplied identifier.</span> <span class="sd"> """</span> <span class="k">return</span> <span class="n">glanceclient</span><span class="p">(</span><span class="n">request</span><span class="p">)</span><span class="o">.</span><span class="n">images</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">image_id</span><span class="p">)</span> </div> <div class="viewcode-block" id="image_list_detailed"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.api.glance.html#horizon.api.glance.image_list_detailed">[docs]</a><span class="k">def</span> <span class="nf">image_list_detailed</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">marker</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> <span class="n">limit</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">settings</span><span class="p">,</span> <span class="s">'API_RESULT_LIMIT'</span><span class="p">,</span> <span class="mi">1000</span><span class="p">)</span> <span class="n">page_size</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">settings</span><span class="p">,</span> <span class="s">'API_RESULT_PAGE_SIZE'</span><span class="p">,</span> <span class="mi">20</span><span class="p">)</span> <span class="n">kwargs</span> <span class="o">=</span> <span class="p">{</span><span class="s">'filters'</span><span class="p">:</span> <span class="n">filters</span> <span class="ow">or</span> <span class="p">{}}</span> <span class="k">if</span> <span class="n">marker</span><span class="p">:</span> <span class="n">kwargs</span><span class="p">[</span><span class="s">'marker'</span><span class="p">]</span> <span class="o">=</span> <span class="n">marker</span> <span class="n">images</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">glanceclient</span><span class="p">(</span><span class="n">request</span><span class="p">)</span><span class="o">.</span><span class="n">images</span><span class="o">.</span><span class="n">list</span><span class="p">(</span><span class="n">page_size</span><span class="o">=</span><span class="n">page_size</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">))</span> <span class="c"># Glance returns (page_size + 1) items if more items are available</span> <span class="k">if</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">images</span><span class="p">)</span> <span class="o">></span> <span class="n">page_size</span><span class="p">):</span> <span class="k">return</span> <span class="p">(</span><span class="n">images</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="bp">True</span><span class="p">)</span> <span class="k">else</span><span class="p">:</span> <span class="k">return</span> <span class="p">(</span><span class="n">images</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span> </div> <div class="viewcode-block" id="image_update"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.api.glance.html#horizon.api.glance.image_update">[docs]</a><span class="k">def</span> <span class="nf">image_update</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">image_id</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> <span class="k">return</span> <span class="n">glanceclient</span><span class="p">(</span><span class="n">request</span><span class="p">)</span><span class="o">.</span><span class="n">images</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">image_id</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> </div> <div class="viewcode-block" id="image_create"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.api.glance.html#horizon.api.glance.image_create">[docs]</a><span class="k">def</span> <span class="nf">image_create</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> <span class="n">copy_from</span> <span class="o">=</span> <span class="bp">None</span> <span class="k">if</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'copy_from'</span><span class="p">):</span> <span class="n">copy_from</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s">'copy_from'</span><span class="p">)</span> <span class="n">image</span> <span class="o">=</span> <span class="n">glanceclient</span><span class="p">(</span><span class="n">request</span><span class="p">)</span><span class="o">.</span><span class="n">images</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="k">if</span> <span class="n">copy_from</span><span class="p">:</span> <span class="n">thread</span><span class="o">.</span><span class="n">start_new_thread</span><span class="p">(</span><span class="n">image_update</span><span class="p">,</span> <span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">image</span><span class="o">.</span><span class="n">id</span><span class="p">),</span> <span class="p">{</span><span class="s">'copy_from'</span><span class="p">:</span> <span class="n">copy_from</span><span class="p">})</span> <span class="k">return</span> <span class="n">image</span> </div> <div class="viewcode-block" id="snapshot_list_detailed"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.api.glance.html#horizon.api.glance.snapshot_list_detailed">[docs]</a><span class="k">def</span> <span class="nf">snapshot_list_detailed</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">marker</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">extra_filters</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> <span class="n">filters</span> <span class="o">=</span> <span class="p">{</span><span class="s">'property-image_type'</span><span class="p">:</span> <span class="s">'snapshot'</span><span class="p">}</span> <span class="n">filters</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">extra_filters</span> <span class="ow">or</span> <span class="p">{})</span> <span class="k">return</span> <span class="n">image_list_detailed</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">marker</span><span class="p">,</span> <span class="n">filters</span><span class="p">)</span></div> </pre></div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../../../search.html" method="get"> <input type="text" name="q" size="18" /> <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" accesskey="I">index</a></li> <li class="right" > <a href="../../../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li><a href="../../../index.html">Horizon 2012.2.3 documentation</a> »</li> <li><a href="../../index.html" >Module code</a> »</li> <li><a href="../../horizon.html" accesskey="U">horizon</a> »</li> </ul> </div> <div class="footer"> © Copyright 2012, OpenStack, LLC. Last updated on Feb 08, 2013. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>