openstack/swift
Code Issues Proposed changes

Merge "NIT: fixing inconsistent naming of OpenStack Swift"

Browse Source
This commit is contained in:
Jenkins 2016-08-09 18:16:13 +00:00 committed by Gerrit Code Review
commit a5a46854d5
31 changed files with 346 additions and 346 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/manpages/account-server.conf.5
View File

@ -20,7 +20,7 @@
.SH NAME .SH NAME
.LP .LP
.B account-server.conf .B account-server.conf
\- configuration file for the openstack-swift account server \- configuration file for the OpenStack Swift account server
@ -348,7 +348,7 @@ requested by delay_reaping.
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation about the swift-account-server and More in depth documentation about the swift-account-server and
also Openstack-Swift as a whole can be found at also OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/admin_guide.html .BI http://swift.openstack.org/admin_guide.html
and and
.BI http://swift.openstack.org .BI http://swift.openstack.org

4
doc/manpages/container-server.conf.5
View File

@ -20,7 +20,7 @@
.SH NAME .SH NAME
.LP .LP
.B container-server.conf .B container-server.conf
\- configuration file for the openstack-swift container server \- configuration file for the OpenStack Swift container server
@ -381,7 +381,7 @@ Internal client config file path.
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation about the swift-container-server and More in depth documentation about the swift-container-server and
also Openstack-Swift as a whole can be found at also OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/admin_guide.html .BI http://swift.openstack.org/admin_guide.html
and and
.BI http://swift.openstack.org .BI http://swift.openstack.org

30
doc/manpages/dispersion.conf.5
View File

@ -14,33 +14,33 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH dispersion.conf 5 "8/26/2011" "Linux" "OpenStack Swift" .TH dispersion.conf 5 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B dispersion.conf .B dispersion.conf
\- configuration file for the openstack-swift dispersion tools \- configuration file for the OpenStack Swift dispersion tools
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B dispersion.conf .B dispersion.conf
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
This is the configuration file used by the dispersion populate and report tools. This is the configuration file used by the dispersion populate and report tools.
The file format consists of the '[dispersion]' module as the header and available parameters. The file format consists of the '[dispersion]' module as the header and available parameters.
Any line that begins with a '#' symbol is ignored. Any line that begins with a '#' symbol is ignored.
.SH PARAMETERS .SH PARAMETERS
.PD 1 .PD 1
.RS 0 .RS 0
.IP "\fBauth_version\fR" .IP "\fBauth_version\fR"
Authentication system API version. The default is 1.0. Authentication system API version. The default is 1.0.
.IP "\fBauth_url\fR" .IP "\fBauth_url\fR"
Authentication system URL Authentication system URL
.IP "\fBauth_user\fR" .IP "\fBauth_user\fR"
Authentication system account/user name Authentication system account/user name
.IP "\fBauth_key\fR" .IP "\fBauth_key\fR"
Authentication system account/user password Authentication system account/user password
@ -55,7 +55,7 @@ The default is 'publicURL'.
.IP "\fBkeystone_api_insecure\fR" .IP "\fBkeystone_api_insecure\fR"
The default is false. The default is false.
.IP "\fBswift_dir\fR" .IP "\fBswift_dir\fR"
Location of openstack-swift configuration and ring files Location of OpenStack Swift configuration and ring files
.IP "\fBdispersion_coverage\fR" .IP "\fBdispersion_coverage\fR"
Percentage of partition coverage to use. The default is 1.0. Percentage of partition coverage to use. The default is 1.0.
.IP "\fBretries\fR" .IP "\fBretries\fR"
@ -76,7 +76,7 @@ Whether to run the object report. The default is yes.
.PD .PD
.SH SAMPLE .SH SAMPLE
.PD 0 .PD 0
.RS 0 .RS 0
.IP "[dispersion]" .IP "[dispersion]"
.IP "auth_url = https://127.0.0.1:443/auth/v1.0" .IP "auth_url = https://127.0.0.1:443/auth/v1.0"
@ -94,15 +94,15 @@ Whether to run the object report. The default is yes.
.IP "# container_report = yes" .IP "# container_report = yes"
.IP "# object_report = yes" .IP "# object_report = yes"
.RE .RE
.PD .PD
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation about the swift-dispersion utilities and More in depth documentation about the swift-dispersion utilities and
also Openstack-Swift as a whole can be found at also OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/admin_guide.html#cluster-health .BI http://swift.openstack.org/admin_guide.html#cluster-health
and and
.BI http://swift.openstack.org .BI http://swift.openstack.org

64
doc/manpages/object-expirer.conf.5
View File

