From 88cc776a5c89097f6e9d4fb0c70bad7ccd9f1b25 Mon Sep 17 00:00:00 2001 From: asettle Date: Thu, 3 Sep 2015 12:28:00 +1000 Subject: [PATCH] Documenting specification of object devices for audit Adding a new section (from an existing section) on object-auditor to the admin-guide-cloud Change-Id: I5966f91367b940e506c242307cbdf123892e7d82 Closes-bug: 1295527 --- .../source/objectstorage.rst | 1 + .../source/objectstorage_auditors.rst | 25 +++++++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 doc/admin-guide-cloud/source/objectstorage_auditors.rst diff --git a/doc/admin-guide-cloud/source/objectstorage.rst b/doc/admin-guide-cloud/source/objectstorage.rst index 74a8e9d3c5..b73ac1454b 100644 --- a/doc/admin-guide-cloud/source/objectstorage.rst +++ b/doc/admin-guide-cloud/source/objectstorage.rst @@ -12,6 +12,7 @@ Object Storage objectstorage_ringbuilder.rst objectstorage_arch.rst objectstorage_replication.rst + objectstorage_auditors.rst objectstorage_account_reaper.rst objectstorage_tenant_specific_image_storage.rst objectstorage-monitoring.rst diff --git a/doc/admin-guide-cloud/source/objectstorage_auditors.rst b/doc/admin-guide-cloud/source/objectstorage_auditors.rst new file mode 100644 index 0000000000..a7e2b307a6 --- /dev/null +++ b/doc/admin-guide-cloud/source/objectstorage_auditors.rst @@ -0,0 +1,25 @@ +============== +Object Auditor +============== + +On system failures, the XFS file system can sometimes truncate files it is +trying to write and produce zero-byte files. The object-auditor will catch +these problems but in the case of a system crash it is advisable to run +an extra, less rate limited sweep, to check for these specific files. +You can run this command as follows:: + + swift-object-auditor /path/to/object-server/config/file.conf once -z 1000 + +.. note:: + "-z" means to only check for zero-byte files at 1000 files per second. + +It is useful to run the object auditor on a specific device or set of devices. +You can run the object-auditor once as follows:: + + swift-object-auditor /path/to/object-server/config/file.conf once / + --devices=sda,sdb + +.. note:: + This will run the object auditor on only the sda and sdb devices. + This parameter accepts a comma separated list of values. +