From 6a9d5f921d54425d602e60f01c5b9add825f0daf Mon Sep 17 00:00:00 2001 From: Marcelo Martins Date: Fri, 6 Apr 2012 14:58:35 -0500 Subject: [PATCH] Appending some new information to proxy, account and container config manpages. Adding object-expirer files and swift-orphans as well. Also making some minor modification on the other files to stop lithian from complaining during package creation checks. Adding name to Authors file. Change-Id: Id68231ced070b27d1f7fb5a230d345694632e7dd --- doc/manpages/account-server.conf.5 | 10 +- doc/manpages/container-server.conf.5 | 20 +-- doc/manpages/dispersion.conf.5 | 5 +- doc/manpages/object-expirer.conf.5 | 142 ++++++++++++++++++++++ doc/manpages/object-server.conf.5 | 4 +- doc/manpages/proxy-server.conf.5 | 85 ++++++++++--- doc/manpages/swift-account-auditor.1 | 4 +- doc/manpages/swift-account-reaper.1 | 4 +- doc/manpages/swift-account-replicator.1 | 4 +- doc/manpages/swift-container-auditor.1 | 4 +- doc/manpages/swift-container-replicator.1 | 4 +- doc/manpages/swift-container-updater.1 | 4 +- doc/manpages/swift-object-auditor.1 | 4 +- doc/manpages/swift-object-expirer.1 | 81 ++++++++++++ doc/manpages/swift-object-replicator.1 | 4 +- doc/manpages/swift-object-updater.1 | 4 +- doc/manpages/swift-orphans.1 | 69 +++++++++++ 17 files changed, 400 insertions(+), 52 deletions(-) create mode 100644 doc/manpages/object-expirer.conf.5 create mode 100644 doc/manpages/swift-object-expirer.1 create mode 100644 doc/manpages/swift-orphans.1 diff --git a/doc/manpages/account-server.conf.5 b/doc/manpages/account-server.conf.5 index d77510343c..b9db0d68e6 100644 --- a/doc/manpages/account-server.conf.5 +++ b/doc/manpages/account-server.conf.5 @@ -1,6 +1,6 @@ .\" .\" Author: Joao Marcelo Martins or -.\" Copyright (c) 2010-2011 OpenStack, LLC. +.\" Copyright (c) 2010-2012 OpenStack, LLC. .\" .\" Licensed under the Apache License, Version 2.0 (the "License"); .\" you may not use this file except in compliance with the License. @@ -152,12 +152,16 @@ Logging level. The default is INFO. Indicates that you are using a VM environment. The default is no. .IP \fBper_diff\fR The default is 1000. +.IP \fBmax_diffs\fR +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. .IP \fBconcurrency\fR Number of replication workers to spawn. The default is 8. -.IP \fBrun_pause\fR +.IP "\fBrun_pause [deprecated]\fR" Time in seconds to wait between replication passes. The default is 10. +.IP \fBinterval\fR +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. .IP \fBerror_suppression_interval\fR -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. +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. .IP \fBerror_suppression_limit\fR How many errors can accumulate before a node is temporarily ignored. The default diff --git a/doc/manpages/container-server.conf.5 b/doc/manpages/container-server.conf.5 index 5f15ffe076..a1990b9ca4 100644 --- a/doc/manpages/container-server.conf.5 +++ b/doc/manpages/container-server.conf.5 @@ -1,6 +1,6 @@ .\" .\" Author: Joao Marcelo Martins or -.\" Copyright (c) 2010-2011 OpenStack, LLC. +.\" Copyright (c) 2010-2012 OpenStack, LLC. .\" .\" Licensed under the Apache License, Version 2.0 (the "License"); .\" you may not use this file except in compliance with the License. @@ -154,12 +154,16 @@ Syslog log facility. The default is LOG_LOCAL0. Logging level. The default is INFO. .IP \fBvm_test_mode\fR Indicates that you are using a VM environment. The default is no. -.IP \fBper_diff\fR +.IP \fBer_diff\fR The default is 1000. +.IP \fBmax_diffs\fR +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. .IP \fBconcurrency\fR Number of replication workers to spawn. The default is 8. -.IP \fBrun_pause\fR -Time in seconds to wait between replication passes. The default is 30. +.IP "\fBrun_pause [deprecated]\fR" +Time in seconds to wait between replication passes. The default is 10. +.IP \fBinterval\fR +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. .IP \fBnode_timeout\fR Request timeout to external services. The default is 10 seconds. .IP \fBconn_timeout\fR @@ -188,10 +192,10 @@ Number of reaper workers to spawn. The default is 4. Request timeout to external services. The default is 3 seconds. .IP \fBconn_timeout\fR Connection timeout to external services. The default is 0.5 seconds. -.IP \fBslowdown = 0.01\fR +.IP \fBslowdown = 0.01\fR Slowdown will sleep that amount between containers. The default is 0.01 seconds. .IP \fBaccount_suppression_time\fR -Seconds to suppress updating an account that has generated an error. The default is 60 seconds. +Seconds to suppress updating an account that has generated an error. The default is 60 seconds. .RE .PD @@ -227,13 +231,13 @@ If you need to use an HTTP Proxy, set it here; defaults to no proxy. .IP \fBinterval\fR Will audit, at most, each container once per interval. The default is 300 seconds. .IP \fBcontainer_time\fR -Maximum amount of time to spend syncing each container per pass. The default is 60 seconds. +Maximum amount of time to spend syncing each container per pass. The default is 60 seconds. .RE .PD - + .SH DOCUMENTATION .LP More in depth documentation about the swift-container-server and diff --git a/doc/manpages/dispersion.conf.5 b/doc/manpages/dispersion.conf.5 index d9175ee28e..0e96926b5a 100644 --- a/doc/manpages/dispersion.conf.5 +++ b/doc/manpages/dispersion.conf.5 @@ -1,6 +1,6 @@ .\" .\" Author: Joao Marcelo Martins or -.\" Copyright (c) 2010-2011 OpenStack, LLC. +.\" Copyright (c) 2010-2012 OpenStack, LLC. .\" .\" Licensed under the Apache License, Version 2.0 (the "License"); .\" you may not use this file except in compliance with the License. @@ -64,10 +64,11 @@ Maximum number of concurrencies to .IP "# dispersion_coverage = 1" .IP "# retries = 5" .IP "# concurrency = 25" +.IP "# dump_json = no" .RE .PD - + .SH DOCUMENTATION .LP More in depth documentation about the swift-dispersion utilities and diff --git a/doc/manpages/object-expirer.conf.5 b/doc/manpages/object-expirer.conf.5 new file mode 100644 index 0000000000..3dd74eb0c0 --- /dev/null +++ b/doc/manpages/object-expirer.conf.5 @@ -0,0 +1,142 @@ +.\" +.\" Author: Joao Marcelo Martins or +.\" Copyright (c) 2012 OpenStack, LLC. +.\" +.\" Licensed under the Apache License, Version 2.0 (the "License"); +.\" you may not use this file except in compliance with the License. +.\" You may obtain a copy of the License at +.\" +.\" http://www.apache.org/licenses/LICENSE-2.0 +.\" +.\" Unless required by applicable law or agreed to in writing, software +.\" distributed under the License is distributed on an "AS IS" BASIS, +.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +.\" implied. +.\" See the License for the specific language governing permissions and +.\" limitations under the License. +.\" +.TH object-expirer.conf 5 "03/15/2012" "Linux" "OpenStack Swift" + +.SH NAME +.LP +.B object-expirer.conf +\- configuration file for the openstack-swift object exprier daemon + + + +.SH SYNOPSIS +.LP +.B object-expirer.conf + + + +.SH DESCRIPTION +.PP +This is the configuration file used by the object expirer daemon. The daemon's +function is to query the internal hidden expiring_objects_account to discover +objects that need to be deleted and to then delete them. + +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 +\fIhttp://pythonpaste.org/deploy/#config-format\fR + + + +.SH GLOBAL SECTION +.PD 1 +.RS 0 +This is indicated by section named [DEFAULT]. Below are the parameters that +are acceptable within this section. + +.IP \fBswift_dir\fR +Swift configuration directory. The default is /etc/swift. +.IP \fBuser\fR +The system user that the object server will run as. The default is swift. +.IP \fBlog_name\fR +Label used when logging. The default is swift. +.IP \fBlog_facility\fR +Syslog log facility. The default is LOG_LOCAL0. +.IP \fBlog_level\fR +Logging level. The default is INFO. +.RE +.PD + + + +.SH PIPELINE SECTION +.PD 1 +.RS 0 +This is indicated by section name [pipeline:main]. Below are the parameters that +are acceptable within this section. + +.IP "\fBpipeline\fR" +It is used when you need to apply a number of filters. It is a list of filters +ended by an application. The default should be \fB"catch_errors cache proxy-server"\fR +.RE +.PD + + + +.SH APP SECTION +.PD 1 +.RS 0 +This is indicated by section name [app:object-server]. Below are the parameters +that are acceptable within this section. +.IP "\fBuse\fR" +Entry point for paste.deploy for the object server. This is the reference to the installed python egg. +The default is \fBegg:swift#proxy\fR. See proxy-server.conf-sample for options or See proxy-server.conf manpage. +.RE +.PD + + + +.SH FILTER SECTION +.PD 1 +.RS 0 +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. + +.RS 0 +.IP "\fB[filter:cache]\fR" +.RE + +Caching middleware that manages caching in swift. + +.RS 3 +.IP \fBuse\fR +Entry point for paste.deploy for the memcache middleware. This is the reference to the installed python egg. +The default is \fBegg:swift#memcache\fR. See proxy-server.conf-sample for options or See proxy-server.conf manpage. +.RE + + +.RS 0 +.IP "\fB[filter:catch_errors]\fR" +.RE +.RS 3 +.IP \fBuse\fR +Entry point for paste.deploy for the catch_errors middleware. This is the reference to the installed python egg. +The default is \fBegg:swift#catch_errors\fR. See proxy-server.conf-sample for options or See proxy-server.conf manpage. +.RE + +.PD + + + +.SH DOCUMENTATION +.LP +More in depth documentation about the swift-object-expirer and +also Openstack-Swift as a whole can be found at +.BI http://swift.openstack.org/admin_guide.html +and +.BI http://swift.openstack.org + + +.SH "SEE ALSO" +.BR swift-proxy-server.conf(5), + diff --git a/doc/manpages/object-server.conf.5 b/doc/manpages/object-server.conf.5 index 5031d58ac4..82d9c4f466 100644 --- a/doc/manpages/object-server.conf.5 +++ b/doc/manpages/object-server.conf.5 @@ -1,6 +1,6 @@ .\" .\" Author: Joao Marcelo Martins or -.\" Copyright (c) 2010-2011 OpenStack, LLC. +.\" Copyright (c) 2010-2012 OpenStack, LLC. .\" .\" Licensed under the Apache License, Version 2.0 (the "License"); .\" you may not use this file except in compliance with the License. @@ -214,7 +214,7 @@ Number of reaper workers to spawn. The default is 1. Request timeout to external services. The default is 10 seconds. .IP \fBconn_timeout\fR Connection timeout to external services. The default is 0.5 seconds. -.IP \fBslowdown = 0.01\fR +.IP \fBslowdown = 0.01\fR Slowdown will sleep that amount between objects. The default is 0.01 seconds. .RE .PD diff --git a/doc/manpages/proxy-server.conf.5 b/doc/manpages/proxy-server.conf.5 index 4979e4da22..7a5273c3fe 100644 --- a/doc/manpages/proxy-server.conf.5 +++ b/doc/manpages/proxy-server.conf.5 @@ -1,6 +1,6 @@ .\" .\" Author: Joao Marcelo Martins or -.\" Copyright (c) 2010-2011 OpenStack, LLC. +.\" Copyright (c) 2010-2012 OpenStack, LLC. .\" .\" Licensed under the Apache License, Version 2.0 (the "License"); .\" you may not use this file except in compliance with the License. @@ -130,7 +130,7 @@ Enables the ability to log request headers. The default is False. The reseller prefix will verify a token begins with this prefix before even attempting to validate it. Also, with authorization, only Swift storage accounts with this prefix will be authorized by this middleware. Useful if multiple auth -systems are in use for one Swift cluster. The default is AUTH. +systems are in use for one Swift cluster. The default is AUTH. .IP \fBauth_prefix\fR The auth prefix will cause requests beginning with this prefix to be routed to the auth subsystem, for granting tokens, etc. The default is /auth/. @@ -147,7 +147,7 @@ and also \fI.admin\fR who can do anything within the account. If neither of these groups are specified, the user can only access containers that have been explicitly allowed for them by a \fI.admin\fR or \fI.reseller_admin\fR. - The trailing optional storage_url allows you to specify an alternate url to hand +The trailing optional storage_url allows you to specify an alternate url to hand back to the user upon authentication. If not specified, this defaults to \fIhttp[s]://:/v1/_\fR where http or https depends on whether cert_file is specified in the [DEFAULT] section, and are based @@ -158,7 +158,8 @@ Here are example entries, required for running the tests: .RE .PD 0 -.RS 10 .IP "user_admin_admin = admin .admin .reseller_admin" +.RS 10 +.IP "user_admin_admin = admin .admin .reseller_admin" .IP "user_test_tester = testing .admin" .IP "user_test2_tester2 = testing2 .admin" .IP "user_test_tester3 = testing3" @@ -203,8 +204,7 @@ Logging level. The default is INFO. .IP "\fBset log_headers\fR " Enables the ability to log request headers. The default is False. .IP \fBmemcache_servers\fR -The memcache servers that are available. This can be a list separated by commas. The default -is 127.0.0.1:11211. +Default for memcache_servers is to try to read the property from /etc/swift/memcache.conf (see memcache.conf-sample) or lacking that file, it will default to the value below. You can specify multiple servers separated with commas, as in: 10.1.2.3:11211,10.1.2.4:11211. This can be a list separated by commas. The default is 127.0.0.1:11211. .RE @@ -230,7 +230,7 @@ Enables the ability to log request headers. The default is False. .IP \fBclock_accuracy\fR This should represent how accurate the proxy servers' system clocks are with each other. 1000 means that all the proxies' clock are accurate to each other within 1 millisecond. -No ratelimit should be higher than the clock accuracy. The default is 1000. +No ratelimit should be higher than the clock accuracy. The default is 1000. .IP \fBmax_sleep_time_seconds\fR App will immediately return a 498 response if the necessary sleep time ever exceeds the given max_sleep_time_seconds. The default is 60 seconds. @@ -260,13 +260,7 @@ to r. Will limit PUT, DELETE, and POST requests to /a/c/o. The default is ''. .IP "\fB[filter:domain_remap]\fR" .RE -Middleware that translates container and account parts of a domain to path parameters that the proxy server understands. - -\fIcontainer.account.storageurl/object\fR gets translated to -\fIcontainer.account.storageurl/path_root/account/container/object\fR - - \fIaccount.storageurl/path_root/container/object\fR gets translated to -\fIaccount.storageurl/path_root/account/container/object\fR +Middleware that translates container and account parts of a domain to path parameters that the proxy server understands. The container.account.storageurl/object gets translated to container.account.storageurl/path_root/account/container/object and account.storageurl/path_root/container/object gets translated to account.storageurl/path_root/account/container/object .RS 3 .IP \fBuse\fR @@ -281,9 +275,9 @@ Logging level. The default is INFO. .IP "\fBset log_headers\fR" Enables the ability to log request headers. The default is False. .IP \fBstorage_domain\fR -The domain to be used by the middleware. +The domain to be used by the middleware. .IP \fBpath_root\fR -The path root value for the storage URL. The default is v1. +The path root value for the storage URL. The default is v1. .IP \fBreseller_prefixes\fR Browsers can convert a host header to lowercase, so check that reseller prefix on the account is the correct case. This is done by comparing the @@ -334,7 +328,7 @@ Logging level. The default is INFO. .IP "\fBset log_headers\fR" Enables the ability to log request headers. The default is False. .IP \fBstorage_domain\fR -The domain to be used by the middleware. +The domain to be used by the middleware. .IP \fBlookup_depth\fR How deep in the CNAME chain to look for something that matches the storage domain. The default is 1. @@ -370,6 +364,59 @@ Syslog log facility. The default is LOG_LOCAL0. Logging level. The default is INFO. .RE + + +.RS 0 +.IP "\fB[filter:tempurl]\fR" +.RE + +Note: Put tempurl just before your auth filter(s) in the pipeline + +.RS 3 +.IP \fBincoming_remove_headers\fR +The headers to remove from incoming requests. Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match. incoming_allow_headers is a list of exceptions to these removals. +.IP \fBincoming_allow_headers\fR +The headers allowed as exceptions to incoming_remove_headers. Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match. +.IP "\fBoutgoing_remove_headers\fR" +The headers to remove from outgoing responses. Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match. outgoing_allow_headers is a list of exceptions to these removals. +.IP "\fBoutgoing_allow_headers\fR" +The headers allowed as exceptions to outgoing_remove_headers. Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match. +.IP "\fBset log_level\fR " +.RE + + + +.RS 0 +.IP "\fB[filter:formpost]\fR" +.RE + +Note: Put formpost just before your auth filter(s) in the pipeline + +.RS 3 +.IP \fBuse\fR +Entry point for paste.deploy for the formpost middleware. This is the reference to the installed python egg. +The default is \fBegg:swift#formpost\fR. +.RE + + + +.RS 0 +.IP "\fB[filter:name_check]\fR" +.RE + +Note: Just needs to be placed before the proxy-server in the pipeline. + +.RS 3 +.IP \fBuse\fR +Entry point for paste.deploy for the name_check middleware. This is the reference to the installed python egg. +The default is \fBegg:swift#name_check\fR. +.IP \fBforbidden_chars\fR +Characters that will not be allowed in a name. +.IP \fBmaximum_length\fR +Maximum number of characters that can be in the name. +.RE + + .PD @@ -404,7 +451,7 @@ Cache timeout in seconds to send memcached for container existence. The default .IP \fBobject_chunk_size\fR Chunk size to read from object servers. The default is 8192. .IP \fBclient_chunk_size\fR -Chunk size to read from clients. The default is 8192. +Chunk size to read from clients. The default is 8192. .IP \fBnode_timeout\fR Request timeout to external services. The default is 10 seconds. .IP \fBclient_timeoutt\fR @@ -432,7 +479,7 @@ will be automatically created. The default is set to false. .PD - + .SH DOCUMENTATION .LP More in depth documentation about the swift-proxy-server and diff --git a/doc/manpages/swift-account-auditor.1 b/doc/manpages/swift-account-auditor.1 index 5754ad7571..3e5ae591ff 100644 --- a/doc/manpages/swift-account-auditor.1 +++ b/doc/manpages/swift-account-auditor.1 @@ -1,6 +1,6 @@ .\" .\" Author: Joao Marcelo Martins or -.\" Copyright (c) 2010-2011 OpenStack, LLC. +.\" Copyright (c) 2010-2012 OpenStack, LLC. .\" .\" Licensed under the Apache License, Version 2.0 (the "License"); .\" you may not use this file except in compliance with the License. @@ -48,7 +48,7 @@ The options are as follows: .RS 4 .IP "only run one pass of daemon" .RE -.PD +.PD .RE .SH DOCUMENTATION diff --git a/doc/manpages/swift-account-reaper.1 b/doc/manpages/swift-account-reaper.1 index e63dfaa811..8daa360b5d 100644 --- a/doc/manpages/swift-account-reaper.1 +++ b/doc/manpages/swift-account-reaper.1 @@ -1,6 +1,6 @@ .\" .\" Author: Joao Marcelo Martins or -.\" Copyright (c) 2010-2011 OpenStack, LLC. +.\" Copyright (c) 2010-2012 OpenStack, LLC. .\" .\" Licensed under the Apache License, Version 2.0 (the "License"); .\" you may not use this file except in compliance with the License. @@ -53,7 +53,7 @@ The options are as follows: .RS 4 .IP "only run one pass of daemon" .RE -.PD +.PD .RE diff --git a/doc/manpages/swift-account-replicator.1 b/doc/manpages/swift-account-replicator.1 index 47fe99f36b..94fa32251a 100644 --- a/doc/manpages/swift-account-replicator.1 +++ b/doc/manpages/swift-account-replicator.1 @@ -1,6 +1,6 @@ .\" .\" Author: Joao Marcelo Martins or -.\" Copyright (c) 2010-2011 OpenStack, LLC. +.\" Copyright (c) 2010-2012 OpenStack, LLC. .\" .\" Licensed under the Apache License, Version 2.0 (the "License"); .\" you may not use this file except in compliance with the License. @@ -55,7 +55,7 @@ The options are as follows: .RS 4 .IP "only run one pass of daemon" .RE -.PD +.PD .RE diff --git a/doc/manpages/swift-container-auditor.1 b/doc/manpages/swift-container-auditor.1 index abeb9f6930..fa46258712 100644 --- a/doc/manpages/swift-container-auditor.1 +++ b/doc/manpages/swift-container-auditor.1 @@ -1,6 +1,6 @@ .\" .\" Author: Joao Marcelo Martins or -.\" Copyright (c) 2010-2011 OpenStack, LLC. +.\" Copyright (c) 2010-2012 OpenStack, LLC. .\" .\" Licensed under the Apache License, Version 2.0 (the "License"); .\" you may not use this file except in compliance with the License. @@ -48,7 +48,7 @@ The options are as follows: .RS 4 .IP "only run one pass of daemon" .RE -.PD +.PD .RE diff --git a/doc/manpages/swift-container-replicator.1 b/doc/manpages/swift-container-replicator.1 index f1f7a11cd1..79e12ac33a 100644 --- a/doc/manpages/swift-container-replicator.1 +++ b/doc/manpages/swift-container-replicator.1 @@ -1,6 +1,6 @@ .\" .\" Author: Joao Marcelo Martins or -.\" Copyright (c) 2010-2011 OpenStack, LLC. +.\" Copyright (c) 2010-2012 OpenStack, LLC. .\" .\" Licensed under the Apache License, Version 2.0 (the "License"); .\" you may not use this file except in compliance with the License. @@ -55,7 +55,7 @@ The options are as follows: .RS 4 .IP "only run one pass of daemon" .RE -.PD +.PD .RE diff --git a/doc/manpages/swift-container-updater.1 b/doc/manpages/swift-container-updater.1 index 978638ced5..8cfc8ee205 100644 --- a/doc/manpages/swift-container-updater.1 +++ b/doc/manpages/swift-container-updater.1 @@ -1,6 +1,6 @@ .\" .\" Author: Joao Marcelo Martins or -.\" Copyright (c) 2010-2011 OpenStack, LLC. +.\" Copyright (c) 2010-2012 OpenStack, LLC. .\" .\" Licensed under the Apache License, Version 2.0 (the "License"); .\" you may not use this file except in compliance with the License. @@ -57,7 +57,7 @@ The options are as follows: .RS 4 .IP "only run one pass of daemon" .RE -.PD +.PD .RE .SH DOCUMENTATION diff --git a/doc/manpages/swift-object-auditor.1 b/doc/manpages/swift-object-auditor.1 index 47aef4e53a..2ce94f21c3 100644 --- a/doc/manpages/swift-object-auditor.1 +++ b/doc/manpages/swift-object-auditor.1 @@ -1,6 +1,6 @@ .\" .\" Author: Joao Marcelo Martins or -.\" Copyright (c) 2010-2011 OpenStack, LLC. +.\" Copyright (c) 2010-2012 OpenStack, LLC. .\" .\" Licensed under the Apache License, Version 2.0 (the "License"); .\" you may not use this file except in compliance with the License. @@ -54,7 +54,7 @@ The options are as follows: .RS 4 .IP "Audit only zero byte files at specified files/sec" .RE -.PD +.PD .RE diff --git a/doc/manpages/swift-object-expirer.1 b/doc/manpages/swift-object-expirer.1 new file mode 100644 index 0000000000..3ee677c050 --- /dev/null +++ b/doc/manpages/swift-object-expirer.1 @@ -0,0 +1,81 @@ +.\" +.\" Author: Joao Marcelo Martins or +.\" Copyright (c) 2012 OpenStack, LLC. +.\" +.\" Licensed under the Apache License, Version 2.0 (the "License"); +.\" you may not use this file except in compliance with the License. +.\" You may obtain a copy of the License at +.\" +.\" http://www.apache.org/licenses/LICENSE-2.0 +.\" +.\" Unless required by applicable law or agreed to in writing, software +.\" distributed under the License is distributed on an "AS IS" BASIS, +.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +.\" implied. +.\" See the License for the specific language governing permissions and +.\" limitations under the License. +.\" +.TH swift-object-expirer 1 "3/15/2012" "Linux" "OpenStack Swift" + +.SH NAME +.LP +.B swift-object-expirer +\- Openstack-swift object expirer + +.SH SYNOPSIS +.LP +.B swift-object-expirer +[CONFIG] [-h|--help] [-v|--verbose] [-o|--once] + +.SH DESCRIPTION +.PP +The swift-object-expirer offers scheduled deletion of objects. The Swift client would +use the X-Delete-At or X-Delete-After headers during an object PUT or POST and the +cluster would automatically quit serving that object at the specified time and would +shortly thereafter remove the object from the system. + +The X-Delete-At header takes a Unix Epoch timestamp, in integer form; for example: +1317070737 represents Mon Sep 26 20:58:57 2011 UTC. + +The X-Delete-After header takes a integer number of seconds. The proxy server +that receives the request will convert this header into an X-Delete-At header +using its current time plus the value given. + +The options are as follows: + +.RS 4 +.PD 0 +.IP "-v" +.IP "--verbose" +.RS 4 +.IP "log to console" +.RE +.IP "-o" +.IP "--once" +.RS 4 +.IP "only run one pass of daemon" +.RE +.PD +.RE + + +.SH DOCUMENTATION +.LP +More in depth documentation in regards to +.BI swift-object-expirer +can be foud at +.BI http://swift.openstack.org/overview_expiring_objects.html +and also about Openstack-Swift as a whole can be found at +.BI http://swift.openstack.org/index.html + +.SH FILES +.IP "\fI/usr/share/doc/swift/object-expirer.conf-sample\fR" 0 +Sample configuration file for swift-object-expirer service + +.IP "\fI/etc/init.d/swift-object-expirer\fR" 0 +Object expirer init.d script + + +.SH "SEE ALSO" +.BR object-expirer.conf(5) + diff --git a/doc/manpages/swift-object-replicator.1 b/doc/manpages/swift-object-replicator.1 index 12e1a33ab1..e80f59a050 100644 --- a/doc/manpages/swift-object-replicator.1 +++ b/doc/manpages/swift-object-replicator.1 @@ -1,6 +1,6 @@ .\" .\" Author: Joao Marcelo Martins or -.\" Copyright (c) 2010-2011 OpenStack, LLC. +.\" Copyright (c) 2010-2012 OpenStack, LLC. .\" .\" Licensed under the Apache License, Version 2.0 (the "License"); .\" you may not use this file except in compliance with the License. @@ -55,7 +55,7 @@ The options are as follows: .RS 4 .IP "only run one pass of daemon" .RE -.PD +.PD .RE diff --git a/doc/manpages/swift-object-updater.1 b/doc/manpages/swift-object-updater.1 index d361a761a9..1992043aa6 100644 --- a/doc/manpages/swift-object-updater.1 +++ b/doc/manpages/swift-object-updater.1 @@ -1,6 +1,6 @@ .\" .\" Author: Joao Marcelo Martins or -.\" Copyright (c) 2010-2011 OpenStack, LLC. +.\" Copyright (c) 2010-2012 OpenStack, LLC. .\" .\" Licensed under the Apache License, Version 2.0 (the "License"); .\" you may not use this file except in compliance with the License. @@ -62,7 +62,7 @@ The options are as follows: .RS 4 .IP "only run one pass of daemon" .RE -.PD +.PD .RE diff --git a/doc/manpages/swift-orphans.1 b/doc/manpages/swift-orphans.1 new file mode 100644 index 0000000000..b4b6158bdc --- /dev/null +++ b/doc/manpages/swift-orphans.1 @@ -0,0 +1,69 @@ +.\" +.\" Author: Joao Marcelo Martins or +.\" Copyright (c) 2012 OpenStack, LLC. +.\" +.\" Licensed under the Apache License, Version 2.0 (the "License"); +.\" you may not use this file except in compliance with the License. +.\" You may obtain a copy of the License at +.\" +.\" http://www.apache.org/licenses/LICENSE-2.0 +.\" +.\" Unless required by applicable law or agreed to in writing, software +.\" distributed under the License is distributed on an "AS IS" BASIS, +.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +.\" implied. +.\" See the License for the specific language governing permissions and +.\" limitations under the License. +.\" +.TH swift-orphans 1 "3/15/2012" "Linux" "OpenStack Swift" + +.SH NAME +.LP +.B swift-orphans +\- Openstack-swift orphans tool + +.SH SYNOPSIS +.LP +.B swift-orphans +[-h|--help] [-a|--age] [-k|--kill] [-w|--wide] + + +.SH DESCRIPTION +.PP +Lists and optionally kills orphaned Swift processes. This is done by scanning +/var/run/swift for .pid files and listing any processes that look like Swift +processes but aren't associated with the pids in those .pid files. Any Swift +processes running with the 'once' parameter are ignored, as those are usually +for full-speed audit scans and such. + +Example (sends SIGTERM to all orphaned Swift processes older than two hours): +swift-orphans -a 2 -k TERM + +The options are as follows: + +.RS 4 +.PD 0 +.IP "-a HOURS" +.IP "--age=HOURS" +.RS 4 +.IP "Look for processes at least HOURS old; default: 24" +.RE +.IP "-k SIGNAL" +.IP "--kill=SIGNAL" +.RS 4 +.IP "Send SIGNAL to matched processes; default: just list process information" +.RE +.IP "-w" +.IP "--wide" +.RS 4 +.IP "Don't clip the listing at 80 characters" +.RE +.PD +.RE + + +.SH DOCUMENTATION +.LP +More documentation about Openstack-Swift can be found at +.BI http://swift.openstack.org/index.html +