@ -14,13 +14,13 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH object-expirer.conf 5 "03/15/2012" "Linux" "OpenStack Swift" .TH object-expirer.conf 5 "03/15/2012" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B object-expirer.conf .B object-expirer.conf
\- configuration file for the openstack-swift object exprier daemon \- configuration file for the OpenStack Swift object expirer daemon
@ -30,38 +30,38 @@
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
This is the configuration file used by the object expirer daemon. The daemon's 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 function is to query the internal hidden expiring_objects_account to discover
objects that need to be deleted and to then delete them. objects that need to be deleted and to then delete them.
The configuration file follows the python-pastedeploy syntax. The file is divided 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 into sections, which are enclosed by square brackets. Each section will contain a
certain number of key/value parameters which are described later. certain number of key/value parameters which are described later.
Any line that begins with a '#' symbol is ignored. Any line that begins with a '#' symbol is ignored.
You can find more information about python-pastedeploy configuration format at You can find more information about python-pastedeploy configuration format at
\fIhttp://pythonpaste.org/deploy/#config-format\fR \fIhttp://pythonpaste.org/deploy/#config-format\fR
.SH GLOBAL SECTION .SH GLOBAL SECTION
.PD 1 .PD 1
.RS 0 .RS 0
This is indicated by section named [DEFAULT]. Below are the parameters that This is indicated by section named [DEFAULT]. Below are the parameters that
are acceptable within this section. are acceptable within this section.
.IP \fBswift_dir\fR .IP \fBswift_dir\fR
Swift configuration directory. The default is /etc/swift. Swift configuration directory. The default is /etc/swift.
.IP \fBuser\fR .IP \fBuser\fR
The system user that the object server will run as. The default is swift. The system user that the object server will run as. The default is swift.
.IP \fBlog_name\fR .IP \fBlog_name\fR
Label used when logging. The default is swift. Label used when logging. The default is swift.
.IP \fBlog_facility\fR .IP \fBlog_facility\fR
Syslog log facility. The default is LOG_LOCAL0. Syslog log facility. The default is LOG_LOCAL0.
.IP \fBlog_level\fR .IP \fBlog_level\fR
Logging level. The default is INFO. Logging level. The default is INFO.
.IP \fBlog_address\fR .IP \fBlog_address\fR
Logging address. The default is /dev/log. Logging address. The default is /dev/log.
@ -94,13 +94,13 @@ The default is empty.
.SH PIPELINE SECTION .SH PIPELINE SECTION
.PD 1 .PD 1
.RS 0 .RS 0
This is indicated by section name [pipeline:main]. Below are the parameters that This is indicated by section name [pipeline:main]. Below are the parameters that
are acceptable within this section. are acceptable within this section.
.IP "\fBpipeline\fR" .IP "\fBpipeline\fR"
It is used when you need to apply a number of filters. It is a list of filters 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 ended by an application. The default should be \fB"catch_errors cache proxy-server"\fR
.RE .RE
.PD .PD
@ -108,24 +108,24 @@ ended by an application. The default should be \fB"catch_errors cache proxy-serv
.SH APP SECTION .SH APP SECTION
.PD 1 .PD 1
.RS 0 .RS 0
This is indicated by section name [app:object-server]. Below are the parameters This is indicated by section name [app:object-server]. Below are the parameters
that are acceptable within this section. that are acceptable within this section.
.IP "\fBuse\fR" .IP "\fBuse\fR"
Entry point for paste.deploy for the object server. This is the reference to the installed python egg. 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. The default is \fBegg:swift#proxy\fR. See proxy-server.conf-sample for options or See proxy-server.conf manpage.
.RE .RE
.PD .PD
.SH FILTER SECTION .SH FILTER SECTION
.PD 1 .PD 1
.RS 0 .RS 0
Any section that has its name prefixed by "filter:" indicates a filter section. Any section that has its name prefixed by "filter:" indicates a filter section.
Filters are used to specify configuration parameters for specific swift middlewares. Filters are used to specify configuration parameters for specific swift middlewares.
Below are the filters available and respective acceptable parameters. Below are the filters available and respective acceptable parameters.
.RS 0 .RS 0
.IP "\fB[filter:cache]\fR" .IP "\fB[filter:cache]\fR"
@ -140,8 +140,8 @@ The default is \fBegg:swift#memcache\fR. See proxy-server.conf-sample for option
.RE .RE
.RS 0 .RS 0
.IP "\fB[filter:catch_errors]\fR" .IP "\fB[filter:catch_errors]\fR"
.RE .RE
.RS 3 .RS 3
.IP \fBuse\fR .IP \fBuse\fR
@ -206,9 +206,9 @@ Path to recon cache directory. The default is /var/cache/swift.
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation about the swift-object-expirer and More in depth documentation about the swift-object-expirer and
also Openstack-Swift as a whole can be found at also OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/admin_guide.html .BI http://swift.openstack.org/admin_guide.html
and and
.BI http://swift.openstack.org .BI http://swift.openstack.org

4
doc/manpages/object-server.conf.5
View File

@ -20,7 +20,7 @@
.SH NAME .SH NAME
.LP .LP
.B object-server.conf .B object-server.conf
\- configuration file for the openstack-swift object server \- configuration file for the OpenStack Swift object server
@ -511,7 +511,7 @@ will try to use object-replicator's rsync_timeout + 900 or fall-back to 86400 (1
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation about the swift-object-server and More in depth documentation about the swift-object-server and
also Openstack-Swift as a whole can be found at also OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/admin_guide.html .BI http://swift.openstack.org/admin_guide.html
and and
.BI http://swift.openstack.org .BI http://swift.openstack.org

4
doc/manpages/proxy-server.conf.5
View File

@ -20,7 +20,7 @@
.SH NAME .SH NAME
.LP .LP
.B proxy-server.conf .B proxy-server.conf
\- configuration file for the openstack-swift proxy server \- configuration file for the OpenStack Swift proxy server
@ -1036,7 +1036,7 @@ The default is 'x-container-read, x-container-write, x-container-sync-key, x-con
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation about the swift-proxy-server and More in depth documentation about the swift-proxy-server and
also Openstack-Swift as a whole can be found at also OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/admin_guide.html .BI http://swift.openstack.org/admin_guide.html
and and
.BI http://swift.openstack.org .BI http://swift.openstack.org

26
doc/manpages/swift-account-auditor.1
View File

