/usr/share/doc/python-manilaclient-doc/html/index.html is in python-manilaclient-doc 1.11.0-2.
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 | <!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>Python bindings to the OpenStack Manila API — python-manilaclient 2.6.10 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: '2.6.10',
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="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="python-manilaclient 2.6.10 documentation" href="#" />
<link rel="next" title="The manila shell utility" href="shell.html" />
</head>
<body role="document">
<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" role="main">
<div class="section" id="python-bindings-to-the-openstack-manila-api">
<h1>Python bindings to the OpenStack Manila API<a class="headerlink" href="#python-bindings-to-the-openstack-manila-api" title="Permalink to this headline">¶</a></h1>
<p>This is a client for OpenStack Manila API. There’s <a class="reference internal" href="api.html"><span class="doc">a Python API</span></a> (the <a class="reference internal" href="api.html#module-manilaclient" title="manilaclient: A client for the OpenStack Manila API."><code class="xref py py-mod docutils literal"><span class="pre">manilaclient</span></code></a> module), and a <a class="reference internal" href="shell.html"><span class="doc">command-line script</span></a> (installed as <strong class="program">manila</strong>). Each implements the entire
OpenStack Manila API.</p>
<p>You’ll need credentials for an OpenStack cloud that implements the
Manila API in order to use the manila client.</p>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="shell.html">The <strong class="program">manila</strong> shell utility</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">The <code class="docutils literal"><span class="pre">manilaclient</span></code> Python API</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html#usage">Usage</a></li>
</ul>
</div>
</div>
<div class="section" id="contributing">
<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h1>
<p>Code is hosted at <a class="reference external" href="https://git.openstack.org/cgit/openstack/python-manilaclient">git.openstack.org</a>. Submit bugs to the
python-manilaclient project on <a class="reference external" href="https://launchpad.net/python-manilaclient">Launchpad</a>. Submit code to the
openstack/python-manilaclient project using <a class="reference external" href="http://docs.openstack.org/infra/manual/developers.html#development-workflow">Gerrit</a>.</p>
<div class="section" id="testing">
<h2>Testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h2>
<p>Manilaclient has two types of tests - ‘unit’ and ‘functional’.</p>
<p>The preferred way to run tests is using <code class="docutils literal"><span class="pre">tox</span></code>.</p>
<p>See <a class="reference external" href="http://git.openstack.org/cgit/openstack/governance/tree/reference/project-testing-interface.rst">Consistent Testing Interface</a> for more details.</p>
</div>
<div class="section" id="functional-tests">
<h2>Functional tests<a class="headerlink" href="#functional-tests" title="Permalink to this headline">¶</a></h2>
<p>Functional CLI tests require several things to be able to run:</p>
<ul class="simple">
<li>Deployed and working manila service.</li>
<li>Configured config file.</li>
</ul>
<p>Config file is used to get information like ‘auth_url’, ‘username’,
‘tenant_name’ and ‘password’.
To get config sample need to run following ‘tox’ job:</p>
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> tox -e genconfig
</pre></div>
</div>
<p>This will create file ‘etc/manilaclient/manilaclient.conf.sample’ with all
available config opts.
Then rename it removing ”.sample” and set values for opts there. After it,
tests can be run using following tox job:</p>
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> tox -e functional
</pre></div>
</div>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
<div class="section" id="release-notes">
<h1>Release Notes<a class="headerlink" href="#release-notes" title="Permalink to this headline">¶</a></h1>
<p>No releases.</p>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Python bindings to the OpenStack Manila API</a></li>
<li><a class="reference internal" href="#contributing">Contributing</a><ul>
<li><a class="reference internal" href="#testing">Testing</a></li>
<li><a class="reference internal" href="#functional-tests">Functional tests</a></li>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
<li><a class="reference internal" href="#release-notes">Release Notes</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="shell.html"
title="next chapter">The <strong class="program">manila</strong> shell utility</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.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" 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" role="navigation" aria-label="related navigation">
<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 class="right" >
<a href="shell.html" title="The manila shell utility"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">python-manilaclient 2.6.10 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright Rackspace, based on work by Jacob Kaplan-Moss.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
</div>
<script type="text/javascript">
try {
//Tracking docs.openstack.org/developer/<projectname> only
//The URL is built from the project variable in conf.py
var pageTracker = _gat._getTracker("UA-17511903-1");
pageTracker._setCookiePath("/developer/python-manilaclient");
pageTracker._trackPageview();
} catch(err) {}</script>
</body>
</html>
|