openstack/swift
Code Issues Proposed changes

update swift-dispersion manpages to add policy-name

Browse Source 
This change adds -P / --policy-name option to the swift-dispersion
manpages. Also tidied up a little removing some extra whitespace at the
end of lines.

Change-Id: Ic3372379994964e96258939580452f94fb575a06
Closes-Bug: #1605686
This commit is contained in:
Shashirekha Gundur
2016-08-01 22:13:58 +00:00
committed by Matthew Oliver
parent 4521eb6e2e
commit d819ae00a5
2 changed files with 47 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -14,26 +14,26 @@
.\" implied.
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
.\"
.\"
.TH swift-dispersion-populate 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME
.SH NAME
.LP
.B swift-dispersion-populate
\- Openstack-swift dispersion populate
\- Openstack-swift dispersion populate
.SH SYNOPSIS
.LP
.B swift-dispersion-populate [--container-suffix-start] [--object-suffix-start] [--container-only|--object-only] [--insecure] [conf_file]
.SH DESCRIPTION
.SH DESCRIPTION
.PP
This is one of the swift-dispersion utilities that is used to evaluate the
overall cluster health. This is accomplished by checking if a set of
overall cluster health. This is accomplished by checking if a set of
deliberately distributed containers and objects are currently in their
proper places within the cluster.
.PP
.PP
For instance, a common deployment has three replicas of each object.
The health of that object can be measured by checking if each replica
is in its proper place. If only 2 of the 3 is in place the object's health
@@ -48,13 +48,13 @@ we need to run the \fBswift-dispersion-report\fR tool to check the health of eac
of these containers and objects.
.PP
These tools need direct access to the entire cluster and to the ring files.
Installing them on a proxy server will probably do or a box used for swift
administration purposes that also contains the common swift packages and ring.
Both \fBswift-dispersion-populate\fR and \fBswift-dispersion-report\fR use the
These tools need direct access to the entire cluster and to the ring files.
Installing them on a proxy server will probably do or a box used for swift
administration purposes that also contains the common swift packages and ring.
Both \fBswift-dispersion-populate\fR and \fBswift-dispersion-report\fR use the
same configuration file, /etc/swift/dispersion.conf . The account used by these
tool should be a dedicated account for the dispersion stats and also have admin
privileges.
privileges.
.SH OPTIONS
.RS 0
@@ -70,14 +70,14 @@ Start object suffix at NUMBER and resume population at this point; default: 0
Only run object population
.IP "\fB--container-only\fR"
Only run container population
.IP "\fB--object-only\fR"
Only run object population
.IP "\fB--no-overlap\fR"
Increase coverage by amount in dispersion_coverage option with no overlap of existing partitions (if run more than once)
.IP "\fB-P, --policy-name\fR"
Specify storage policy name
.SH CONFIGURATION
.PD 0
Example \fI/etc/swift/dispersion.conf\fR:
.PD 0
Example \fI/etc/swift/dispersion.conf\fR:
.RS 3
.IP "[dispersion]"
@@ -93,10 +93,10 @@ Example \fI/etc/swift/dispersion.conf\fR:
.IP "# concurrency = 25"
.IP "# endpoint_type = publicURL"
.RE
.PD
.PD
.SH EXAMPLE
.PP
.PP
.PD 0
$ swift-dispersion-populate
.RS 1
@@ -105,14 +105,14 @@ $ swift-dispersion-populate
.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
also Openstack-Swift as a whole can be found at
.BI http://swift.openstack.org/admin_guide.html#cluster-health
and
and
.BI http://swift.openstack.org

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

@@ -14,45 +14,45 @@
.\" implied.
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
.\"
.\"
.TH swift-dispersion-report 1 "8/26/2011" "Linux" "OpenStack Swift"
.SH NAME
.SH NAME
.LP
.B swift-dispersion-report
\- Openstack-swift dispersion report
\- Openstack-swift dispersion report
.SH SYNOPSIS
.LP
.B swift-dispersion-report [-d|--debug] [-j|--dump-json] [-p|--partitions] [--container-only|--object-only] [--insecure] [conf_file]
.SH DESCRIPTION
.SH DESCRIPTION
.PP
This is one of the swift-dispersion utilities that is used to evaluate the
overall cluster health. This is accomplished by checking if a set of
overall cluster health. This is accomplished by checking if a set of
deliberately distributed containers and objects are currently in their
proper places within the cluster.
.PP
.PP
For instance, a common deployment has three replicas of each object.
The health of that object can be measured by checking if each replica
is in its proper place. If only 2 of the 3 is in place the object's health
can be said to be at 66.66%, where 100% would be perfect.
.PP
Once the \fBswift-dispersion-populate\fR has been used to populate the
dispersion account, one should run the \fBswift-dispersion-report\fR tool
Once the \fBswift-dispersion-populate\fR has been used to populate the
dispersion account, one should run the \fBswift-dispersion-report\fR tool
repeatedly for the life of the cluster, in order to check the health of each
of these containers and objects.
.PP
These tools need direct access to the entire cluster and to the ring files.
Installing them on a proxy server will probably do or a box used for swift
administration purposes that also contains the common swift packages and ring.
Both \fBswift-dispersion-populate\fR and \fBswift-dispersion-report\fR use the
These tools need direct access to the entire cluster and to the ring files.
Installing them on a proxy server will probably do or a box used for swift
administration purposes that also contains the common swift packages and ring.
Both \fBswift-dispersion-populate\fR and \fBswift-dispersion-report\fR use the
same configuration file, /etc/swift/dispersion.conf . The account used by these
tool should be a dedicated account for the dispersion stats and also have admin
privileges.
privileges.
.SH OPTIONS
.RS 0
@@ -91,9 +91,15 @@ Only run the object report
Allow accessing insecure keystone server. The keystone's certificate will not
be verified.
.SH OPTIONS
.RS 0
.PD 1
.IP "\fB-P, --policy-name\fR"
Specify storage policy name
.SH CONFIGURATION
.PD 0
Example \fI/etc/swift/dispersion.conf\fR:
.PD 0
Example \fI/etc/swift/dispersion.conf\fR:
.RS 3
.IP "[dispersion]"
@@ -110,12 +116,12 @@ Example \fI/etc/swift/dispersion.conf\fR:
.IP "# dump_json = no"
.IP "# endpoint_type = publicURL"
.RE
.PD
.PD
.SH EXAMPLE
.PP
.PP
.PD 0
$ swift-dispersion-report
$ swift-dispersion-report
.RS 1
@@ -129,14 +135,14 @@ $ swift-dispersion-report
.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
also Openstack-Swift as a whole can be found at
.BI http://swift.openstack.org/admin_guide.html#cluster-health
and
and
.BI http://swift.openstack.org