@ -14,24 +14,24 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-account-auditor 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-account-auditor 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-account-auditor .B swift-account-auditor
\- Openstack-swift account auditor \- OpenStack Swift account auditor
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-account-auditor .B swift-account-auditor
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once] [CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
The account auditor crawls the local account system checking the integrity of accounts The account auditor crawls the local account system checking the integrity of accounts
objects. If corruption is found (in the case of bit rot, for example), the file is objects. If corruption is found (in the case of bit rot, for example), the file is
quarantined, and replication will replace the bad file from another replica. quarantined, and replication will replace the bad file from another replica.
The options are as follows: The options are as follows:
@ -46,16 +46,16 @@ The options are as follows:
.IP "-o" .IP "-o"
.IP "--once" .IP "--once"
.RS 4 .RS 4
.IP "only run one pass of daemon" .IP "only run one pass of daemon"
.RE .RE
.PD .PD
.RE .RE
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation in regards to More in depth documentation in regards to
.BI swift-account-auditor .BI swift-account-auditor
and also about Openstack-Swift as a whole can be found at and also about OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html
.SH "SEE ALSO" .SH "SEE ALSO"

28
doc/manpages/swift-account-info.1
View File

@ -1,5 +1,5 @@
.\" .\"
.\" Author: Madhuri Kumari<madhuri.rai07@gmail.com> .\" Author: Madhuri Kumari<madhuri.rai07@gmail.com>
.\" .\"
.\" Licensed under the Apache License, Version 2.0 (the "License"); .\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License. .\" you may not use this file except in compliance with the License.
@ -13,28 +13,28 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-account-info 1 "3/22/2014" "Linux" "OpenStack Swift" .TH swift-account-info 1 "3/22/2014" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-account-info .B swift-account-info
\- Openstack-swift account-info tool \- OpenStack Swift account-info tool
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-account-info .B swift-account-info
[ACCOUNT_DB_FILE] [SWIFT_DIR] [ACCOUNT_DB_FILE] [SWIFT_DIR]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
This is a very simple swift tool that allows a swiftop engineer to retrieve This is a very simple swift tool that allows a swiftop engineer to retrieve
information about an account that is located on the storage node. One calls information about an account that is located on the storage node. One calls
the tool with a given db file as it is stored on the storage node system. the tool with a given db file as it is stored on the storage node system.
It will then return several information about that account such as; It will then return several information about that account such as;
.PD 0 .PD 0
.IP "- Account" .IP "- Account"
.IP "- Account hash " .IP "- Account hash "
.IP "- Created timestamp " .IP "- Created timestamp "
.IP "- Put timestamp " .IP "- Put timestamp "
@ -46,11 +46,11 @@ It will then return several information about that account such as;
.IP "- ID" .IP "- ID"
.IP "- User Metadata " .IP "- User Metadata "
.IP "- Ring Location" .IP "- Ring Location"
.PD .PD
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More documentation about Openstack-Swift can be found at More documentation about OpenStack Swift can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html
.SH "SEE ALSO" .SH "SEE ALSO"

22
doc/manpages/swift-account-reaper.1
View File

@ -14,24 +14,24 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-account-reaper 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-account-reaper 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-account-reaper .B swift-account-reaper
\- Openstack-swift account reaper \- OpenStack Swift account reaper
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-account-reaper .B swift-account-reaper
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once] [CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
Removes data from status=DELETED accounts. These are accounts that have Removes data from status=DELETED accounts. These are accounts that have
been asked to be removed by the reseller via services remove_storage_account been asked to be removed by the reseller via services remove_storage_account
XMLRPC call. XMLRPC call.
.PP .PP
The account is not deleted immediately by the services call, but instead 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 is simply marked for deletion by setting the status column in
@ -51,17 +51,17 @@ The options are as follows:
.IP "-o" .IP "-o"
.IP "--once" .IP "--once"
.RS 4 .RS 4
.IP "only run one pass of daemon" .IP "only run one pass of daemon"
.RE .RE
.PD .PD
.RE .RE
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation in regards to More in depth documentation in regards to
.BI swift-object-auditor .BI swift-object-auditor
and also about Openstack-Swift as a whole can be found at and also about OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html

38
doc/manpages/swift-account-replicator.1
View File

@ -14,31 +14,31 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-account-replicator 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-account-replicator 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-account-replicator .B swift-account-replicator
\- Openstack-swift account replicator \- OpenStack Swift account replicator
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-account-replicator .B swift-account-replicator
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once] [CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
Replication is designed to keep the system in a consistent state in the face of Replication is designed to keep the system in a consistent state in the face of
temporary error conditions like network outages or drive failures. The replication temporary error conditions like network outages or drive failures. The replication
processes compare local data with each remote copy to ensure they all contain the processes compare local data with each remote copy to ensure they all contain the
latest version. Account replication uses a combination of hashes and shared high latest version. Account replication uses a combination of hashes and shared high
water marks to quickly compare subsections of each partition. water marks to quickly compare subsections of each partition.
.PP .PP
Replication updates are push based. Account replication push missing records over Replication updates are push based. Account replication push missing records over
HTTP or rsync whole database files. The replicator also ensures that data is removed HTTP or rsync whole database files. The replicator also ensures that data is removed
from the system. When an account item is deleted a tombstone is set as the latest from the system. When an account item is deleted a tombstone is set as the latest
version of the item. The replicator will see the tombstone and ensure that the item version of the item. The replicator will see the tombstone and ensure that the item
is removed from the entire system. is removed from the entire system.
The options are as follows: The options are as follows:
@ -53,17 +53,17 @@ The options are as follows:
.IP "-o" .IP "-o"
.IP "--once" .IP "--once"
.RS 4 .RS 4
.IP "only run one pass of daemon" .IP "only run one pass of daemon"
.RE .RE
.PD .PD
.RE .RE
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation in regards to More in depth documentation in regards to
.BI swift-account-replicator .BI swift-account-replicator
and also about Openstack-Swift as a whole can be found at and also about OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html

16
doc/manpages/swift-account-server.1
View File

@ -14,32 +14,32 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-account-server 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-account-server 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-account-server .B swift-account-server
\- Openstack-swift account server \- OpenStack Swift account server
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-account-server .B swift-account-server
[CONFIG] [-h|--help] [-v|--verbose] [CONFIG] [-h|--help] [-v|--verbose]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
The Account Server's primary job is to handle listings of containers. The listings The Account Server's primary job is to handle listings of containers. The listings
are stored as sqlite database files, and replicated across the cluster similar to how are stored as sqlite database files, and replicated across the cluster similar to how
objects are. objects are.
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation in regards to More in depth documentation in regards to
.BI swift-account-server .BI swift-account-server
and also about Openstack-Swift as a whole can be found at and also about OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html
and and
.BI http://docs.openstack.org .BI http://docs.openstack.org

28
doc/manpages/swift-container-auditor.1
View File

@ -14,24 +14,24 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-container-auditor 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-container-auditor 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-container-auditor .B swift-container-auditor
\- Openstack-swift container auditor \- OpenStack Swift container auditor
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-container-auditor .B swift-container-auditor
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once] [CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
The container auditor crawls the local container system checking the integrity of container The container auditor crawls the local container system checking the integrity of container
objects. If corruption is found (in the case of bit rot, for example), the file is objects. If corruption is found (in the case of bit rot, for example), the file is
quarantined, and replication will replace the bad file from another replica. quarantined, and replication will replace the bad file from another replica.
The options are as follows: The options are as follows:
@ -46,17 +46,17 @@ The options are as follows:
.IP "-o" .IP "-o"
.IP "--once" .IP "--once"
.RS 4 .RS 4
.IP "only run one pass of daemon" .IP "only run one pass of daemon"
.RE .RE
.PD .PD
.RE .RE
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation in regards to More in depth documentation in regards to
.BI swift-container-auditor .BI swift-container-auditor
and also about Openstack-Swift as a whole can be found at and also about OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html

30
doc/manpages/swift-container-info.1
View File

@ -14,29 +14,29 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-container-info 1 "3/20/2013" "Linux" "OpenStack Swift" .TH swift-container-info 1 "3/20/2013" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-container-info .B swift-container-info
\- Openstack-swift container-info tool \- OpenStack Swift container-info tool
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-container-info .B swift-container-info
[CONTAINER_DB_FILE] [SWIFT_DIR] [CONTAINER_DB_FILE] [SWIFT_DIR]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
This is a very simple swift tool that allows a swiftop engineer to retrieve This is a very simple swift tool that allows a swiftop engineer to retrieve
information about a container that is located on the storage node. information about a container that is located on the storage node.
One calls the tool with a given container db file as One calls the tool with a given container db file as
it is stored on the storage node system. it is stored on the storage node system.
It will then return several information about that container such as; It will then return several information about that container such as;
.PD 0 .PD 0
.IP "- Account it belongs to" .IP "- Account it belongs to"
.IP "- Container " .IP "- Container "
.IP "- Created timestamp " .IP "- Created timestamp "
.IP "- Put timestamp " .IP "- Put timestamp "
@ -50,14 +50,14 @@ It will then return several information about that container such as;
.IP "- Hash " .IP "- Hash "
.IP "- ID " .IP "- ID "
.IP "- User metadata " .IP "- User metadata "
.IP "- X-Container-Sync-Point 1 " .IP "- X-Container-Sync-Point 1 "
.IP "- X-Container-Sync-Point 2 " .IP "- X-Container-Sync-Point 2 "
.IP "- Location on the ring " .IP "- Location on the ring "
.PD .PD
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More documentation about Openstack-Swift can be found at More documentation about OpenStack Swift can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html
.SH "SEE ALSO" .SH "SEE ALSO"

36
doc/manpages/swift-container-replicator.1
View File

@ -14,31 +14,31 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-container-replicator 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-container-replicator 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-container-replicator .B swift-container-replicator
\- Openstack-swift container replicator \- OpenStack Swift container replicator
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-container-replicator .B swift-container-replicator
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once] [CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
Replication is designed to keep the system in a consistent state in the face of Replication is designed to keep the system in a consistent state in the face of
temporary error conditions like network outages or drive failures. The replication temporary error conditions like network outages or drive failures. The replication
processes compare local data with each remote copy to ensure they all contain the processes compare local data with each remote copy to ensure they all contain the
latest version. Container replication uses a combination of hashes and shared high latest version. Container replication uses a combination of hashes and shared high
water marks to quickly compare subsections of each partition. water marks to quickly compare subsections of each partition.
.PP .PP
Replication updates are push based. Container replication push missing records over Replication updates are push based. Container replication push missing records over
HTTP or rsync whole database files. The replicator also ensures that data is removed HTTP or rsync whole database files. The replicator also ensures that data is removed
from the system. When an container item is deleted a tombstone is set as the latest from the system. When an container item is deleted a tombstone is set as the latest
version of the item. The replicator will see the tombstone and ensure that the item version of the item. The replicator will see the tombstone and ensure that the item
is removed from the entire system. is removed from the entire system.
The options are as follows: The options are as follows:
@ -53,17 +53,17 @@ The options are as follows:
.IP "-o" .IP "-o"
.IP "--once" .IP "--once"
.RS 4 .RS 4
.IP "only run one pass of daemon" .IP "only run one pass of daemon"
.RE .RE
.PD .PD
.RE .RE
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation in regards to More in depth documentation in regards to
.BI swift-container-replicator .BI swift-container-replicator
and also about Openstack-Swift as a whole can be found at and also about OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html

24
doc/manpages/swift-container-server.1
View File

@ -14,37 +14,37 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-container-server 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-container-server 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-container-server .B swift-container-server
\- Openstack-swift container server \- OpenStack Swift container server
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-container-server .B swift-container-server
[CONFIG] [-h|--help] [-v|--verbose] [CONFIG] [-h|--help] [-v|--verbose]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
The Container Server's primary job is to handle listings of objects. It doesn't know The Container Server's primary job is to handle listings of objects. It doesn't know
where those objects are, just what objects are in a specific container. The listings where those objects are, just what objects are in a specific container. The listings
are stored as sqlite database files, and replicated across the cluster similar to how are stored as sqlite database files, and replicated across the cluster similar to how
objects are. Statistics are also tracked that include the total number of objects, and objects are. Statistics are also tracked that include the total number of objects, and
total storage usage for that container. total storage usage for that container.
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation in regards to More in depth documentation in regards to
.BI swift-container-server .BI swift-container-server
and also about Openstack-Swift as a whole can be found at and also about OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html
and and
.BI http://docs.openstack.org .BI http://docs.openstack.org
.LP .LP
.SH "SEE ALSO" .SH "SEE ALSO"
.BR container-server.conf(5) .BR container-server.conf(5)

18
doc/manpages/swift-container-sync.1
View File

@ -14,25 +14,25 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-container-sync 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-container-sync 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-container-sync .B swift-container-sync
\- Openstack-swift container sync \- OpenStack Swift container sync
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-container-sync .B swift-container-sync
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once] [CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
Swift has a feature where all the contents of a container can be mirrored to Swift has a feature where all the contents of a container can be mirrored to
another container through background synchronization. Swift cluster operators another container through background synchronization. Swift cluster operators
configure their cluster to allow/accept sync requests to/from other clusters, configure their cluster to allow/accept sync requests to/from other clusters,
and the user specifies where to sync their container to along with a secret and the user specifies where to sync their container to along with a secret
synchronization key. synchronization key.
.PP .PP
The swift-container-sync does the job of sending updates to the remote container. The swift-container-sync does the job of sending updates to the remote container.
@ -42,14 +42,14 @@ newer rows since the last sync will trigger PUTs or DELETEs to the other contain
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation in regards to More in depth documentation in regards to
.BI swift-container-sync .BI swift-container-sync
and also about Openstack-Swift as a whole can be found at and also about OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/overview_container_sync.html .BI http://swift.openstack.org/overview_container_sync.html
and and
.BI http://docs.openstack.org .BI http://docs.openstack.org
.LP .LP
.SH "SEE ALSO" .SH "SEE ALSO"
.BR container-server.conf(5) .BR container-server.conf(5)

32
doc/manpages/swift-container-updater.1
View File

@ -14,31 +14,31 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-container-updater 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-container-updater 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-container-updater .B swift-container-updater
\- Openstack-swift container updater \- OpenStack Swift container updater
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-container-updater .B swift-container-updater
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once] [CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
The container updater is responsible for updating container information in the account database. The container updater is responsible for updating container information in the account database.
It will walk the container path in the system looking for container DBs and sending updates It will walk the container path in the system looking for container DBs and sending updates
to the account server as needed as it goes along. to the account server as needed as it goes along.
There are times when account data can not be immediately updated. This usually occurs There are times when account data can not be immediately updated. This usually occurs
during failure scenarios or periods of high load. This is where an eventual consistency during failure scenarios or periods of high load. This is where an eventual consistency
window will most likely come in to play. window will most likely come in to play.
In practice, the consistency window is only as large as the frequency at which In practice, the consistency window is only as large as the frequency at which
the updater runs and may not even be noticed as the proxy server will route the updater runs and may not even be noticed as the proxy server will route
listing requests to the first account server which responds. The server under listing requests to the first account server which responds. The server under
load may not be the one that serves subsequent listing requests – one of the other load may not be the one that serves subsequent listing requests – one of the other
two replicas may handle the listing. two replicas may handle the listing.
@ -55,16 +55,16 @@ The options are as follows:
.IP "-o" .IP "-o"
.IP "--once" .IP "--once"
.RS 4 .RS 4
.IP "only run one pass of daemon" .IP "only run one pass of daemon"
.RE .RE
.PD .PD
.RE .RE
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation in regards to More in depth documentation in regards to
.BI swift-container-updater .BI swift-container-updater
and also about Openstack-Swift as a whole can be found at and also about OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html

2
doc/manpages/swift-dispersion-populate.1
View File

@ -20,7 +20,7 @@
.SH NAME .SH NAME
.LP .LP
.B swift-dispersion-populate .B swift-dispersion-populate
\- Openstack-swift dispersion populate \- OpenStack Swift dispersion populate
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP

2
doc/manpages/swift-dispersion-report.1
View File

@ -20,7 +20,7 @@
.SH NAME .SH NAME
.LP .LP
.B swift-dispersion-report .B swift-dispersion-report
\- Openstack-swift dispersion report \- OpenStack Swift dispersion report
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP

26
doc/manpages/swift-get-nodes.1
View File

@ -14,25 +14,25 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-get-nodes 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-get-nodes 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-get-nodes .B swift-get-nodes
\- Openstack-swift get-nodes tool \- OpenStack Swift get-nodes tool
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-get-nodes .B swift-get-nodes
\ <ring.gz> <account> [<container> [<object>]] \ <ring.gz> <account> [<container> [<object>]]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
The swift-get-nodes tool can be used to find out the location where The swift-get-nodes tool can be used to find out the location where
a particular account, container or object item is located within the a particular account, container or object item is located within the
swift cluster nodes. For example, if you have the account hash and a container swift cluster nodes. For example, if you have the account hash and a container
name that belongs to that account, you can use swift-get-nodes to lookup name that belongs to that account, you can use swift-get-nodes to lookup
where the container resides by using the container ring. where the container resides by using the container ring.
.RS 0 .RS 0
@ -40,7 +40,7 @@ where the container resides by using the container ring.
.RE .RE
.RS 4 .RS 4
.PD 0 .PD 0
.IP "$ swift-get-nodes /etc/swift/account.ring.gz MyAccount-12ac01446be2" .IP "$ swift-get-nodes /etc/swift/account.ring.gz MyAccount-12ac01446be2"
.PD 0 .PD 0
@ -67,12 +67,12 @@ where the container resides by using the container ring.
.IP "ssh 172.24.24.32 ls -lah /srv/node/sde/accounts/221082/cce/d7e6ba68cfdce0f0e4ca7890e46cacce/" .IP "ssh 172.24.24.32 ls -lah /srv/node/sde/accounts/221082/cce/d7e6ba68cfdce0f0e4ca7890e46cacce/"
.IP "ssh 172.24.24.26 ls -lah /srv/node/sdv/accounts/221082/cce/d7e6ba68cfdce0f0e4ca7890e46cacce/ # [Handoff] " .IP "ssh 172.24.24.26 ls -lah /srv/node/sdv/accounts/221082/cce/d7e6ba68cfdce0f0e4ca7890e46cacce/ # [Handoff] "
.PD .PD
.RE .RE
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More documentation about Openstack-Swift can be found at More documentation about OpenStack Swift can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html

28
doc/manpages/swift-init.1
View File

@ -14,25 +14,25 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-init 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-init 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-init .B swift-init
\- Openstack-swift swift-init tool \- OpenStack Swift swift-init tool
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-init .B swift-init
<server> [<server> ...] <command> [options] <server> [<server> ...] <command> [options]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
The swift-init tool can be used to initialize all swift daemons available as part of The swift-init tool can be used to initialize all swift daemons available as part of
openstack-swift. Instead of calling individual init scripts for each OpenStack Swift. Instead of calling individual init scripts for each
swift daemon, one can just use swift-init. With swift-init you can initialize swift daemon, one can just use swift-init. With swift-init you can initialize
just one swift service, such as the "proxy", or a combination of them. The tool also just one swift service, such as the "proxy", or a combination of them. The tool also
allows one to use the keywords such as "all", "main" and "rest" for the <server> argument. allows one to use the keywords such as "all", "main" and "rest" for the <server> argument.
@ -41,7 +41,7 @@ allows one to use the keywords such as "all", "main" and "rest" for the <server>
.PD 0 .PD 0
.RS 4 .RS 4
.IP "\fIproxy\fR" "4" .IP "\fIproxy\fR" "4"
.IP " - Initializes the swift proxy daemon" .IP " - Initializes the swift proxy daemon"
.RE .RE
.RS 4 .RS 4
@ -75,7 +75,7 @@ allows one to use the keywords such as "all", "main" and "rest" for the <server>
.IP " - Initializes all the other \fBswift background daemons\fR" .IP " - Initializes all the other \fBswift background daemons\fR"
.IP " (updater, replicator, auditor, reaper, etc)" .IP " (updater, replicator, auditor, reaper, etc)"
.RE .RE
.PD .PD
\fBCommands:\fR \fBCommands:\fR
@ -92,14 +92,14 @@ allows one to use the keywords such as "all", "main" and "rest" for the <server>
.IP "\fIstart\fR: \t\t\t starts a server" .IP "\fIstart\fR: \t\t\t starts a server"
.IP "\fIstatus\fR: \t\t\t display status of tracked pids for server" .IP "\fIstatus\fR: \t\t\t display status of tracked pids for server"
.IP "\fIstop\fR: \t\t\t stops a server" .IP "\fIstop\fR: \t\t\t stops a server"
.PD .PD
.RE .RE
\fBOptions:\fR \fBOptions:\fR
.RS 4 .RS 4
.PD 0 .PD 0
.IP "-h, --help \t\t\t show this help message and exit" .IP "-h, --help \t\t\t show this help message and exit"
.IP "-v, --verbose \t\t\t display verbose output" .IP "-v, --verbose \t\t\t display verbose output"
.IP "-w, --no-wait \t\t\t won't wait for server to start before returning .IP "-w, --no-wait \t\t\t won't wait for server to start before returning
@ -112,14 +112,14 @@ allows one to use the keywords such as "all", "main" and "rest" for the <server>
.IP "--strict return non-zero status code if some config is missing. Default mode if server is explicitly named." .IP "--strict return non-zero status code if some config is missing. Default mode if server is explicitly named."
.IP "--non-strict return zero status code even if some config is missing. Default mode if server is one of aliases `all`, `main` or `rest`." .IP "--non-strict return zero status code even if some config is missing. Default mode if server is one of aliases `all`, `main` or `rest`."
.IP "--kill-after-timeout kill daemon and all children after kill-wait period." .IP "--kill-after-timeout kill daemon and all children after kill-wait period."
.PD .PD
.RE .RE
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More documentation about Openstack-Swift can be found at More documentation about OpenStack Swift can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html

28
doc/manpages/swift-object-auditor.1
View File

@ -14,23 +14,23 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-object-auditor 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-object-auditor 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-object-auditor .B swift-object-auditor
\- Openstack-swift object auditor \- OpenStack Swift object auditor
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-object-auditor .B swift-object-auditor
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once] [-z|--zero_byte_fps] [CONFIG] [-h|--help] [-v|--verbose] [-o|--once] [-z|--zero_byte_fps]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
The object auditor crawls the local object system checking the integrity of objects. The object auditor crawls the local object system checking the integrity of objects.
If corruption is found (in the case of bit rot, for example), the file is If corruption is found (in the case of bit rot, for example), the file is
quarantined, and replication will replace the bad file from another replica. quarantined, and replication will replace the bad file from another replica.
The options are as follows: The options are as follows:
@ -46,7 +46,7 @@ The options are as follows:
.IP "-o" .IP "-o"
.IP "--once" .IP "--once"
.RS 4 .RS 4
.IP "only run one pass of daemon" .IP "only run one pass of daemon"
.RE .RE
.IP "-z ZERO_BYTE_FPS" .IP "-z ZERO_BYTE_FPS"
@ -56,13 +56,13 @@ The options are as follows:
.RE .RE
.PD .PD
.RE .RE
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation in regards to More in depth documentation in regards to
.BI swift-object-auditor .BI swift-object-auditor
and also about Openstack-Swift as a whole can be found at and also about OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html

