e474dfb720
- Add two optional flags that let you limit swift-dispersion-report to only reporting on containers OR objects. - Also make dispersion.conf and swift-dispersion-report manpages current. DocImpact Change-Id: Iad56133cad261241db27d0e2103098e3c2f3c245
93 lines
2.5 KiB
Groff
93 lines
2.5 KiB
Groff
.\"
|
|
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
|
|
.\" 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.
|
|
.\" 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 dispersion.conf 5 "8/26/2011" "Linux" "OpenStack Swift"
|
|
|
|
.SH NAME
|
|
.LP
|
|
.B dispersion.conf
|
|
\- configuration file for the openstack-swift dispersion tools
|
|
|
|
.SH SYNOPSIS
|
|
.LP
|
|
.B dispersion.conf
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
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.
|
|
Any line that begins with a '#' symbol is ignored.
|
|
|
|
|
|
.SH PARAMETERS
|
|
.PD 1
|
|
.RS 0
|
|
.IP "\fBauth_url\fR"
|
|
Authentication system URL
|
|
.IP "\fBauth_user\fR"
|
|
Authentication system account/user name
|
|
.IP "\fBauth_key\fR"
|
|
Authentication system account/user password
|
|
.IP "\fBswift_dir\fR"
|
|
Location of openstack-swift configuration and ring files
|
|
.IP "\fBdispersion_coverage\fR"
|
|
Percentage of partition coverage to use. The default is 1.
|
|
.IP "\fBretries\fR"
|
|
Maximum number of attempts
|
|
.IP "\fBconcurrency\fR"
|
|
Concurrency to use. The default is 25.
|
|
.IP "\fBdump_json\fR"
|
|
Whether to output in json format. The default is no.
|
|
.IP "\fBcontainer_report\fR"
|
|
Whether to run the container report. The default is yes.
|
|
.IP "\fBobject_report\fR"
|
|
Whether to run the object report. The default is yes.
|
|
.RE
|
|
.PD
|
|
|
|
.SH SAMPLE
|
|
.PD 0
|
|
.RS 0
|
|
.IP "[dispersion]"
|
|
.IP "auth_url = https://127.0.0.1:443/auth/v1.0"
|
|
.IP "auth_user = dpstats:dpstats"
|
|
.IP "auth_key = dpstats"
|
|
.IP "swift_dir = /etc/swift"
|
|
.IP "# dispersion_coverage = 1"
|
|
.IP "# retries = 5"
|
|
.IP "# concurrency = 25"
|
|
.IP "# dump_json = no"
|
|
.IP "# container_report = yes"
|
|
.IP "# object_report = yes"
|
|
.RE
|
|
.PD
|
|
|
|
|
|
.SH DOCUMENTATION
|
|
.LP
|
|
More in depth documentation about the swift-dispersion utilities and
|
|
also Openstack-Swift as a whole can be found at
|
|
.BI http://swift.openstack.org/admin_guide.html#cluster-health
|
|
and
|
|
.BI http://swift.openstack.org
|
|
|
|
|
|
.SH "SEE ALSO"
|
|
.BR swift-dispersion-report(1),
|
|
.BR swift-dispersion-populate(1)
|
|
|