Ubuntu Manpages

account-server.conf

configuration file for the openstack-swift account server

account-server.conf

This is the configuration file used by the account server and other account background services, such as; replicator, auditor and reaper.

The configuration file follows the python-pastedeploy syntax. The file is divided into sections, which are enclosed by square brackets. Each section will contain a certain number of key/value parameters which are described later.

Any line that begins with a '#' symbol is ignored.

You can find more information about python-pastedeploy configuration format at http://pythonpaste.org/deploy/#config-format

This is indicated by section named [DEFAULT]. Below are the parameters that are acceptable within this section.

IP address the account server should bind to. The default is 0.0.0.0 which will make it bind to all available addresses.
TCP port the account server should bind to. The default is 6002.
TCP backlog. Maximum number of allowed pending connections. The default value is 4096.
The number of pre-forked processes that will accept connections. Zero means no fork. The default is auto which will make the server try to match the number of effective cpu cores if python multiprocessing is available (included with most python distributions >= 2.6) or fallback to one. It's worth noting that individual workers will use many eventlet co-routines to service multiple concurrent requests.
Maximum number of clients one worker can process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. The default is 1024.
The system user that the account server will run as. The default is swift.
Swift configuration directory. The default is /etc/swift.
Parent directory or where devices are mounted. Default is /srv/node.
Whether or not check if the devices are mounted to prevent accidentally writing to the root device. The default is set to true.
Label used when logging. The default is swift.
Syslog log facility. The default is LOG_LOCAL0.
Logging level. The default is INFO.

This is indicated by section name [pipeline:main]. Below are the parameters that are acceptable within this section.

It is used when you need apply a number of filters. It is a list of filters ended by an application. The normal pipeline is "healthcheck recon account-server".

This is indicated by section name [app:account-server]. Below are the parameters that are acceptable within this section.
Entry point for paste.deploy for the account server. This is the reference to the installed python egg. This is normally egg:swift#account.
Label used when logging. The default is account-server.
Syslog log facility. The default is LOG_LOCAL0.
Logging level. The default is INFO.
Enables request logging. The default is True.
Logging address. The default is /dev/log.

Any section that has its name prefixed by "filter:" indicates a filter section. Filters are used to specify configuration parameters for specific swift middlewares. Below are the filters available and respective acceptable parameters.
[filter:healthcheck]
Entry point for paste.deploy for the healthcheck middleware. This is the reference to the installed python egg. This is normally egg:swift#healthcheck.
An optional filesystem path which, if present, will cause the healthcheck URL to return "503 Service Unavailable" with a body of "DISABLED BY FILE".

[filter:recon]
Entry point for paste.deploy for the recon middleware. This is the reference to the installed python egg. This is normally egg:swift#recon.
The recon_cache_path simply sets the directory where stats for a few items will be stored. Depending on the method of deployment you may need to create this directory manually and ensure that swift has read/write. The default is /var/cache/swift.

The following sections are used by other swift-account services, such as replicator, auditor and reaper.
[account-replicator]
Label used when logging. The default is account-replicator.
Syslog log facility. The default is LOG_LOCAL0.
Logging level. The default is INFO.
Logging address. The default is /dev/log.
Indicates that you are using a VM environment. The default is no.
The default is 1000.
This caps how long the replicator will spend trying to sync a given database per pass so the other databases don't get starved. The default is 100.
Number of replication workers to spawn. The default is 8.
Time in seconds to wait between replication passes. The default is 10.
Replaces run_pause with the more standard "interval", which means the replicator won't pause unless it takes less than the interval set. The default is 30.
How long without an error before a node's error count is reset. This will also be how long before a node is re-enabled after suppression is triggered. The default is 60 seconds.
How many errors can accumulate before a node is temporarily ignored. The default is 10 seconds.
Request timeout to external services. The default is 10 seconds.
Connection timeout to external services. The default is 0.5 seconds.
Time elapsed in seconds before an account can be reclaimed. The default is 604800 seconds.

[account-auditor]
Label used when logging. The default is account-auditor.
Syslog log facility. The default is LOG_LOCAL0.
Logging level. The default is INFO.
Logging address. The default is /dev/log.
Will audit, at most, 1 account per device per interval. The default is 1800 seconds.
Maximum accounts audited per second. Should be tuned according to individual system specs. 0 is unlimited. The default is 200.

[account-reaper]
Label used when logging. The default is account-reaper.
Syslog log facility. The default is LOG_LOCAL0.
Logging level. The default is INFO.
Logging address. The default is /dev/log.
Number of reaper workers to spawn. The default is 25.
Minimum time for a pass to take. The default is 3600 seconds.
Request timeout to external services. The default is 10 seconds.
Connection timeout to external services. The default is 0.5 seconds.

More in depth documentation about the swift-account-server and also Openstack-Swift as a whole can be found at http://swift.openstack.org/admin_guide.html and http://swift.openstack.org

swift-account-server(1),