4
doc/manpages/swift-object-expirer.1
View File

@ -20,7 +20,7 @@
.SH NAME .SH NAME
.LP .LP
.B swift-object-expirer .B swift-object-expirer
\- Openstack-swift object expirer \- OpenStack Swift object expirer
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
@ -65,7 +65,7 @@ More in depth documentation in regards to
.BI swift-object-expirer .BI swift-object-expirer
can be found at can be found at
.BI http://swift.openstack.org/overview_expiring_objects.html .BI http://swift.openstack.org/overview_expiring_objects.html
and also about Openstack-Swift as a whole can be found at and also about OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html

26
doc/manpages/swift-object-info.1
View File

@ -14,28 +14,28 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-object-info 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-object-info 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-object-info .B swift-object-info
\- Openstack-swift object-info tool \- OpenStack Swift object-info tool
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-object-info .B swift-object-info
[OBJECT_FILE] [SWIFT_DIR] [OBJECT_FILE] [SWIFT_DIR]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
This is a very simple swift tool that allows a swiftop engineer to retrieve This is a very simple swift tool that allows a swiftop engineer to retrieve
information about an object that is located on the storage node. One calls information about an object that is located on the storage node. One calls
the tool with a given object file as it is stored on the storage node system. the tool with a given object file as it is stored on the storage node system.
It will then return several information about that object such as; It will then return several information about that object such as;
.PD 0 .PD 0
.IP "- Account it belongs to" .IP "- Account it belongs to"
.IP "- Container " .IP "- Container "
.IP "- Object hash " .IP "- Object hash "
.IP "- Content Type " .IP "- Content Type "
@ -44,11 +44,11 @@ It will then return several information about that object such as;
.IP "- Content Length " .IP "- Content Length "
.IP "- User Metadata " .IP "- User Metadata "
.IP "- Location on the ring " .IP "- Location on the ring "
.PD .PD
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More documentation about Openstack-Swift can be found at More documentation about OpenStack Swift can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html
.SH "SEE ALSO" .SH "SEE ALSO"

