<!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>Account — Swift v1.0.2 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: '1.0.2',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Swift v1.0.2 documentation" href="index.html" />
<link rel="next" title="Container" href="container.html" />
<link rel="prev" title="Proxy" href="proxy.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="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="container.html" title="Container"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="proxy.html" title="Proxy"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Swift v1.0.2 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="account">
<span id="id1"></span><h1>Account<a class="headerlink" href="#account" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-swift.account.server">
<span id="account-server"></span><h2>Account Server<a class="headerlink" href="#module-swift.account.server" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="swift.account.server.AccountController">
<em class="property">class </em><tt class="descclassname">swift.account.server.</tt><tt class="descname">AccountController</tt><big>(</big><em>conf</em><big>)</big><a class="headerlink" href="#swift.account.server.AccountController" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref docutils literal"><span class="pre">object</span></tt></p>
<p>WSGI controller for the account server.</p>
<dl class="method">
<dt id="swift.account.server.AccountController.DELETE">
<tt class="descname">DELETE</tt><big>(</big><em>req</em><big>)</big><a class="headerlink" href="#swift.account.server.AccountController.DELETE" title="Permalink to this definition">¶</a></dt>
<dd>Handle HTTP DELETE request.</dd></dl>
<dl class="method">
<dt id="swift.account.server.AccountController.GET">
<tt class="descname">GET</tt><big>(</big><em>req</em><big>)</big><a class="headerlink" href="#swift.account.server.AccountController.GET" title="Permalink to this definition">¶</a></dt>
<dd>Handle HTTP GET request.</dd></dl>
<dl class="method">
<dt id="swift.account.server.AccountController.HEAD">
<tt class="descname">HEAD</tt><big>(</big><em>req</em><big>)</big><a class="headerlink" href="#swift.account.server.AccountController.HEAD" title="Permalink to this definition">¶</a></dt>
<dd>Handle HTTP HEAD request.</dd></dl>
<dl class="method">
<dt id="swift.account.server.AccountController.POST">
<tt class="descname">POST</tt><big>(</big><em>req</em><big>)</big><a class="headerlink" href="#swift.account.server.AccountController.POST" title="Permalink to this definition">¶</a></dt>
<dd>Handle HTTP POST request.
Handler for RPC calls for account replication.</dd></dl>
<dl class="method">
<dt id="swift.account.server.AccountController.PUT">
<tt class="descname">PUT</tt><big>(</big><em>req</em><big>)</big><a class="headerlink" href="#swift.account.server.AccountController.PUT" title="Permalink to this definition">¶</a></dt>
<dd>Handle HTTP PUT request.</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-swift.account.auditor">
<span id="account-auditor"></span><h2>Account Auditor<a class="headerlink" href="#module-swift.account.auditor" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="swift.account.auditor.AccountAuditor">
<em class="property">class </em><tt class="descclassname">swift.account.auditor.</tt><tt class="descname">AccountAuditor</tt><big>(</big><em>server_conf</em>, <em>auditor_conf</em><big>)</big><a class="headerlink" href="#swift.account.auditor.AccountAuditor" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref docutils literal"><span class="pre">object</span></tt></p>
<p>Audit accounts.</p>
<dl class="method">
<dt id="swift.account.auditor.AccountAuditor.account_audit">
<tt class="descname">account_audit</tt><big>(</big><em>device</em><big>)</big><a class="headerlink" href="#swift.account.auditor.AccountAuditor.account_audit" title="Permalink to this definition">¶</a></dt>
<dd><p>Audit any accounts found on the device.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>device</em> – device to audit</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.account.auditor.AccountAuditor.audit_forever">
<tt class="descname">audit_forever</tt><big>(</big><big>)</big><a class="headerlink" href="#swift.account.auditor.AccountAuditor.audit_forever" title="Permalink to this definition">¶</a></dt>
<dd>Run the account audit until stopped.</dd></dl>
<dl class="method">
<dt id="swift.account.auditor.AccountAuditor.audit_once">
<tt class="descname">audit_once</tt><big>(</big><big>)</big><a class="headerlink" href="#swift.account.auditor.AccountAuditor.audit_once" title="Permalink to this definition">¶</a></dt>
<dd>Run the account audit once.</dd></dl>
<dl class="method">
<dt id="swift.account.auditor.AccountAuditor.get_container_ring">
<tt class="descname">get_container_ring</tt><big>(</big><big>)</big><a class="headerlink" href="#swift.account.auditor.AccountAuditor.get_container_ring" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the container ring. Load the ring if neccesary.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">container ring</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="exception">
<dt id="swift.account.auditor.AuditException">
<em class="property">exception </em><tt class="descclassname">swift.account.auditor.</tt><tt class="descname">AuditException</tt><a class="headerlink" href="#swift.account.auditor.AuditException" title="Permalink to this definition">¶</a></dt>
<dd>Bases: <tt class="xref docutils literal"><span class="pre">exceptions.Exception</span></tt></dd></dl>
<dl class="function">
<dt id="swift.account.auditor.random">
<tt class="descclassname">swift.account.auditor.</tt><tt class="descname">random</tt><big>(</big><big>)</big><a class="headerlink" href="#swift.account.auditor.random" title="Permalink to this definition">¶</a></dt>
<dd>random() -> x in the interval [0, 1).</dd></dl>
</div>
<div class="section" id="module-swift.account.reaper">
<span id="account-reaper"></span><h2>Account Reaper<a class="headerlink" href="#module-swift.account.reaper" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="swift.account.reaper.AccountReaper">
<em class="property">class </em><tt class="descclassname">swift.account.reaper.</tt><tt class="descname">AccountReaper</tt><big>(</big><em>server_conf</em>, <em>reaper_conf</em><big>)</big><a class="headerlink" href="#swift.account.reaper.AccountReaper" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref docutils literal"><span class="pre">object</span></tt></p>
<p>Removes data from status=DELETED accounts. These are accounts that have
been asked to be removed by the reseller via services
remove_storage_account XMLRPC call.</p>
<p>The account is not deleted immediately by the services call, but instead
the account is simply marked for deletion by setting the status column in
the account_stat table of the account database. This account reaper scans
for such accounts and removes the data in the background. The background
deletion process will occur on the primary account server for the account.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><em>server_conf</em> – The [account-server] dictionary of the account server
configuration file</li>
<li><em>reaper_conf</em> – The [account-reaper] dictionary of the account server
configuration file</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>See the etc/account-server.conf-sample for information on the possible
configuration parameters.</p>
<dl class="method">
<dt id="swift.account.reaper.AccountReaper.get_account_ring">
<tt class="descname">get_account_ring</tt><big>(</big><big>)</big><a class="headerlink" href="#swift.account.reaper.AccountReaper.get_account_ring" title="Permalink to this definition">¶</a></dt>
<dd>The account <tt class="xref docutils literal"><span class="pre">swift.common.ring.Ring</span></tt> for the cluster.</dd></dl>
<dl class="method">
<dt id="swift.account.reaper.AccountReaper.get_container_ring">
<tt class="descname">get_container_ring</tt><big>(</big><big>)</big><a class="headerlink" href="#swift.account.reaper.AccountReaper.get_container_ring" title="Permalink to this definition">¶</a></dt>
<dd>The container <tt class="xref docutils literal"><span class="pre">swift.common.ring.Ring</span></tt> for the cluster.</dd></dl>
<dl class="method">
<dt id="swift.account.reaper.AccountReaper.get_object_ring">
<tt class="descname">get_object_ring</tt><big>(</big><big>)</big><a class="headerlink" href="#swift.account.reaper.AccountReaper.get_object_ring" title="Permalink to this definition">¶</a></dt>
<dd>The object <tt class="xref docutils literal"><span class="pre">swift.common.ring.Ring</span></tt> for the cluster.</dd></dl>
<dl class="method">
<dt id="swift.account.reaper.AccountReaper.reap_account">
<tt class="descname">reap_account</tt><big>(</big><em>broker</em>, <em>partition</em>, <em>nodes</em><big>)</big><a class="headerlink" href="#swift.account.reaper.AccountReaper.reap_account" title="Permalink to this definition">¶</a></dt>
<dd><p>Called once per pass for each account this server is the primary for
and attempts to delete the data for the given account. The reaper will
only delete one account at any given time. It will call
<a title="swift.account.reaper.AccountReaper.reap_container" class="reference internal" href="#swift.account.reaper.AccountReaper.reap_container"><tt class="xref docutils literal"><span class="pre">reap_container()</span></tt></a> up to sqrt(self.concurrency) times concurrently
while reaping the account.</p>
<p>If there is any exception while deleting a single container, the
process will continue for any other containers and the failed
containers will be tried again the next time this function is called
with the same parameters.</p>
<p>If there is any exception while listing the containers for deletion,
the process will stop (but will obviously be tried again the next time
this function is called with the same parameters). This isn’t likely
since the listing comes from the local database.</p>
<p>After the process completes (successfully or not) statistics about what
was accomplished will be logged.</p>
<p>This function returns nothing and should raise no exception but only
update various self.stats_* values for what occurs.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><em>broker</em> – The AccountBroker for the account to delete.</li>
<li><em>partition</em> – The partition in the account ring the account is on.</li>
<li><em>nodes</em> – The primary node dicts for the account to delete.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<ul class="simple">
<li>See also: <a title="swift.common.db.AccountBroker" class="reference external" href="db.html#swift.common.db.AccountBroker"><tt class="xref docutils literal"><span class="pre">swift.common.db.AccountBroker</span></tt></a> for the broker class.</li>
<li>See also: <tt class="xref docutils literal"><span class="pre">swift.common.ring.Ring.get_nodes()</span></tt> for a description
of the node dicts.</li>
</ul>
</dd></dl>
<dl class="method">
<dt id="swift.account.reaper.AccountReaper.reap_container">
<tt class="descname">reap_container</tt><big>(</big><em>account</em>, <em>account_partition</em>, <em>account_nodes</em>, <em>container</em><big>)</big><a class="headerlink" href="#swift.account.reaper.AccountReaper.reap_container" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes the data and the container itself for the given container. This
will call <a title="swift.account.reaper.AccountReaper.reap_object" class="reference internal" href="#swift.account.reaper.AccountReaper.reap_object"><tt class="xref docutils literal"><span class="pre">reap_object()</span></tt></a> up to sqrt(self.concurrency) times
concurrently for the objects in the container.</p>
<p>If there is any exception while deleting a single object, the process
will continue for any other objects in the container and the failed
objects will be tried again the next time this function is called with
the same parameters.</p>
<p>If there is any exception while listing the objects for deletion, the
process will stop (but will obviously be tried again the next time this
function is called with the same parameters). This is a possibility
since the listing comes from querying just the primary remote container
server.</p>
<p>Once all objects have been attempted to be deleted, the container
itself will be attempted to be deleted by sending a delete request to
all container nodes. The format of the delete request is such that each
container server will update a corresponding account server, removing
the container from the account’s listing.</p>
<p>This function returns nothing and should raise no exception but only
update various self.stats_* values for what occurs.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><em>account</em> – The name of the account for the container.</li>
<li><em>account_partition</em> – The partition for the account on the account
ring.</li>
<li><em>account_nodes</em> – The primary node dicts for the account.</li>
<li><em>container</em> – The name of the container to delete.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<ul class="simple">
<li>See also: <tt class="xref docutils literal"><span class="pre">swift.common.ring.Ring.get_nodes()</span></tt> for a description
of the account node dicts.</li>
</ul>
</dd></dl>
<dl class="method">
<dt id="swift.account.reaper.AccountReaper.reap_device">
<tt class="descname">reap_device</tt><big>(</big><em>device</em><big>)</big><a class="headerlink" href="#swift.account.reaper.AccountReaper.reap_device" title="Permalink to this definition">¶</a></dt>
<dd><p>Called once per pass for each device on the server. This will scan the
accounts directory for the device, looking for partitions this device
is the primary for, then looking for account databases that are marked
status=DELETED and still have containers and calling
<a title="swift.account.reaper.AccountReaper.reap_account" class="reference internal" href="#swift.account.reaper.AccountReaper.reap_account"><tt class="xref docutils literal"><span class="pre">reap_account()</span></tt></a>. Account databases marked status=DELETED that no
longer have containers will eventually be permanently removed by the
reclaim process within the account replicator (see
<tt class="xref docutils literal"><span class="pre">swift.db_replicator</span></tt>).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>device</em> – The device to look for accounts to be deleted.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.account.reaper.AccountReaper.reap_forever">
<tt class="descname">reap_forever</tt><big>(</big><big>)</big><a class="headerlink" href="#swift.account.reaper.AccountReaper.reap_forever" title="Permalink to this definition">¶</a></dt>
<dd>Main entry point when running the reaper in its normal daemon mode.
This repeatedly calls <a title="swift.account.reaper.AccountReaper.reap_once" class="reference internal" href="#swift.account.reaper.AccountReaper.reap_once"><tt class="xref docutils literal"><span class="pre">reap_once()</span></tt></a> no quicker than the
configuration interval.</dd></dl>
<dl class="method">
<dt id="swift.account.reaper.AccountReaper.reap_object">
<tt class="descname">reap_object</tt><big>(</big><em>account</em>, <em>container</em>, <em>container_partition</em>, <em>container_nodes</em>, <em>obj</em><big>)</big><a class="headerlink" href="#swift.account.reaper.AccountReaper.reap_object" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes the given object by issuing a delete request to each node for
the object. The format of the delete request is such that each object
server will update a corresponding container server, removing the
object from the container’s listing.</p>
<p>This function returns nothing and should raise no exception but only
update various self.stats_* values for what occurs.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><em>account</em> – The name of the account for the object.</li>
<li><em>container</em> – The name of the container for the object.</li>
<li><em>container_partition</em> – The partition for the container on the
container ring.</li>
<li><em>container_nodes</em> – The primary node dicts for the container.</li>
<li><em>obj</em> – The name of the object to delete.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<ul class="simple">
<li>See also: <tt class="xref docutils literal"><span class="pre">swift.common.ring.Ring.get_nodes()</span></tt> for a description
of the container node dicts.</li>
</ul>
</dd></dl>
<dl class="method">
<dt id="swift.account.reaper.AccountReaper.reap_once">
<tt class="descname">reap_once</tt><big>(</big><big>)</big><a class="headerlink" href="#swift.account.reaper.AccountReaper.reap_once" title="Permalink to this definition">¶</a></dt>
<dd>Main entry point when running the reaper in ‘once’ mode, where it will
do a single pass over all accounts on the server. This is called
repeatedly by <a title="swift.account.reaper.AccountReaper.reap_forever" class="reference internal" href="#swift.account.reaper.AccountReaper.reap_forever"><tt class="xref docutils literal"><span class="pre">reap_forever()</span></tt></a>. This will call <a title="swift.account.reaper.AccountReaper.reap_device" class="reference internal" href="#swift.account.reaper.AccountReaper.reap_device"><tt class="xref docutils literal"><span class="pre">reap_device()</span></tt></a>
once for each device on the server.</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="#">Account</a><ul>
<li><a class="reference external" href="#module-swift.account.server">Account Server</a></li>
<li><a class="reference external" href="#module-swift.account.auditor">Account Auditor</a></li>
<li><a class="reference external" href="#module-swift.account.reaper">Account Reaper</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="proxy.html"
title="previous chapter">Proxy</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="container.html"
title="next chapter">Container</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/account.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">
<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="modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="container.html" title="Container"
>next</a> |</li>
<li class="right" >
<a href="proxy.html" title="Proxy"
>previous</a> |</li>
<li><a href="index.html">Swift v1.0.2 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010, OpenStack, LLC..
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.6.
</div>
</body>
</html>
distrib
>
Fedora
>
13
>
i386
>
media
>
updates
>
by-pkgid
>
e2eef204a8562d4f753a051d0e998dc4
>
files
>
32
