diff --git a/doc/manpages/swift-account-audit.1 b/doc/manpages/swift-account-audit.1 new file mode 100644 index 0000000000..919892d26d --- /dev/null +++ b/doc/manpages/swift-account-audit.1 @@ -0,0 +1,63 @@ +.\" +.\" Copyright (c) 2016 OpenStack Foundation. +.\" +.\" 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-ACCOUNT-AUDIT "1" "August 2016" "OpenStack Swift" +.SH NAME +swift\-account\-audit \- manually audit OpenStack Swift accounts + +.SH SYNOPSIS +.PP +.B swift\-account\-audit\/ +\fI[options]\fR \fI[url 1]\fR \fI[url 2]\fR \fI...\fR + +.SH DESCRIPTION +.PP +The swift-account-audit cli tool can be used to audit the data for an account. +It crawls the account, checking that all containers and objects can be found. + +You can also feed a list of urls to the script through stdin. + +.SH OPTIONS +.TP +\fB\-c\fR \fIconcurrency\fR +Set the concurrency, default 50 +.TP +\fB\-r\fR \fIring dir\fR +Ring locations, default \fI/etc/swift\fR +.TP +\fB\-e\fR \fIfilename\fR +File for writing a list of inconsistent urls +.TP +\fB\-d\fR +Also download files and verify md5 + +.SH EXAMPLES +.nf +/usr/bin/swift\-account\-audit\/ SOSO_88ad0b83\-b2c5\-4fa1\-b2d6\-60c597202076 +/usr/bin/swift\-account\-audit\/ SOSO_88ad0b83\-b2c5\-4fa1\-b2d6\-60c597202076/container/object +/usr/bin/swift\-account\-audit\/ \fB\-e\fR errors.txt SOSO_88ad0b83\-b2c5\-4fa1\-b2d6\-60c597202076/container +/usr/bin/swift\-account\-audit\/ < errors.txt +/usr/bin/swift\-account\-audit\/ \fB\-c\fR 25 \fB\-d\fR < errors.txt +.fi + +.SH DOCUMENTATION +.LP +More in depth documentation in regards to +.BI swift\-account\-audit +and also about OpenStack Swift as a whole can be found at +.BI http://swift.openstack.org/index.html +and +.BI http://docs.openstack.org diff --git a/doc/manpages/swift-config.1 b/doc/manpages/swift-config.1 new file mode 100644 index 0000000000..df44bd01e2 --- /dev/null +++ b/doc/manpages/swift-config.1 @@ -0,0 +1,51 @@ +.\" +.\" Copyright (c) 2016 OpenStack Foundation. +.\" +.\" 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-CONFIG "1" "August 2016" "OpenStack Swift" + +.SH NAME +swift\-config \- OpenStack Swift config parser + +.SH SYNOPSIS +.B swift\-config +[\fIoptions\fR] \fISERVER\fR + +.SH DESCRIPTION +.PP +Combine Swift configuration files and print result. + +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Show this help message and exit +.TP +\fB\-c\fR \fIN\fR, \fB\-\-config\-num\fR=\fIN\fR +Parse config for the \fIN\fRth server only +.TP +\fB\-s\fR \fISECTION\fR, \fB\-\-section\fR=\fISECTION\fR +Only display matching sections +.TP +\fB\-w\fR, \fB\-\-wsgi\fR +Use wsgi/paste parser instead of readconf + +.SH DOCUMENTATION +.LP +More in depth documentation in regards to +.BI swift\-config +and also about OpenStack Swift as a whole can be found at +.BI http://swift.openstack.org/index.html +and +.BI http://docs.openstack.org diff --git a/doc/manpages/swift-container-reconciler.1 b/doc/manpages/swift-container-reconciler.1 new file mode 100644 index 0000000000..1c893c49d7 --- /dev/null +++ b/doc/manpages/swift-container-reconciler.1 @@ -0,0 +1,58 @@ +.\" +.\" Copyright (c) 2016 OpenStack Foundation. +.\" +.\" 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-CONTAINER-RECONCILER "1" "August 2016" "OpenStack Swift" + +.SH NAME +swift\-container\-reconciler \- OpenStack Swift container reconciler + +.SH SYNOPSIS +.B swift\-container\-reconciler +\fICONFIG \fR[\fIoptions\fR] + +.SH DESCRIPTION +.PP +This daemon will take objects that are in the wrong storage policy and +move them to the right ones, or delete requests that went to the wrong +storage policy and apply them to the right ones. It operates on a +queue similar to the object-expirer's queue. + +Discovering that the object is in the wrong policy will be done in +subsequent commits by the container replicator; this is the daemon +that handles them once they happen. + +Like the object expirer, you only need to run one of these per cluster + +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Show this help message and exit +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Log to console +.TP +\fB\-o\fR, \fB\-\-once\fR +Only run one pass of daemon +.PP + +.SH DOCUMENTATION +.LP +More in depth documentation in regards to +.BI swift\-container\-reconciler +and also about OpenStack Swift as a whole can be found at +.BI http://swift.openstack.org/index.html +and +.BI http://docs.openstack.org diff --git a/doc/manpages/swift-drive-audit.1 b/doc/manpages/swift-drive-audit.1 new file mode 100644 index 0000000000..7eafadf74d --- /dev/null +++ b/doc/manpages/swift-drive-audit.1 @@ -0,0 +1,38 @@ +.\" +.\" Copyright (c) 2016 OpenStack Foundation. +.\" +.\" 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-DRIVE-AUDIT "1" "August 2016" "OpenStack Swift" + +.SH NAME +swift\-drive\-audit \- OpenStack Swift drive audit cron job + +.SH SYNOPSIS +.B swift\-drive\-audit +\fICONFIG\fR + +.SH DESCRIPTION +.PP +Tool that can be run by using cron to watch for bad drives. If errors are +detected, it unmounts the bad drive, so that Swift can work around it. + +.SH DOCUMENTATION +.LP +More in depth documentation in regards to +.BI swift\-drive\-audit +and also about OpenStack Swift as a whole can be found at +.BI http://swift.openstack.org/index.html +and +.BI http://docs.openstack.org diff --git a/doc/manpages/swift-form-signature.1 b/doc/manpages/swift-form-signature.1 new file mode 100644 index 0000000000..653e8dc5f5 --- /dev/null +++ b/doc/manpages/swift-form-signature.1 @@ -0,0 +1,67 @@ +.\" +.\" Copyright (c) 2016 OpenStack Foundation. +.\" +.\" 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-FORM-SIGNATURE "1" "August 2016" "OpenStack Swift" + +.SH NAME +swift\-form\-signature \- compute the expires and signature for OpenStack Swift Form POST middleware + +.SH SYNOPSIS +.B swift\-form\-signature +\fIpath\fR \fIredirect\fR \fImax_file_size\fR \fImax_file_count\fR +\fIseconds\fR \fIkey\fR + +.SH DESCRIPTION +.PP +Tool to compute expires and signature values which can be used to upload +objects directly to the Swift from a browser by using the form POST middleware. + +.SH OPTIONS +.TP +.I path +The prefix to use for form uploaded +objects. For example: +\fI/v1/account/container/object_prefix_\fP would +ensure all form uploads have that path +prepended to the browser\-given file name. +.TP +.I redirect +The URL to redirect the browser to after +the uploads have completed. +.TP +.I max_file_size +The maximum file size per file uploaded. +.TP +.I max_file_count +The maximum number of uploaded files +allowed. +.TP +.I seconds +The number of seconds from now to allow +the form post to begin. +.TP +.I key +The X\-Account\-Meta\-Temp\-URL\-Key for the +account. + +.SH DOCUMENTATION +.LP +More in depth documentation in regards to +.BI swift\-form\-signature +and also about OpenStack Swift as a whole can be found at +.BI http://swift.openstack.org/index.html +and +.BI http://docs.openstack.org diff --git a/doc/manpages/swift-object-reconstructor.1 b/doc/manpages/swift-object-reconstructor.1 new file mode 100644 index 0000000000..af5a662d8d --- /dev/null +++ b/doc/manpages/swift-object-reconstructor.1 @@ -0,0 +1,60 @@ +.\" +.\" Copyright (c) 2016 OpenStack Foundation. +.\" +.\" 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-RECONSTRUCTOR "1" "August 2016" "OpenStack Swift" + +.SH NAME +swift\-object\-reconstructor \- OpenStack Swift EC object reconstructor + +.SH SYNOPSIS +.B swift\-object\-reconstructor +\fICONFIG \fR[\fIoptions\fR] + +.SH DESCRIPTION +.PP +Daemon for reconstruction of EC objects. Once a pair of nodes has +determined the need to replace a missing object fragment, instead of +pushing over a copy like replication would do, the reconstructor has to +read in enough surviving fragments from other nodes and perform a local +reconstruction before it has the correct data to push to the other node. + +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Show this help message and exit +.TP +\fB\-d\fR \fIDEVICES\fR, \fB\-\-devices\fR=\fIDEVICES\fR +Reconstruct only given devices. Comma\-separated list +.TP +\fB\-p\fR \fIPARTITIONS\fR, \fB\-\-partitions\fR=\fIPARTITIONS\fR +Reconstruct only given partitions. Comma\-separated +list +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Log to console +.TP +\fB\-o\fR, \fB\-\-once\fR +Only run one pass of daemon +.PP + +.SH DOCUMENTATION +.LP +More in depth documentation in regards to +.BI swift\-object\-reconstructor +and also about OpenStack Swift as a whole can be found at +.BI http://swift.openstack.org/index.html +and +.BI http://docs.openstack.org diff --git a/doc/manpages/swift-recon-cron.1 b/doc/manpages/swift-recon-cron.1 new file mode 100644 index 0000000000..7ffa93ce87 --- /dev/null +++ b/doc/manpages/swift-recon-cron.1 @@ -0,0 +1,38 @@ +.\" +.\" Copyright (c) 2016 OpenStack Foundation. +.\" +.\" 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-RECON-CRON "1" "August 2016" "OpenStack Swift" + +.SH NAME +swift\-recon\-cron \- OpenStack Swift recon cron job + +.SH SYNOPSIS +.B swift\-recon\-cron +\fI\fR + +.SH DESCRIPTION +.PP +Tool that can be run by using cron to fill recon cache. Recon data +can be read by \fBswift-recon\fR tool. + +.SH DOCUMENTATION +.LP +More in depth documentation in regards to +.BI swift\-recon\-cron +and also about OpenStack Swift as a whole can be found at +.BI http://swift.openstack.org/index.html +and +.BI http://docs.openstack.org diff --git a/doc/manpages/swift-reconciler-enqueue.1 b/doc/manpages/swift-reconciler-enqueue.1 new file mode 100644 index 0000000000..4b5c667bd9 --- /dev/null +++ b/doc/manpages/swift-reconciler-enqueue.1 @@ -0,0 +1,58 @@ +.\" +.\" Copyright (c) 2016 OpenStack Foundation. +.\" +.\" 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-RECONCILER-ENQUEUE "1" "August 2016" "OpenStack Swift" + +.SH NAME +swift\-reconciler\-enqueue \- OpenStack Swift reconciler enqueue +.SH SYNOPSIS +.B swift\-reconciler\-enqueue +\fIpolicy_index\fR \fI/a/c/o\fR \fItimestamp\fR \fR[\fIoptions\fR] + +.SH DESCRIPTION +.PP +This script enqueues an object to be evaluated by the reconciler. + +.SH OPTIONS +.TP +\fIpolicy_index\fR +The policy the object is currently stored in. +.TP +\fI/a/c/o\fR +The full path of the object \- UTF\-8 +.TP +\fItimestamp\fR +The timestamp of the datafile/tombstone. + +.TP +\fB\-h\fR, \fB\-\-help\fR +Show this help message and exit +.TP +\fB\-X\fR \fIOP\fR, \fB\-\-op\fR=\fIOP\fR +The method of the misplaced operation +.TP +\fB\-f\fR, \fB\-\-force\fR +Force an object to be re\-enqueued +.PP + +.SH DOCUMENTATION +.LP +More in depth documentation in regards to +.BI swift\-reconciler\-enqueue +and also about OpenStack Swift as a whole can be found at +.BI http://swift.openstack.org/index.html +and +.BI http://docs.openstack.org diff --git a/doc/manpages/swift-ring-builder-analyzer.1 b/doc/manpages/swift-ring-builder-analyzer.1 new file mode 100644 index 0000000000..39dc5f7c46 --- /dev/null +++ b/doc/manpages/swift-ring-builder-analyzer.1 @@ -0,0 +1,52 @@ +.\" +.\" Copyright (c) 2016 OpenStack Foundation. +.\" +.\" 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-RING-BUILDER-ANALYZER "1" "August 2016" "OpenStack Swift" + +.SH NAME +swift\-ring\-builder\-analyzer \- put the OpenStack Swift ring builder through its paces +.SH SYNOPSIS +.B swift\-ring\-builder\-analyzer +[\fIoptions\fR] \fIscenario_path\fR + +.SH DESCRIPTION +.PP +This is a tool to help developers quantify changes to the ring +builder. It takes a scenario (JSON file) describing the builder's +basic parameters (part_power, replicas, etc.) and a number of +"rounds", where each round is a set of operations to perform on the +builder. For each round, the operations are applied, and then the +builder is rebalanced until it reaches a steady state. + +.SH OPTIONS +.TP +.I scenario_path +Path to the scenario file +.TP +\fB\-h\fR, \fB\-\-help\fR +Show this help message and exit +.TP +\fB\-\-check\fR, \fB\-c\fR +Just check the scenario, don't execute it. + +.SH DOCUMENTATION +.LP +More in depth documentation in regards to +.BI swift\-ring\-builder\-analyzer +and also about OpenStack Swift as a whole can be found at +.BI http://swift.openstack.org/index.html +and +.BI http://docs.openstack.org diff --git a/doc/manpages/swift-temp-url.1 b/doc/manpages/swift-temp-url.1 new file mode 100644 index 0000000000..5d90d3e851 --- /dev/null +++ b/doc/manpages/swift-temp-url.1 @@ -0,0 +1,56 @@ +.\" +.\" Copyright (c) 2016 OpenStack Foundation. +.\" +.\" 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-TEMP-URL "1" "August 2016" "OpenStack Swift" + +.SH NAME +swift\-temp\-url \- generates the query parameters for OpenStack Swift Temporary URL middleware + +.SH DESCRIPTION +.PP +Tool that generates the query parameters which can be used to access Swift +objects directly from a browser by using the Temporary URL middleware. + +.B NOTE: This command is deprecated and will be removed +.B in the future. Please use 'swift tempurl' instead. + +.SH SYNOPSIS +.B swift\-temp\-url +\fImethod\fR \fIseconds\fR \fIpath\fR \fIkey\fR + +.SH OPTIONS +.TP +.I method +The method to allow; GET for example. +.TP +.I seconds +The number of seconds from now to allow requests. +.TP +.I path +The full path to the resource. +Example: \fI/v1/AUTH_account/c/o\fP +.TP +.I key +The X\-Account\-Meta\-Temp\-URL\-Key for the account. + +.SH DOCUMENTATION +.LP +More in depth documentation in regards to +.BI swift\-temp\-url +and also about OpenStack Swift as a whole can be found at +.BI http://swift.openstack.org/index.html +and +.BI http://docs.openstack.org