36
doc/manpages/swift-object-replicator.1
View File

@ -14,31 +14,31 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-object-replicator 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-object-replicator 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-object-replicator .B swift-object-replicator
\- Openstack-swift object replicator \- OpenStack Swift object replicator
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-object-replicator .B swift-object-replicator
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once] [CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
Replication is designed to keep the system in a consistent state in the face of Replication is designed to keep the system in a consistent state in the face of
temporary error conditions like network outages or drive failures. The replication temporary error conditions like network outages or drive failures. The replication
processes compare local data with each remote copy to ensure they all contain the processes compare local data with each remote copy to ensure they all contain the
latest version. Object replication uses a hash list to quickly compare subsections latest version. Object replication uses a hash list to quickly compare subsections
of each partition. of each partition.
.PP .PP
Replication updates are push based. For object replication, updating is just a matter Replication updates are push based. For object replication, updating is just a matter
of rsyncing files to the peer. The replicator also ensures that data is removed of rsyncing files to the peer. The replicator also ensures that data is removed
from the system. When an object item is deleted a tombstone is set as the latest from the system. When an object item is deleted a tombstone is set as the latest
version of the item. The replicator will see the tombstone and ensure that the item version of the item. The replicator will see the tombstone and ensure that the item
is removed from the entire system. is removed from the entire system.
The options are as follows: The options are as follows:
@ -53,17 +53,17 @@ The options are as follows:
.IP "-o" .IP "-o"
.IP "--once" .IP "--once"
.RS 4 .RS 4
.IP "only run one pass of daemon" .IP "only run one pass of daemon"
.RE .RE
.PD .PD
.RE .RE
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation in regards to More in depth documentation in regards to
.BI swift-object-replicator .BI swift-object-replicator
and also about Openstack-Swift as a whole can be found at and also about OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html

22
doc/manpages/swift-object-server.1
View File

@ -14,39 +14,39 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-object-server 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-object-server 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-object-server .B swift-object-server
\- Openstack-swift object server. \- OpenStack Swift object server.
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-object-server .B swift-object-server
[CONFIG] [-h|--help] [-v|--verbose] [CONFIG] [-h|--help] [-v|--verbose]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
The Object Server is a very simple blob storage server that can store, retrieve The Object Server is a very simple blob storage server that can store, retrieve
and delete objects stored on local devices. Objects are stored as binary files and delete objects stored on local devices. Objects are stored as binary files
on the filesystem with metadata stored in the file's extended attributes (xattrs). on the filesystem with metadata stored in the file's extended attributes (xattrs).
This requires that the underlying filesystem choice for object servers support This requires that the underlying filesystem choice for object servers support
xattrs on files. Some filesystems, like ext3, have xattrs turned off by default. xattrs on files. Some filesystems, like ext3, have xattrs turned off by default.
Each object is stored using a path derived from the object name's hash and the operation's Each object is stored using a path derived from the object name's hash and the operation's
timestamp. Last write always wins, and ensures that the latest object version will be timestamp. Last write always wins, and ensures that the latest object version will be
served. A deletion is also treated as a version of the file (a 0 byte file ending with served. A deletion is also treated as a version of the file (a 0 byte file ending with
".ts", which stands for tombstone). This ensures that deleted files are replicated ".ts", which stands for tombstone). This ensures that deleted files are replicated
correctly and older versions don't magically reappear due to failure scenarios. correctly and older versions don't magically reappear due to failure scenarios.
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation in regards to More in depth documentation in regards to
.BI swift-object-server .BI swift-object-server
and also about Openstack-Swift as a whole can be found at and also about OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html
and and
.BI http://docs.openstack.org .BI http://docs.openstack.org

42
doc/manpages/swift-object-updater.1
View File

@ -14,36 +14,36 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-object-updater 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-object-updater 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-object-updater .B swift-object-updater
\- Openstack-swift object updater \- OpenStack Swift object updater
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-object-updater .B swift-object-updater
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once] [CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
The object updater is responsible for updating object information in container listings. The object updater is responsible for updating object information in container listings.
It will check to see if there are any locally queued updates on the filesystem of each It will check to see if there are any locally queued updates on the filesystem of each
devices, what is also known as async pending file(s), walk each one and update the devices, what is also known as async pending file(s), walk each one and update the
container listing. container listing.
For example, suppose a container server is under load and a new object is put For example, suppose a container server is under load and a new object is put
into the system. The object will be immediately available for reads as soon as into the system. The object will be immediately available for reads as soon as
the proxy server responds to the client with success. However, the object the proxy server responds to the client with success. However, the object
server has not been able to update the object listing in the container server. server has not been able to update the object listing in the container server.
Therefore, the update would be queued locally for a later update. Container listings, Therefore, the update would be queued locally for a later update. Container listings,
therefore, may not immediately contain the object. This is where an eventual consistency therefore, may not immediately contain the object. This is where an eventual consistency
window will most likely come in to play. window will most likely come in to play.
In practice, the consistency window is only as large as the frequency at which In practice, the consistency window is only as large as the frequency at which
the updater runs and may not even be noticed as the proxy server will route the updater runs and may not even be noticed as the proxy server will route
listing requests to the first container server which responds. The server under listing requests to the first container server which responds. The server under
load may not be the one that serves subsequent listing requests – one of the other load may not be the one that serves subsequent listing requests – one of the other
two replicas may handle the listing. two replicas may handle the listing.
@ -60,17 +60,17 @@ The options are as follows:
.IP "-o" .IP "-o"
.IP "--once" .IP "--once"
.RS 4 .RS 4
.IP "only run one pass of daemon" .IP "only run one pass of daemon"
.RE .RE
.PD .PD
.RE .RE
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation in regards to More in depth documentation in regards to
.BI swift-object-updater .BI swift-object-updater
and also about Openstack-Swift as a whole can be found at and also about OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html

4
doc/manpages/swift-orphans.1
View File

@ -20,7 +20,7 @@
.SH NAME .SH NAME
.LP .LP
.B swift-orphans .B swift-orphans
\- Openstack-swift orphans tool \- OpenStack Swift orphans tool
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
@ -65,6 +65,6 @@ The options are as follows:
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More documentation about Openstack-Swift can be found at More documentation about OpenStack Swift can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html

24
doc/manpages/swift-proxy-server.1
View File

@ -14,35 +14,35 @@
.\" implied. .\" implied.
.\" See the License for the specific language governing permissions and .\" See the License for the specific language governing permissions and
.\" limitations under the License. .\" limitations under the License.
.\" .\"
.TH swift-proxy-server 1 "8/26/2011" "Linux" "OpenStack Swift" .TH swift-proxy-server 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME .SH NAME
.LP .LP
.B swift-proxy-server .B swift-proxy-server
\- Openstack-swift proxy server. \- OpenStack Swift proxy server.
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
.B swift-proxy-server .B swift-proxy-server
[CONFIG] [-h|--help] [-v|--verbose] [CONFIG] [-h|--help] [-v|--verbose]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
The Swift Proxy Server is responsible for tying together the rest of the Swift architecture. The Swift Proxy Server is responsible for tying together the rest of the Swift architecture.
For each request, it will look up the location of the account, container, or object in the For each request, it will look up the location of the account, container, or object in the
ring and route the request accordingly. The public API is also exposed through the Proxy ring and route the request accordingly. The public API is also exposed through the Proxy
Server. A large number of failures are also handled in the Proxy Server. For example, Server. A large number of failures are also handled in the Proxy Server. For example,
if a server is unavailable for an object PUT, it will ask the ring for a handoff server if a server is unavailable for an object PUT, it will ask the ring for a handoff server
and route there instead. When objects are streamed to or from an object server, they are and route there instead. When objects are streamed to or from an object server, they are
streamed directly through the proxy server to or from the user the proxy server does streamed directly through the proxy server to or from the user the proxy server does
not spool them. not spool them.
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation in regards to More in depth documentation in regards to
.BI swift-proxy-server .BI swift-proxy-server
and also about Openstack-Swift as a whole can be found at and also about OpenStack Swift as a whole can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html

4
doc/manpages/swift-recon.1
View File

@ -20,7 +20,7 @@
.SH NAME .SH NAME
.LP .LP
.B swift-recon .B swift-recon
\- Openstack-swift recon middleware cli tool \- OpenStack Swift recon middleware cli tool
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
@ -124,7 +124,7 @@ cronjob to run the swift-recon-cron script periodically:
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More documentation about Openstack-Swift can be found at More documentation about OpenStack Swift can be found at
.BI http://swift.openstack.org/index.html .BI http://swift.openstack.org/index.html
Also more specific documentation about swift-recon can be found at Also more specific documentation about swift-recon can be found at
.BI http://swift.openstack.org/admin_guide.html#cluster-telemetry-and-monitoring .BI http://swift.openstack.org/admin_guide.html#cluster-telemetry-and-monitoring

36
doc/manpages/swift-ring-builder.1
View File

@ -20,7 +20,7 @@
.SH NAME .SH NAME
.LP .LP
.B swift-ring-builder .B swift-ring-builder
\- Openstack-swift ring builder \- OpenStack Swift ring builder
.SH SYNOPSIS .SH SYNOPSIS
.LP .LP
@ -124,15 +124,15 @@ Shows information about matching devices.
.IP "\fBadd\fR r<region>z<zone>-<ip>:<port>/<device_name>_<meta> <weight>" .IP "\fBadd\fR r<region>z<zone>-<ip>:<port>/<device_name>_<meta> <weight>"
.IP "\fBadd\fR -r <region> -z <zone> -i <ip> -p <port> -d <device_name> -m <meta> -w <weight>" .IP "\fBadd\fR -r <region> -z <zone> -i <ip> -p <port> -d <device_name> -m <meta> -w <weight>"
.RS 5 .RS 5
Adds a device to the ring with the given information. No partitions will be Adds a device to the ring with the given information. No partitions will be
assigned to the new device until after running 'rebalance'. This is so you assigned to the new device until after running 'rebalance'. This is so you
can make multiple device changes and rebalance them all just once. can make multiple device changes and rebalance them all just once.
.RE .RE
.IP "\fBcreate\fR <part_power> <replicas> <min_part_hours>" .IP "\fBcreate\fR <part_power> <replicas> <min_part_hours>"
.RS 5 .RS 5
Creates <builder_file> with 2^<part_power> partitions and <replicas>. Creates <builder_file> with 2^<part_power> partitions and <replicas>.
<min_part_hours> is number of hours to restrict moving a partition more than once. <min_part_hours> is number of hours to restrict moving a partition more than once.
.RE .RE
@ -156,37 +156,37 @@ Attempts to rebalance the ring by reassigning partitions that haven't been recen
.IP "\fBremove\fR <search-value> " .IP "\fBremove\fR <search-value> "
.RS 5 .RS 5
Removes the device(s) from the ring. This should normally just be used for Removes the device(s) from the ring. This should normally just be used for
a device that has failed. For a device you wish to decommission, it's best a device that has failed. For a device you wish to decommission, it's best
to set its weight to 0, wait for it to drain all its data, then use this to set its weight to 0, wait for it to drain all its data, then use this
remove command. This will not take effect until after running 'rebalance'. remove command. This will not take effect until after running 'rebalance'.
This is so you can make multiple device changes and rebalance them all just once. This is so you can make multiple device changes and rebalance them all just once.
.RE .RE
.IP "\fBset_info\fR <search-value> <ip>:<port>/<device_name>_<meta>" .IP "\fBset_info\fR <search-value> <ip>:<port>/<device_name>_<meta>"
.RS 5 .RS 5
Resets the device's information. This information isn't used to assign Resets the device's information. This information isn't used to assign
partitions, so you can use 'write_ring' afterward to rewrite the current partitions, so you can use 'write_ring' afterward to rewrite the current
ring with the newer device information. Any of the parts are optional ring with the newer device information. Any of the parts are optional
in the final <ip>:<port>/<device_name>_<meta> parameter; just give what you in the final <ip>:<port>/<device_name>_<meta> parameter; just give what you
want to change. For instance set_info d74 _"snet: 5.6.7.8" would just want to change. For instance set_info d74 _"snet: 5.6.7.8" would just
update the meta data for device id 74. update the meta data for device id 74.
.RE .RE
.IP "\fBset_min_part_hours\fR <hours>" .IP "\fBset_min_part_hours\fR <hours>"
.RS 5 .RS 5
Changes the <min_part_hours> to the given <hours>. This should be set to Changes the <min_part_hours> to the given <hours>. This should be set to
however long a full replication/update cycle takes. We're working on a way however long a full replication/update cycle takes. We're working on a way
to determine this more easily than scanning logs. to determine this more easily than scanning logs.
.RE .RE
.IP "\fBset_weight\fR <search-value> <weight>" .IP "\fBset_weight\fR <search-value> <weight>"
.RS 5 .RS 5
Resets the device's weight. No partitions will be reassigned to or from the Resets the device's weight. No partitions will be reassigned to or from the
device until after running 'rebalance'. This is so you can make multiple device until after running 'rebalance'. This is so you can make multiple
device changes and rebalance them all just once. device changes and rebalance them all just once.
.RE .RE
@ -216,7 +216,7 @@ calls when no rebalance is needed but you want to send out the new device inform
.SH DOCUMENTATION .SH DOCUMENTATION
.LP .LP
More in depth documentation about the swift ring and also Openstack-Swift as a More in depth documentation about the swift ring and also OpenStack Swift as a
whole can be found at whole can be found at
.BI http://swift.openstack.org/overview_ring.html, .BI http://swift.openstack.org/overview_ring.html,
.BI http://swift.openstack.org/admin_guide.html#managing-the-rings .BI http://swift.openstack.org/admin_guide.html#managing-the-rings