Browse Source

Merge branch 'master' into feature/hummingbird

Change-Id: I29d820e434e6e03bb11f07d88f686c3db99286ed
changes/17/264517/1
Michael Barton 3 years ago
parent
commit
93ddaffaeb
100 changed files with 3859 additions and 2210 deletions
  1. 4
    2
      .functests
  2. 2
    0
      .gitignore
  3. 7
    3
      .mailmap
  4. 4
    0
      .testr.conf
  5. 3
    3
      bin/swift-account-audit
  6. 1
    4
      bin/swift-dispersion-report
  7. 25
    1
      bin/swift-init
  8. 102
    4
      doc/manpages/account-server.conf.5
  9. 100
    4
      doc/manpages/container-server.conf.5
  10. 9
    1
      doc/manpages/dispersion.conf.5
  11. 71
    0
      doc/manpages/object-expirer.conf.5
  12. 245
    16
      doc/manpages/object-server.conf.5
  13. 516
    31
      doc/manpages/proxy-server.conf.5
  14. 2
    0
      doc/manpages/swift-init.1
  15. 3
    1
      doc/manpages/swift-recon.1
  16. 7
    4
      doc/source/admin_guide.rst
  17. 1
    5
      doc/source/api/form_post_middleware.rst
  18. 2
    0
      doc/source/api/large_objects.rst
  19. 18
    1
      doc/source/api/object_api_v1_overview.rst
  20. 1
    3
      doc/source/api/temporary_url_middleware.rst
  21. 8
    5
      doc/source/associated_projects.rst
  22. 716
    460
      doc/source/deployment_guide.rst
  23. 6
    5
      doc/source/development_auth.rst
  24. 5
    5
      doc/source/development_guidelines.rst
  25. 3
    3
      doc/source/development_saio.rst
  26. 7
    8
      doc/source/howto_installmultinode.rst
  27. 2
    0
      doc/source/overview_auth.rst
  28. 2
    1
      doc/source/overview_backing_store.rst
  29. 0
    14
      doc/source/overview_erasure_code.rst
  30. 16
    10
      doc/source/overview_policies.rst
  31. 3
    1
      doc/source/policies_saio.rst
  32. 12
    3
      etc/account-server.conf-sample
  33. 11
    0
      etc/container-server.conf-sample
  34. 4
    0
      etc/drive-audit.conf-sample
  35. 1
    4
      etc/object-server.conf-sample
  36. 15
    3
      etc/proxy-server.conf-sample
  37. 10
    5
      etc/swift.conf-sample
  38. 3
    3
      requirements.txt
  39. 31
    19
      swift/account/backend.py
  40. 4
    4
      swift/account/reaper.py
  41. 2
    1
      swift/account/server.py
  42. 4
    3
      swift/account/utils.py
  43. 4
    4
      swift/cli/recon.py
  44. 9
    7
      swift/cli/ring_builder_analyzer.py
  45. 31
    24
      swift/cli/ringbuilder.py
  46. 2
    1
      swift/common/db.py
  47. 20
    9
      swift/common/db_replicator.py
  48. 4
    8
      swift/common/direct_client.py
  49. 3
    1
      swift/common/internal_client.py
  50. 17
    7
      swift/common/manager.py
  51. 14
    44
      swift/common/memcached.py
  52. 9
    7
      swift/common/middleware/acl.py
  53. 64
    2
      swift/common/middleware/bulk.py
  54. 5
    5
      swift/common/middleware/dlo.py
  55. 1
    1
      swift/common/middleware/domain_remap.py
  56. 2
    2
      swift/common/middleware/formpost.py
  57. 16
    32
      swift/common/middleware/keystoneauth.py
  58. 2
    1
      swift/common/middleware/list_endpoints.py
  59. 2
    10
      swift/common/middleware/name_check.py
  60. 2
    1
      swift/common/middleware/recon.py
  61. 57
    14
      swift/common/middleware/slo.py
  62. 16
    9
      swift/common/middleware/staticweb.py
  63. 11
    9
      swift/common/middleware/tempauth.py
  64. 107
    95
      swift/common/middleware/tempurl.py
  65. 35
    34
      swift/common/middleware/versioned_writes.py
  66. 25
    9
      swift/common/request_helpers.py
  67. 695
    627
      swift/common/ring/builder.py
  68. 2
    1
      swift/common/ring/ring.py
  69. 5
    5
      swift/common/ring/utils.py
  70. 172
    27
      swift/common/storage_policy.py
  71. 21
    19
      swift/common/swob.py
  72. 48
    89
      swift/common/utils.py
  73. 8
    2
      swift/common/wsgi.py
  74. 35
    21
      swift/container/backend.py
  75. 2
    1
      swift/container/replicator.py
  76. 5
    3
      swift/container/server.py
  77. 2
    2
      swift/container/updater.py
  78. 3
    4
      swift/locale/de/LC_MESSAGES/swift.po
  79. 3
    4
      swift/locale/es/LC_MESSAGES/swift.po
  80. 3
    4
      swift/locale/fr/LC_MESSAGES/swift.po
  81. 3
    4
      swift/locale/it/LC_MESSAGES/swift.po
  82. 3
    4
      swift/locale/ja/LC_MESSAGES/swift.po
  83. 3
    4
      swift/locale/ko_KR/LC_MESSAGES/swift.po
  84. 3
    4
      swift/locale/pt_BR/LC_MESSAGES/swift.po
  85. 3
    4
      swift/locale/ru/LC_MESSAGES/swift.po
  86. 0
    19
      swift/locale/swift-log-critical.pot
  87. 0
    19
      swift/locale/swift-log-error.pot
  88. 0
    19
      swift/locale/swift-log-info.pot
  89. 0
    19
      swift/locale/swift-log-warning.pot
  90. 3
    4
      swift/locale/tr_TR/LC_MESSAGES/swift.po
  91. 3
    4
      swift/locale/zh_CN/LC_MESSAGES/swift.po
  92. 3
    4
      swift/locale/zh_TW/LC_MESSAGES/swift.po
  93. 2
    1
      swift/obj/auditor.py
  94. 350
    298
      swift/obj/diskfile.py
  95. 3
    0
      swift/obj/mem_diskfile.py
  96. 2
    2
      swift/obj/reconstructor.py
  97. 18
    10
      swift/obj/replicator.py
  98. 4
    1
      swift/obj/server.py
  99. 6
    5
      swift/obj/updater.py
  100. 0
    0
      swift/proxy/controllers/base.py

+ 4
- 2
.functests View File

@@ -1,9 +1,11 @@
1 1
 #!/bin/bash
2 2
 
3 3
 SRC_DIR=$(python -c "import os; print os.path.dirname(os.path.realpath('$0'))")
4
+set -e
4 5
 
5
-cd ${SRC_DIR}/test/functional
6
-nosetests --exe $@
6
+cd ${SRC_DIR}
7
+export TESTS_DIR=${SRC_DIR}/test/functional
8
+ostestr --serial --pretty $@
7 9
 rvalue=$?
8 10
 cd -
9 11
 

+ 2
- 0
.gitignore View File

@@ -16,4 +16,6 @@ pycscope.*
16 16
 .idea
17 17
 MANIFEST
18 18
 
19
+.testrepository/*
20
+subunit.log
19 21
 test/probe/.noseids

+ 7
- 3
.mailmap View File

@@ -58,7 +58,7 @@ Madhuri Kumari <madhuri.rai07@gmail.com> madhuri <madhuri@madhuri-VirtualBox.(no
58 58
 Morgan Fainberg <morgan.fainberg@gmail.com> <m@metacloud.com>
59 59
 Hua Zhang <zhuadl@cn.ibm.com> <zhuadl@cn.ibm.com>
60 60
 Yummy Bian <yummy.bian@gmail.com> <yummy.bian@gmail.com>
61
-Alistair Coles <alistair.coles@hp.com> <alistair.coles@hp.com>
61
+Alistair Coles <alistair.coles@hpe.com> <alistair.coles@hp.com>
62 62
 Tong Li <litong01@us.ibm.com> <litong01@us.ibm.com>
63 63
 Paul Luse <paul.e.luse@intel.com> <paul.e.luse@intel.com>
64 64
 Yuan Zhou <yuan.zhou@intel.com> <yuan.zhou@intel.com>
@@ -66,9 +66,9 @@ Jola Mirecka <jola.mirecka@hp.com> <jola.mirecka@hp.com>
66 66
 Ning Zhang <ning@zmanda.com> <ning@zmanda.com>
67 67
 Mauro Stettler <mauro.stettler@gmail.com> <mauro.stettler@gmail.com>
68 68
 Pawel Palucki <pawel.palucki@gmail.com> <pawel.palucki@gmail.com>
69
-Guang Yee <guang.yee@hp.com> <guang.yee@hp.com>
69
+Guang Yee <guang.yee@hpe.com> <guang.yee@hp.com>
70 70
 Jing Liuqing <jing.liuqing@99cloud.net> <jing.liuqing@99cloud.net>
71
-Lorcan Browne <lorcan.browne@hp.com> <lorcan.browne@hp.com>
71
+Lorcan Browne <lorcan.browne@hpe.com> <lorcan.browne@hp.com>
72 72
 Eohyung Lee <liquidnuker@gmail.com> <liquid@kt.com>
73 73
 Harshit Chitalia <harshit@acelio.com> <harshit@acelio.com>
74 74
 Richard Hawkins <richard.hawkins@rackspace.com>
@@ -83,3 +83,7 @@ Atsushi Sakai <sakaia@jp.fujitsu.com>
83 83
 Takashi Natsume <natsume.takashi@lab.ntt.co.jp>
84 84
 Nakagawa Masaaki <nakagawamsa@nttdata.co.jp> nakagawamsa
85 85
 Romain Le Disez <romain.ledisez@ovh.net> Romain LE DISEZ
86
+Donagh McCabe <donagh.mccabe@hpe.com> <donagh.mccabe@hp.com>
87
+Eamonn O'Toole <eamonn.otoole@hpe.com> <eamonn.otoole@hp.com>
88
+Gerry Drudy <gerry.drudy@hpe.com> <gerry.drudy@hp.com>
89
+Mark Seger <mark.seger@hpe.com> <mark.seger@hp.com>

+ 4
- 0
.testr.conf View File

@@ -0,0 +1,4 @@
1
+[DEFAULT]
2
+test_command=SWIFT_TEST_DEBUG_LOGS=${SWIFT_TEST_DEBUG_LOGS} ${PYTHON:-python} -m subunit.run discover -t ./ ${TESTS_DIR:-./test/functional/} $LISTOPT $IDOPTION
3
+test_id_option=--load-list $IDFILE
4
+test_list_option=--list

+ 3
- 3
bin/swift-account-audit View File

@@ -20,7 +20,7 @@ from hashlib import md5
20 20
 import getopt
21 21
 from itertools import chain
22 22
 
23
-import simplejson
23
+import json
24 24
 from eventlet.greenpool import GreenPool
25 25
 from eventlet.event import Event
26 26
 from six.moves.urllib.parse import quote
@@ -176,7 +176,7 @@ class Auditor(object):
176 176
                         break
177 177
                     if node['id'] not in responses:
178 178
                         responses[node['id']] = dict(resp.getheaders())
179
-                    results = simplejson.loads(resp.read())
179
+                    results = json.loads(resp.read())
180 180
                 except Exception:
181 181
                     self.container_exceptions += 1
182 182
                     consistent = False
@@ -249,7 +249,7 @@ class Auditor(object):
249 249
                               " from %ss:%ss" %
250 250
                               (account, node['ip'], node['device']))
251 251
                         break
252
-                    results = simplejson.loads(resp.read())
252
+                    results = json.loads(resp.read())
253 253
                 except Exception:
254 254
                     self.account_exceptions += 1
255 255
                     consistent = False

+ 1
- 4
bin/swift-dispersion-report View File

@@ -14,15 +14,12 @@
14 14
 # See the License for the specific language governing permissions and
15 15
 # limitations under the License.
16 16
 
17
+import json
17 18
 from collections import defaultdict
18 19
 from six.moves.configparser import ConfigParser
19 20
 from optparse import OptionParser
20 21
 from sys import exit, stdout, stderr
21 22
 from time import time
22
-try:
23
-    import simplejson as json
24
-except ImportError:
25
-    import json
26 23
 
27 24
 from eventlet import GreenPool, hubs, patcher, Timeout
28 25
 from eventlet.pools import Pool

+ 25
- 1
bin/swift-init View File

@@ -20,7 +20,21 @@ from optparse import OptionParser
20 20
 from swift.common.manager import Manager, UnknownCommandError, \
21 21
     KILL_WAIT, RUN_DIR
22 22
 
23
-USAGE = """%prog <server>[.config] [<server>[.config] ...] <command> [options]
23
+USAGE = \
24
+    """%prog <server>[.<config>] [<server>[.<config>] ...] <command> [options]
25
+
26
+where:
27
+    <server>  is the name of a swift service e.g. proxy-server.
28
+              The '-server' part of the name may be omitted.
29
+    <config>  is an explicit configuration filename without the
30
+              .conf extension. If <config> is specified then <server> should
31
+              refer to a directory containing the configuration file, e.g.:
32
+
33
+                  swift-init object.1 start
34
+
35
+              will start an object-server using the configuration file
36
+              /etc/swift/object-server/1.conf
37
+    <command> is a command from the list below.
24 38
 
25 39
 Commands:
26 40
 """ + '\n'.join(["%16s: %s" % x for x in Manager.list_commands()])
@@ -50,6 +64,16 @@ def main():
50 64
                       dest="run_dir", default=RUN_DIR,
51 65
                       help="alternative directory to store running pid files "
52 66
                       "default: %s" % RUN_DIR)
67
+    # Changing behaviour if missing config
68
+    parser.add_option('--strict', dest='strict', action='store_true',
69
+                      help="Return non-zero status code if some config is "
70
+                           "missing. Default mode if all servers are "
71
+                           "explicitly named.")
72
+    # a negative option for strict
73
+    parser.add_option('--non-strict', dest='strict', action='store_false',
74
+                      help="Return zero status code even if some config is "
75
+                           "missing. Default mode if any server is a glob or "
76
+                           "one of aliases `all`, `main` or `rest`.")
53 77
 
54 78
     options, args = parser.parse_args()
55 79
 

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

@@ -57,6 +57,8 @@ IP address the account server should bind to. The default is 0.0.0.0 which will
57 57
 it bind to all available addresses.
58 58
 .IP "\fBbind_port\fR"
59 59
 TCP port the account server should bind to. The default is 6002.
60
+.IP "\fBbind_timeout\fR"
61
+Timeout to bind socket. The default is 30.
60 62
 .IP \fBbacklog\fR
61 63
 TCP backlog.  Maximum number of allowed pending connections. The default value is 4096.
62 64
 .IP \fBworkers\fR
@@ -79,12 +81,46 @@ Parent directory or where devices are mounted. Default is /srv/node.
79 81
 .IP \fBmount_check\fR
80 82
 Whether or not check if the devices are mounted to prevent accidentally writing to
81 83
 the root device. The default is set to true.
84
+.IP \fBdisable_fallocate\fR
85
+Disable pre-allocate disk space for a file. The default is false.
82 86
 .IP \fBlog_name\fR
83 87
 Label used when logging. The default is swift.
84 88
 .IP \fBlog_facility\fR
85 89
 Syslog log facility. The default is LOG_LOCAL0.
86 90
 .IP \fBlog_level\fR
87 91
 Logging level. The default is INFO.
92
+.IP "\fBlog_address\fR
93
+Logging address. The default is /dev/log.
94
+.IP \fBlog_max_line_length\fR
95
+The following caps the length of log lines to the value given; no limit if
96
+set to 0, the default.
97
+.IP \fBlog_custom_handlers\fR
98
+Comma separated list of functions to call to setup custom log handlers.
99
+functions get passed: conf, name, log_to_console, log_route, fmt, logger,
100
+adapted_logger. The default is empty.
101
+.IP \fBlog_udp_host\fR
102
+If set, log_udp_host will override log_address.
103
+.IP "\fBlog_udp_port\fR
104
+UDP log port, the default is 514.
105
+.IP \fBlog_statsd_host\fR = localhost
106
+log_statsd_*  enable StatsD logging.
107
+.IP \fBlog_statsd_port\fR
108
+The default is 8125.
109
+.IP \fBlog_statsd_default_sample_rate\fR
110
+The default is 1.
111
+.IP \fBlog_statsd_sample_rate_factor\fR
112
+The default is 1.
113
+.IP \fBlog_statsd_metric_prefix\fR
114
+The default is empty.
115
+.IP \fBdb_preallocation\fR
116
+If you don't mind the extra disk space usage in overhead, you can turn this
117
+on to preallocate disk space with SQLite databases to decrease fragmentation.
118
+The default is false.
119
+.IP \fBeventlet_debug\fR
120
+Debug mode for eventlet library. The default is false.
121
+.IP \fBfallocate_reserve\fR
122
+You can set fallocate_reserve to the number of bytes you'd like fallocate to
123
+reserve, whether there is space for the given file size or not. The default is 0.
88 124
 .RE
89 125
 .PD
90 126
 
@@ -117,12 +153,21 @@ This is normally \fBegg:swift#account\fR.
117 153
 Label used when logging. The default is account-server.
118 154
 .IP "\fBset log_facility\fR
119 155
 Syslog log facility. The default is LOG_LOCAL0.
120
-.IP "\fB set log_level\fR
156
+.IP "\fBset log_level\fR
121 157
 Logging level. The default is INFO.
122
-.IP "\fB set log_requests\fR
158
+.IP "\fBset log_requests\fR
123 159
 Enables request logging. The default is True.
124
-.IP "\fB set log_address\fR
160
+.IP "\fBset log_address\fR
125 161
 Logging address. The default is /dev/log.
162
+.IP "\fBauto_create_account_prefix\fR
163
+The default is ".".
164
+.IP "\fBreplication_server\fR
165
+Configure parameter for creating specific server.
166
+To handle all verbs, including replication verbs, do not specify
167
+"replication_server" (this is the default). To only handle replication,
168
+set to a true value (e.g. "true" or "1"). To handle only non-replication
169
+verbs, set to "false". Unless you have a separate replication network, you
170
+should not specify any value for "replication_server". The default is empty.
126 171
 .RE
127 172
 .PD
128 173
 
@@ -158,6 +203,36 @@ and ensure that swift has read/write. The default is /var/cache/swift.
158 203
 .RE
159 204
 .PD
160 205
 
206
+.RS 0
207
+.IP "\fB[filter:xprofile]\fR"
208
+.RS 3
209
+.IP "\fBuse\fR"
210
+Entry point for paste.deploy for the xprofile middleware. This is the reference to the installed python egg.
211
+This is normally \fBegg:swift#xprofile\fR.
212
+.IP "\fBprofile_module\fR"
213
+This option enable you to switch profilers which should inherit from python
214
+standard profiler. Currently the supported value can be 'cProfile', 'eventlet.green.profile' etc.
215
+.IP "\fBlog_filename_prefix\fR"
216
+This prefix will be used to combine process ID and timestamp to name the
217
+profile data file.  Make sure the executing user has permission to write
218
+into this path (missing path segments will be created, if necessary).
219
+If you enable profiling in more than one type of daemon, you must override
220
+it with an unique value like, the default is /var/log/swift/profile/account.profile.
221
+.IP "\fBdump_interval\fR"
222
+The profile data will be dumped to local disk based on above naming rule
223
+in this interval. The default is 5.0.
224
+.IP "\fBdump_timestamp\fR"
225
+Be careful, this option will enable profiler to dump data into the file with
226
+time stamp which means there will be lots of files piled up in the directory.
227
+The default is false
228
+.IP "\fBpath\fR"
229
+This is the path of the URL to access the mini web UI. The default is __profile__.
230
+.IP "\fBflush_at_shutdown\fR"
231
+Clear the data when the wsgi server shutdown. The default is false.
232
+.IP "\fBunwind\fR"
233
+Unwind the iterator of applications. Default is false.
234
+.RE
235
+.PD
161 236
 
162 237
 
163 238
 .SH ADDITIONAL SECTIONS
@@ -177,7 +252,7 @@ Logging level. The default is INFO.
177 252
 .IP \fBlog_address\fR
178 253
 Logging address. The default is /dev/log.
179 254
 .IP \fBper_diff\fR
180
-The default is 1000.
255
+Maximum number of database rows that will be sync'd in a single HTTP replication request. The default is 1000.
181 256
 .IP \fBmax_diffs\fR
182 257
 This caps how long the replicator will spend trying to sync a given database per pass so the other databases don't get starved. The default is 100.
183 258
 .IP \fBconcurrency\fR
@@ -193,6 +268,15 @@ Connection timeout to external services. The default is 0.5 seconds.
193 268
 .IP \fBreclaim_age\fR
194 269
 Time elapsed in seconds before an account can be reclaimed. The default is
195 270
 604800 seconds.
271
+.IP \fBrsync_compress\fR
272
+Allow rsync to compress data which is transmitted to destination node
273
+during sync. However, this is applicable only when destination node is in
274
+a different region than the local one. The default is false.
275
+.IP \fBrsync_module\fR
276
+Format of the rysnc module where the replicator will send data. See
277
+etc/rsyncd.conf-sample for some usage examples.
278
+.IP \fBrecon_cache_path\fR
279
+Path to recon cache directory. The default is /var/cache/swift.
196 280
 .RE
197 281
 
198 282
 
@@ -213,6 +297,8 @@ Logging address. The default is /dev/log.
213 297
 Will audit, at most, 1 account per device per interval. The default is 1800 seconds.
214 298
 .IP \fBaccounts_per_second\fR
215 299
 Maximum accounts audited per second. Should be tuned according to individual system specs. 0 is unlimited. The default is 200.
300
+.IP \fBrecon_cache_path\fR
301
+Path to recon cache directory. The default is /var/cache/swift.
216 302
 .RE
217 303
 
218 304
 
@@ -237,6 +323,18 @@ Minimum time for a pass to take. The default is 3600 seconds.
237 323
 Request timeout to external services. The default is 10 seconds.
238 324
 .IP \fBconn_timeout\fR
239 325
 Connection timeout to external services. The default is 0.5 seconds.
326
+.IP \fBdelay_reaping\fR
327
+Normally, the reaper begins deleting account information for deleted accounts
328
+immediately; you can set this to delay its work however. The value is in
329
+seconds. The default is 0.
330
+.IP \fBreap_warn_after\fR
331
+If the account fails to be be reaped due to a persistent error, the
332
+account reaper will log a message such as:
333
+    Account <name> has not been reaped since <date>
334
+You can search logs for this message if space is not being reclaimed
335
+after you delete account(s).
336
+Default is 2592000 seconds (30 days). This is in addition to any time
337
+requested by delay_reaping.
240 338
 .RE
241 339
 .PD
242 340
 

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

@@ -57,6 +57,8 @@ IP address the container server should bind to. The default is 0.0.0.0 which wil
57 57
 it bind to all available addresses.
58 58
 .IP "\fBbind_port\fR"
59 59
 TCP port the container server should bind to. The default is 6001.
60
+.IP "\fBbind_timeout\fR"
61
+Timeout to bind socket. The default is 30.
60 62
 .IP \fBbacklog\fR
61 63
 TCP backlog.  Maximum number of allowed pending connections. The default value is 4096.
62 64
 .IP \fBworkers\fR
@@ -70,6 +72,12 @@ concurrent requests.
70 72
 Maximum number of clients one worker can process simultaneously (it will
71 73
 actually accept(2) N + 1). Setting this to one (1) will only handle one request
72 74
 at a time, without accepting another request concurrently.  The default is 1024.
75
+.IP \fBallowed_sync_hosts\fR
76
+This is a comma separated list of hosts allowed in the X-Container-Sync-To
77
+field for containers. This is the old-style of using container sync. It is
78
+strongly recommended to use the new style of a separate
79
+container-sync-realms.conf -- see container-sync-realms.conf-sample
80
+allowed_sync_hosts = 127.0.0.1
73 81
 .IP \fBuser\fR
74 82
 The system user that the container server will run as. The default is swift.
75 83
 .IP \fBswift_dir\fR
@@ -79,6 +87,8 @@ Parent directory or where devices are mounted. Default is /srv/node.
79 87
 .IP \fBmount_check\fR
80 88
 Whether or not check if the devices are mounted to prevent accidentally writing to
81 89
 the root device. The default is set to true.
90
+.IP \fBdisable_fallocate\fR
91
+Disable pre-allocate disk space for a file. The default is false.
82 92
 .IP \fBlog_name\fR
83 93
 Label used when logging. The default is swift.
84 94
 .IP \fBlog_facility\fR
@@ -87,6 +97,36 @@ Syslog log facility. The default is LOG_LOCAL0.
87 97
 Logging level. The default is INFO.
88 98
 .IP \fBlog_address\fR
89 99
 Logging address. The default is /dev/log.
100
+.IP \fBlog_max_line_length\fR
101
+The following caps the length of log lines to the value given; no limit if
102
+set to 0, the default.
103
+.IP \fBlog_custom_handlers\fR
104
+Comma separated list of functions to call to setup custom log handlers.
105
+functions get passed: conf, name, log_to_console, log_route, fmt, logger,
106
+adapted_logger. The default is empty.
107
+.IP \fBlog_udp_host\fR
108
+If set, log_udp_host will override log_address.
109
+.IP "\fBlog_udp_port\fR
110
+UDP log port, the default is 514.
111
+.IP \fBlog_statsd_host\fR = localhost
112
+log_statsd_*  enable StatsD logging.
113
+.IP \fBlog_statsd_port\fR
114
+The default is 8125.
115
+.IP \fBlog_statsd_default_sample_rate\fR
116
+The default is 1.
117
+.IP \fBlog_statsd_sample_rate_factor\fR
118
+The default is 1.
119
+.IP \fBlog_statsd_metric_prefix\fR
120
+The default is empty.
121
+.IP \fBdb_preallocation\fR
122
+If you don't mind the extra disk space usage in overhead, you can turn this
123
+on to preallocate disk space with SQLite databases to decrease fragmentation.
124
+The default is false.
125
+.IP \fBeventlet_debug\fR
126
+Debug mode for eventlet library. The default is false.
127
+.IP \fBfallocate_reserve\fR
128
+You can set fallocate_reserve to the number of bytes you'd like fallocate to
129
+reserve, whether there is space for the given file size or not. The default is 0.
90 130
 .RE
91 131
 .PD
92 132
 
@@ -129,6 +169,17 @@ Logging address. The default is /dev/log.
129 169
 Request timeout to external services. The default is 3 seconds.
130 170
 .IP \fBconn_timeout\fR
131 171
 Connection timeout to external services. The default is 0.5 seconds.
172
+.IP \fBallow_versions\fR
173
+The default is false.
174
+.IP \fBauto_create_account_prefix\fR
175
+The default is '.'.
176
+.IP \fBreplication_server\fR
177
+Configure parameter for creating specific server.
178
+To handle all verbs, including replication verbs, do not specify
179
+"replication_server" (this is the default). To only handle replication,
180
+set to a True value (e.g. "True" or "1"). To handle only non-replication
181
+verbs, set to "False". Unless you have a separate replication network, you
182
+should not specify any value for "replication_server".
132 183
 .RE
133 184
 .PD
134 185
 
@@ -164,6 +215,36 @@ and ensure that swift has read/write. The default is /var/cache/swift.
164 215
 .RE
165 216
 .PD
166 217
 
218
+.RS 0
219
+.IP "\fB[filter:xprofile]\fR"
220
+.RS 3
221
+.IP "\fBuse\fR"
222
+Entry point for paste.deploy for the xprofile middleware. This is the reference to the installed python egg.
223
+This is normally \fBegg:swift#xprofile\fR.
224
+.IP "\fBprofile_module\fR"
225
+This option enable you to switch profilers which should inherit from python
226
+standard profiler. Currently the supported value can be 'cProfile', 'eventlet.green.profile' etc.
227
+.IP "\fBlog_filename_prefix\fR"
228
+This prefix will be used to combine process ID and timestamp to name the
229
+profile data file.  Make sure the executing user has permission to write
230
+into this path (missing path segments will be created, if necessary).
231
+If you enable profiling in more than one type of daemon, you must override
232
+it with an unique value like, the default is /var/log/swift/profile/account.profile.
233
+.IP "\fBdump_interval\fR"
234
+The profile data will be dumped to local disk based on above naming rule
235
+in this interval. The default is 5.0.
236
+.IP "\fBdump_timestamp\fR"
237
+Be careful, this option will enable profiler to dump data into the file with
238
+time stamp which means there will be lots of files piled up in the directory.
239
+The default is false
240
+.IP "\fBpath\fR"
241
+This is the path of the URL to access the mini web UI. The default is __profile__.
242
+.IP "\fBflush_at_shutdown\fR"
243
+Clear the data when the wsgi server shutdown. The default is false.
244
+.IP "\fBunwind\fR"
245
+Unwind the iterator of applications. Default is false.
246
+.RE
247
+.PD
167 248
 
168 249
 
169 250
 .SH ADDITIONAL SECTIONS
@@ -182,8 +263,8 @@ Syslog log facility. The default is LOG_LOCAL0.
182 263
 Logging level. The default is INFO.
183 264
 .IP \fBlog_address\fR
184 265
 Logging address. The default is /dev/log.
185
-.IP \fBer_diff\fR
186
-The default is 1000.
266
+.IP \fBper_diff\fR
267
+Maximum number of database rows that will be sync'd in a single HTTP replication request. The default is 1000.
187 268
 .IP \fBmax_diffs\fR
188 269
 This caps how long the replicator will spend trying to sync a given database per pass so the other databases don't get starved. The default is 100.
189 270
 .IP \fBconcurrency\fR
@@ -199,6 +280,15 @@ Connection timeout to external services. The default is 0.5 seconds.
199 280
 .IP \fBreclaim_age\fR
200 281
 Time elapsed in seconds before an container can be reclaimed. The default is
201 282
 604800 seconds.
283
+.IP \fBrsync_compress\fR
284
+Allow rsync to compress data which is transmitted to destination node
285
+during sync. However, this is applicable only when destination node is in
286
+a different region than the local one. The default is false.
287
+.IP \fBrsync_module\fR
288
+Format of the rysnc module where the replicator will send data. See
289
+etc/rsyncd.conf-sample for some usage examples.
290
+.IP \fBrecon_cache_path\fR
291
+Path to recon cache directory. The default is /var/cache/swift.
202 292
 .RE
203 293
 
204 294
 
@@ -226,6 +316,8 @@ Connection timeout to external services. The default is 0.5 seconds.
226 316
 Slowdown will sleep that amount between containers. The default is 0.01 seconds.
227 317
 .IP \fBaccount_suppression_time\fR
228 318
 Seconds to suppress updating an account that has generated an error. The default is 60 seconds.
319
+.IP \fBrecon_cache_path\fR
320
+Path to recon cache directory. The default is /var/cache/swift.
229 321
 .RE
230 322
 .PD
231 323
 
@@ -246,6 +338,8 @@ Logging address. The default is /dev/log.
246 338
 Will audit, at most, 1 container per device per interval. The default is 1800 seconds.
247 339
 .IP \fBcontainers_per_second\fR
248 340
 Maximum containers audited per second. Should be tuned according to individual system specs. 0 is unlimited. The default is 200.
341
+.IP \fBrecon_cache_path\fR
342
+Path to recon cache directory. The default is /var/cache/swift.
249 343
 .RE
250 344
 
251 345
 
@@ -268,8 +362,10 @@ If you need to use an HTTP Proxy, set it here; defaults to no proxy.
268 362
 Will audit, at most, each container once per interval. The default is 300 seconds.
269 363
 .IP \fBcontainer_time\fR
270 364
 Maximum amount of time to spend syncing each container per pass. The default is 60 seconds.
271
-.IP \fBrequest_retries\fR
272
-Server errors from requests will be retried by default.
365
+.IP \fBconn_timeout\fR
366
+Connection timeout to external services. The default is 5 seconds.
367
+.IP \fBrequest_tries\fR
368
+Server errors from requests will be retried by default. The default is 3.
273 369
 .IP \fBinternal_client_conf_path\fR
274 370
 Internal client config file path.
275 371
 .RE

+ 9
- 1
doc/manpages/dispersion.conf.5 View File

@@ -50,14 +50,22 @@ Project name in case of keystone auth version 3
50 50
 Project domain name in case of keystone auth version 3
51 51
 .IP "\fBuser_domain_name\fR"
52 52
 User domain name in case of keystone auth version 3
53
+.IP "\fBendpoint_type\fR"
54
+The default is 'publicURL'.
55
+.IP "\fBkeystone_api_insecure\fR"
56
+The default is false.
53 57
 .IP "\fBswift_dir\fR"
54 58
 Location of openstack-swift configuration and ring files
55 59
 .IP "\fBdispersion_coverage\fR"
56 60
 Percentage of partition coverage to use. The default is 1.0.
57 61
 .IP "\fBretries\fR"
58
-Maximum number of attempts
62
+Maximum number of attempts. The defaul is 5.
59 63
 .IP "\fBconcurrency\fR"
60 64
 Concurrency to use. The default is 25.
65
+.IP "\fBcontainer_populate\fR"
66
+The default is true.
67
+.IP "\fBobject_populate\fR"
68
+The default is true.
61 69
 .IP "\fBdump_json\fR"
62 70
 Whether to output in json format. The default is no.
63 71
 .IP "\fBcontainer_report\fR"

+ 71
- 0
doc/manpages/object-expirer.conf.5 View File

@@ -65,6 +65,27 @@ Syslog log facility. The default is LOG_LOCAL0.
65 65
 Logging level. The default is INFO.
66 66
 .IP \fBlog_address\fR
67 67
 Logging address. The default is /dev/log.
68
+.IP \fBlog_max_line_length\fR
69
+The following caps the length of log lines to the value given; no limit if
70
+set to 0, the default.
71
+.IP \fBlog_custom_handlers\fR
72
+Comma separated list of functions to call to setup custom log handlers.
73
+functions get passed: conf, name, log_to_console, log_route, fmt, logger,
74
+adapted_logger. The default is empty.
75
+.IP \fBlog_udp_host\fR
76
+If set, log_udp_host will override log_address.
77
+.IP "\fBlog_udp_port\fR
78
+UDP log port, the default is 514.
79
+.IP \fBlog_statsd_host\fR = localhost
80
+log_statsd_*  enable StatsD logging.
81
+.IP \fBlog_statsd_port\fR
82
+The default is 8125.
83
+.IP \fBlog_statsd_default_sample_rate\fR
84
+The default is 1.
85
+.IP \fBlog_statsd_sample_rate_factor\fR
86
+The default is 1.
87
+.IP \fBlog_statsd_metric_prefix\fR
88
+The default is empty.
68 89
 .RE
69 90
 .PD
70 91
 
@@ -126,9 +147,59 @@ Entry point for paste.deploy for the catch_errors middleware. This is the refere
126 147
 The default is \fBegg:swift#catch_errors\fR. See proxy-server.conf-sample for options or See proxy-server.conf manpage.
127 148
 .RE
128 149
 
150
+.RS 0
151
+.IP "\fB[filter:proxy-logging]\fR"
152
+.RE
153
+
154
+Logging for the proxy server now lives in this middleware.
155
+If the access_* variables are not set, logging directives from [DEFAULT]
156
+without "access_" will be used.
157
+
158
+.RS 3
159
+.IP \fBuse\fR
160
+Entry point for paste.deploy for the proxy_logging middleware. This is the reference to the installed python egg.
161
+This is normally \fBegg:swift#proxy_logging\fR. See proxy-server.conf-sample for options or See proxy-server.conf manpage.
162
+.RE
163
+
129 164
 .PD
130 165
 
131 166
 
167
+.SH ADDITIONAL SECTIONS
168
+.PD 1
169
+.RS 0
170
+The following sections are used by other swift-account services, such as replicator,
171
+auditor and reaper.
172
+.IP "\fB[account-replicator]\fR"
173
+.RE
174
+.RS 3
175
+.IP \fBinterval\fR
176
+Replaces run_pause with the more standard "interval", which means the replicator won't pause unless it takes less than the interval set. The default is 300.
177
+.IP "\fBauto_create_account_prefix\fR
178
+The default is ".".
179
+.IP \fBexpiring_objects_account_name\fR
180
+The default is 'expiring_objects'.
181
+.IP \fBreport_interval\fR
182
+The default is 300 seconds.
183
+.IP \fBconcurrency\fR
184
+Number of replication workers to spawn. The default is 1.
185
+.IP \fBprocesses\fR
186
+Processes is how many parts to divide the work into, one part per process that will be doing the work.
187
+Processes set 0 means that a single process will be doing all the work.
188
+Processes can also be specified on the command line and will override the config value.
189
+The default is 0.
190
+.IP \fBprocess\fR
191
+Process is which of the parts a particular process will work on process can also be specified
192
+on the command line and will override the config value process is "zero based", if you want
193
+to use 3 processes, you should run processes with process set to 0, 1, and 2. The default is 0.
194
+.IP \fBreclaim_age\fR
195
+The expirer will re-attempt expiring if the source object is not available
196
+up to reclaim_age seconds before it gives up and deletes the entry in the
197
+queue. The default is 604800 seconds.
198
+.IP \fBrecon_cache_path\fR
199
+Path to recon cache directory. The default is /var/cache/swift.
200
+.RE
201
+.PD
202
+
132 203
 
133 204
 .SH DOCUMENTATION
134 205
 .LP

+ 245
- 16
doc/manpages/object-server.conf.5 View File

@@ -33,7 +33,7 @@
33 33
 .SH DESCRIPTION
34 34
 .PP
35 35
 This is the configuration file used by the object server and other object
36
-background services, such as; replicator, updater and auditor.
36
+background services, such as; replicator, reconstructor, updater and auditor.
37 37
 
38 38
 The configuration file follows the python-pastedeploy syntax. The file is divided
39 39
 into sections, which are enclosed by square brackets. Each section will contain a
@@ -57,6 +57,8 @@ IP address the object server should bind to. The default is 0.0.0.0 which will m
57 57
 it bind to all available addresses.
58 58
 .IP "\fBbind_port\fR"
59 59
 TCP port the object server should bind to. The default is 6000.
60
+.IP "\fBbind_timeout\fR"
61
+Timeout to bind socket. The default is 30.
60 62
 .IP \fBbacklog\fR
61 63
 TCP backlog. Maximum number of allowed pending connections. The default value is 4096.
62 64
 .IP \fBworkers\fR
@@ -79,6 +81,17 @@ Parent directory or where devices are mounted. Default is /srv/node.
79 81
 .IP \fBmount_check\fR
80 82
 Whether or not check if the devices are mounted to prevent accidentally writing to
81 83
 the root device. The default is set to true.
84
+.IP \fBdisable_fallocate\fR
85
+Disable pre-allocate disk space for a file. The default is false.
86
+.IP \fBexpiring_objects_container_divisor\fR
87
+The default is 86400.
88
+.IP \fBexpiring_objects_account_name\fR
89
+The default is 'expiring_objects'.
90
+.IP \fBservers_per_port\fR
91
+Make object-server run this many worker processes per unique port of
92
+"local" ring devices across all storage policies.  This can help provide
93
+the isolation of threads_per_disk without the severe overhead.  The default
94
+value of 0 disables this feature.
82 95
 .IP \fBlog_name\fR
83 96
 Label used when logging. The default is swift.
84 97
 .IP \fBlog_facility\fR
@@ -87,6 +100,45 @@ Syslog log facility. The default is LOG_LOCAL0.
87 100
 Logging level. The default is INFO.
88 101
 .IP \fBlog_address\fR
89 102
 Logging address. The default is /dev/log.
103
+.IP \fBlog_max_line_length\fR
104
+The following caps the length of log lines to the value given; no limit if
105
+set to 0, the default.
106
+.IP \fBlog_custom_handlers\fR
107
+Comma separated list of functions to call to setup custom log handlers.
108
+functions get passed: conf, name, log_to_console, log_route, fmt, logger,
109
+adapted_logger. The default is empty.
110
+.IP \fBlog_udp_host\fR
111
+If set, log_udp_host will override log_address.
112
+.IP "\fBlog_udp_port\fR
113
+UDP log port, the default is 514.
114
+.IP \fBlog_statsd_host\fR = localhost
115
+log_statsd_*  enable StatsD logging.
116
+.IP \fBlog_statsd_port\fR
117
+The default is 8125.
118
+.IP \fBlog_statsd_default_sample_rate\fR
119
+The default is 1.
120
+.IP \fBlog_statsd_sample_rate_factor\fR
121
+The default is 1.
122
+.IP \fBlog_statsd_metric_prefix\fR
123
+The default is empty.
124
+.IP \fBeventlet_debug\fR
125
+Debug mode for eventlet library. The default is false.
126
+.IP \fBfallocate_reserve\fR
127
+You can set fallocate_reserve to the number of bytes you'd like fallocate to
128
+reserve, whether there is space for the given file size or not. The default is 0.
129
+.IP \fBnode_timeout\fR
130
+Request timeout to external services. The default is 3 seconds.
131
+.IP \fBconn_timeout\fR
132
+Connection timeout to external services. The default is 0.5 seconds.
133
+.IP \fBcontainer_update_timeout\fR
134
+Time to wait while sending a container update on object update. The default is 1 second.
135
+.IP \fBclient_timeout\fR
136
+Time to wait while receiving each chunk of data from a client or another
137
+backend node. The default is 60.
138
+.IP \fBnetwork_chunk_size\fR
139
+The default is 65536.
140
+.IP \fBdisk_chunk_size\fR
141
+The default is 65536.
90 142
 .RE
91 143
 .PD
92 144
 
@@ -115,22 +167,68 @@ that are acceptable within this section.
115 167
 .IP "\fBuse\fR"
116 168
 Entry point for paste.deploy for the object server. This is the reference to the installed python egg.
117 169
 This is normally \fBegg:swift#object\fR.
118
-.IP "\fBset log_name\fR
170
+.IP "\fBset log_name\fR"
119 171
 Label used when logging. The default is object-server.
120
-.IP "\fBset log_facility\fR
172
+.IP "\fBset log_facility\fR"
121 173
 Syslog log facility. The default is LOG_LOCAL0.
122
-.IP "\fB set log_level\fR
174
+.IP "\fBset log_level\fR"
123 175
 Logging level. The default is INFO.
124
-.IP "\fB set log_requests\fR
176
+.IP "\fBset log_requests\fR"
125 177
 Enables request logging. The default is True.
126
-.IP "\fB set log_address\fR
178
+.IP "\fBset log_address\fR"
127 179
 Logging address. The default is /dev/log.
128
-.IP \fBnode_timeout\fR
129
-Request timeout to external services. The default is 3 seconds.
130
-.IP \fBconn_timeout\fR
131
-Connection timeout to external services. The default is 0.5 seconds.
132
-.IP \fBcontainer_update_timeout\fR
133
-Time to wait while sending a container update on object update. The default is 1 second.
180
+.IP "\fBmax_upload_time\fR"
181
+The default is 86400.
182
+.IP "\fBslow\fR"
183
+The default is 0.
184
+.IP "\fBkeep_cache_size\fR"
185
+Objects smaller than this are not evicted from the buffercache once read. The default is 5242880.
186
+.IP "\fBkeep_cache_private\fR"
187
+If true, objects for authenticated GET requests may be kept in buffer cache
188
+if small enough. The default is false.
189
+.IP "\fBmb_per_sync\fR"
190
+On PUTs, sync data every n MB. The default is 512.
191
+.IP "\fBallowed_headers\fR"
192
+Comma separated list of headers that can be set in metadata on an object.
193
+This list is in addition to X-Object-Meta-* headers and cannot include Content-Type, etag, Content-Length, or deleted.
194
+The default is 'Content-Disposition, Content-Encoding, X-Delete-At, X-Object-Manifest, X-Static-Large-Object'.
195
+.IP "\fBauto_create_account_prefix\fR"
196
+The default is '.'.
197
+.IP "\fBthreads_per_disk\fR"
198
+A value of 0 means "don't use thread pools". A reasonable starting point is
199
+4. The default is 0.
200
+.IP "\fBreplication_server\fR"
201
+Configure parameter for creating specific server
202
+To handle all verbs, including replication verbs, do not specify
203
+"replication_server" (this is the default). To only handle replication,
204
+set to a True value (e.g. "True" or "1"). To handle only non-replication
205
+verbs, set to "False". Unless you have a separate replication network, you
206
+should not specify any value for "replication_server".
207
+.IP "\fBreplication_concurrency\fR"
208
+Set to restrict the number of concurrent incoming REPLICATION requests
209
+Set to 0 for unlimited (the default is 4). Note that REPLICATION is currently an ssync only item.
210
+.IP "\fBreplication_one_per_device\fR"
211
+Restricts incoming REPLICATION requests to one per device,
212
+replication_currency above allowing. This can help control I/O to each
213
+device, but you may wish to set this to False to allow multiple REPLICATION
214
+requests (up to the above replication_concurrency setting) per device. The default is true.
215
+.IP "\fBreplication_lock_timeout\fR"
216
+Number of seconds to wait for an existing replication device lock before
217
+giving up. The default is 15.
218
+.IP "\fBreplication_failure_threshold\fR"
219
+.IP "\fBreplication_failure_ratio\fR"
220
+These two settings control when the REPLICATION subrequest handler will
221
+abort an incoming REPLICATION attempt. An abort will occur if there are at
222
+least threshold number of failures and the value of failures / successes
223
+exceeds the ratio. The defaults of 100 and 1.0 means that at least 100
224
+failures have to occur and there have to be more failures than successes for
225
+an abort to occur.
226
+.IP "\fBsplice\fR"
227
+Use splice() for zero-copy object GETs. This requires Linux kernel
228
+version 3.0 or greater. If you set "splice = yes" but the kernel
229
+does not support it, error messages will appear in the object server
230
+logs at startup, but your object servers should continue to function.
231
+The default is false.
134 232
 .RE
135 233
 .PD
136 234
 
@@ -164,9 +262,41 @@ This is normally \fBegg:swift#recon\fR.
164 262
 The recon_cache_path simply sets the directory where stats for a few items will be stored.
165 263
 Depending on the method of deployment you may need to create this directory manually
166 264
 and ensure that swift has read/write. The default is /var/cache/swift.
265
+.IP "\fBrecon_lock_path\fR"
266
+The default is /var/lock.
167 267
 .RE
168 268
 .PD
169 269
 
270
+.RS 0
271
+.IP "\fB[filter:xprofile]\fR"
272
+.RS 3
273
+.IP "\fBuse\fR"
274
+Entry point for paste.deploy for the xprofile middleware. This is the reference to the installed python egg.
275
+This is normally \fBegg:swift#xprofile\fR.
276
+.IP "\fBprofile_module\fR"
277
+This option enable you to switch profilers which should inherit from python
278
+standard profiler. Currently the supported value can be 'cProfile', 'eventlet.green.profile' etc.
279
+.IP "\fBlog_filename_prefix\fR"
280
+This prefix will be used to combine process ID and timestamp to name the
281
+profile data file.  Make sure the executing user has permission to write
282
+into this path (missing path segments will be created, if necessary).
283
+If you enable profiling in more than one type of daemon, you must override
284
+it with an unique value like, the default is /var/log/swift/profile/account.profile.
285
+.IP "\fBdump_interval\fR"
286
+The profile data will be dumped to local disk based on above naming rule
287
+in this interval. The default is 5.0.
288
+.IP "\fBdump_timestamp\fR"
289
+Be careful, this option will enable profiler to dump data into the file with
290
+time stamp which means there will be lots of files piled up in the directory.
291
+The default is false
292
+.IP "\fBpath\fR"
293
+This is the path of the URL to access the mini web UI. The default is __profile__.
294
+.IP "\fBflush_at_shutdown\fR"
295
+Clear the data when the wsgi server shutdown. The default is false.
296
+.IP "\fBunwind\fR"
297
+Unwind the iterator of applications. Default is false.
298
+.RE
299
+.PD
170 300
 
171 301
 
172 302
 .SH ADDITIONAL SECTIONS
@@ -195,10 +325,26 @@ Time in seconds to wait between replication passes. The default is 30.
195 325
 Number of replication workers to spawn. The default is 1.
196 326
 .IP \fBstats_interval\fR
197 327
 Interval in seconds between logging replication statistics. The default is 300.
328
+.IP \fBsync_method\fR
329
+The sync method to use; default is rsync but you can use ssync to try the
330
+EXPERIMENTAL all-swift-code-no-rsync-callouts method. Once ssync is verified
331
+as having performance comparable to, or better than, rsync, we plan to
332
+deprecate rsync so we can move on with more features for replication.
198 333
 .IP \fBrsync_timeout\fR
199 334
 Max duration of a partition rsync. The default is 900 seconds.
200 335
 .IP \fBrsync_io_timeout\fR
201 336
 Passed to rsync for I/O OP timeout. The default is 30 seconds.
337
+.IP \fBrsync_compress\fR
338
+Allow rsync to compress data which is transmitted to destination node
339
+during sync. However, this is applicable only when destination node is in
340
+a different region than the local one.
341
+NOTE: Objects that are already compressed (for example: .tar.gz, .mp3) might
342
+slow down the syncing process. The default is false.
343
+.IP \fBrsync_module\fR
344
+Format of the rysnc module where the replicator will send data. See
345
+etc/rsyncd.conf-sample for some usage examples. The default is empty.
346
+.IP \fBnode_timeout\fR
347
+Request timeout to external services. The default is 10 seconds.
202 348
 .IP \fBrsync_bwlimit\fR
203 349
 Passed to rsync for bandwidth limit in kB/s.  The default is 0 (unlimited).
204 350
 .IP \fBhttp_timeout\fR
@@ -206,18 +352,87 @@ Max duration of an HTTP request. The default is 60 seconds.
206 352
 .IP \fBlockup_timeout\fR
207 353
 Attempts to kill all workers if nothing replicates for lockup_timeout seconds. The
208 354
 default is 1800 seconds.
355
+.IP \fBring_check_interval\fR
356
+The default is 15.
357
+.IP \fBrsync_error_log_line_length\fR
358
+Limits how long rsync error log lines are. 0 (default) means to log the entire line.
209 359
 .IP \fBreclaim_age\fR
210 360
 Time elapsed in seconds before an object can be reclaimed. The default is
211 361
 604800 seconds.
212
-.IP \fBrecon_enable\fR
213
-Enable logging of replication stats for recon. The default is on.
214 362
 .IP "\fBrecon_cache_path\fR"
215 363
 The recon_cache_path simply sets the directory where stats for a few items will be stored.
216 364
 Depending on the method of deployment you may need to create this directory manually
217 365
 and ensure that swift has read/write.The default is /var/cache/swift.
366
+.IP "\fBhandoffs_first\fR"
367
+The flag to replicate handoffs prior to canonical partitions.
368
+It allows to force syncing and deleting handoffs quickly.
369
+If set to a True value(e.g. "True" or "1"), partitions
370
+that are not supposed to be on the node will be replicated first.
371
+The default is false.
372
+.IP "\fBhandoff_delete\fR"
373
+The number of replicas which are ensured in swift.
374
+If the number less than the number of replicas is set, object-replicator
375
+could delete local handoffs even if all replicas are not ensured in the
376
+cluster. Object-replicator would remove local handoff partition directories
377
+after syncing partition when the number of successful responses is greater
378
+than or equal to this number. By default(auto), handoff partitions will be
379
+removed  when it has successfully replicated to all the canonical nodes.
380
+
381
+The handoffs_first and handoff_delete are options for a special case
382
+such as disk full in the cluster. These two options SHOULD NOT BE
383
+CHANGED, except for such an extreme situations. (e.g. disks filled up
384
+or are about to fill up. Anyway, DO NOT let your drives fill up).
218 385
 .RE
219 386
 
220 387
 
388
+.RS 0
389
+.IP "\fB[object-reconstructor]\fR"
390
+.RE
391
+.RS 3
392
+.IP \fBlog_name\fR
393
+Label used when logging. The default is object-reconstructor.
394
+.IP \fBlog_facility\fR
395
+Syslog log facility. The default is LOG_LOCAL0.
396
+.IP \fBlog_level\fR
397
+Logging level. The default is INFO.
398
+.IP \fBlog_address\fR
399
+Logging address. The default is /dev/log.
400
+.IP \fBdaemonize\fR
401
+Whether or not to run replication as a daemon. The default is yes.
402
+.IP "\fBrun_pause [deprecated]\fR"
403
+Time in seconds to wait between replication passes. The default is 30.
404
+.IP \fBinterval\fR
405
+Time in seconds to wait between replication passes. The default is 30.
406
+.IP \fBconcurrency\fR
407
+Number of replication workers to spawn. The default is 1.
408
+.IP \fBstats_interval\fR
409
+Interval in seconds between logging replication statistics. The default is 300.
410
+.IP \fBnode_timeout\fR
411
+Request timeout to external services. The default is 10 seconds.
412
+.IP \fBhttp_timeout\fR
413
+Max duration of an HTTP request. The default is 60 seconds.
414
+.IP \fBlockup_timeout\fR
415
+Attempts to kill all workers if nothing replicates for lockup_timeout seconds. The
416
+default is 1800 seconds.
417
+.IP \fBring_check_interval\fR
418
+The default is 15.
419
+.IP \fBreclaim_age\fR
420
+Time elapsed in seconds before an object can be reclaimed. The default is
421
+604800 seconds.
422
+.IP "\fBrecon_cache_path\fR"
423
+The recon_cache_path simply sets the directory where stats for a few items will be stored.
424
+Depending on the method of deployment you may need to create this directory manually
425
+and ensure that swift has read/write.The default is /var/cache/swift.
426
+.IP "\fBhandoffs_first\fR"
427
+The flag to replicate handoffs prior to canonical partitions.
428
+It allows to force syncing and deleting handoffs quickly.
429
+If set to a True value(e.g. "True" or "1"), partitions
430
+that are not supposed to be on the node will be replicated first.
431
+The default is false.
432
+.RE
433
+.PD
434
+
435
+
221 436
 .RS 0
222 437
 .IP "\fB[object-updater]\fR"
223 438
 .RE
@@ -236,10 +451,12 @@ Minimum time for a pass to take. The default is 300 seconds.
236 451
 Number of reaper workers to spawn. The default is 1.
237 452
 .IP \fBnode_timeout\fR
238 453
 Request timeout to external services. The default is 10 seconds.
239
-.IP \fBconn_timeout\fR
240
-Connection timeout to external services. The default is 0.5 seconds.
241 454
 .IP \fBslowdown\fR
242 455
 Slowdown will sleep that amount between objects. The default is 0.01 seconds.
456
+.IP "\fBrecon_cache_path\fR"
457
+The recon_cache_path simply sets the directory where stats for a few items will be stored.
458
+Depending on the method of deployment you may need to create this directory manually
459
+and ensure that swift has read/write. The default is /var/cache/swift.
243 460
 .RE
244 461
 .PD
245 462
 
@@ -257,16 +474,28 @@ Logging level. The default is INFO.
257 474
 .IP \fBlog_address\fR
258 475
 Logging address. The default is /dev/log.
259 476
 
477
+.IP \fBdisk_chunk_size\fR
478
+The default is 65536.
260 479
 .IP \fBfiles_per_second\fR
261 480
 Maximum files audited per second. Should be tuned according to individual
262 481
 system specs. 0 is unlimited. The default is 20.
263 482
 .IP \fBbytes_per_second\fR
264 483
 Maximum bytes audited per second. Should be tuned according to individual
265 484
 system specs. 0 is unlimited. The default is 10000000.
485
+.IP \fBconcurrency\fR
486
+Number of reaper workers to spawn. The default is 1.
266 487
 .IP \fBlog_time\fR
267 488
 The default is 3600 seconds.
268 489
 .IP \fBzero_byte_files_per_second\fR
269 490
 The default is 50.
491
+.IP "\fBrecon_cache_path\fR"
492
+The recon_cache_path simply sets the directory where stats for a few items will be stored.
493
+Depending on the method of deployment you may need to create this directory manually
494
+and ensure that swift has read/write. The default is /var/cache/swift.
495
+.IP \fBobject_size_stats\fR
496
+Takes a comma separated list of ints. If set, the object auditor will
497
+increment a counter for every object whose size is <= to the given break
498
+points and report the result after a full scan.
270 499
 .RE
271 500
 
272 501
 

+ 516
- 31
doc/manpages/proxy-server.conf.5 View File

@@ -56,8 +56,21 @@ IP address the proxy server should bind to. The default is 0.0.0.0 which will ma
56 56
 it bind to all available addresses.
57 57
 .IP "\fBbind_port\fR"
58 58
 TCP port the proxy server should bind to. The default is 80.
59
+.IP "\fBbind_timeout\fR"
60
+Timeout to bind socket. The default is 30.
59 61
 .IP \fBbacklog\fR
60 62
 TCP backlog.  Maximum number of allowed pending connections. The default value is 4096.
63
+.IP \fBadmin_key\fR
64
+Key to use for admin calls that are HMAC signed.  Default is empty,
65
+which will disable admin calls to /info.
66
+.IP \fBdisallowed_sections\fR
67
+Allows the ability to withhold sections from showing up in the public calls
68
+to /info.  You can withhold subsections by separating the dict level with a
69
+".".  The following would cause the sections 'container_quotas' and 'tempurl'
70
+to not be listed, and the key max_failed_deletes would be removed from
71
+bulk_delete.  Default value is 'swift.valid_api_versions' which allows all
72
+registered features to be listed via HTTP GET /info except
73
+swift.valid_api_versions information
61 74
 .IP \fBworkers\fR
62 75
 The number of pre-forked processes that will accept connections.  Zero means
63 76
 no fork.  The default is auto which will make the server try to match the
@@ -71,6 +84,8 @@ actually accept(2) N + 1). Setting this to one (1) will only handle one request
71 84
 at a time, without accepting another request concurrently.  The default is 1024.
72 85
 .IP \fBuser\fR
73 86
 The system user that the proxy server will run as. The default is swift.
87
+.IP \fBexpose_info\fR
88
+Enables exposing configuration settings via HTTP GET /info. The default is true.
74 89
 .IP \fBswift_dir\fR
75 90
 Swift configuration directory. The default is /etc/swift.
76 91
 .IP \fBcert_file\fR
@@ -79,6 +94,10 @@ disabled by default.
79 94
 .IP \fBkey_file\fR
80 95
 Location of the SSL certificate key file. The default path is /etc/swift/proxy.key. This is
81 96
 disabled by default.
97
+.IP \fBexpiring_objects_container_divisor\fR
98
+The default is 86400.
99
+.IP \fBexpiring_objects_account_name\fR
100
+The default is 'expiring_objects'.
82 101
 .IP \fBlog_name\fR
83 102
 Label used when logging. The default is swift.
84 103
 .IP \fBlog_facility\fR
@@ -87,10 +106,41 @@ Syslog log facility. The default is LOG_LOCAL0.
87 106
 Logging level. The default is INFO.
88 107
 .IP \fBlog_address\fR
89 108
 Logging address. The default is /dev/log.
109
+.IP \fBlog_max_line_length\fR
110
+To cap the length of log lines to the value given. No limit if set to 0, the default.
111
+.IP \fBlog_headers\fR
112
+The default is false.
113
+.IP \fBlog_custom_handlers\fR
114
+Comma separated list of functions to call to setup custom log handlers.
115
+functions get passed: conf, name, log_to_console, log_route, fmt, logger,
116
+adapted_logger. The default is empty.
117
+.IP \fBlog_udp_host\fR
118
+If set, log_udp_host will override log_address.
119
+.IP "\fBlog_udp_port\fR
120
+UDP log port, the default is 514.
121
+.IP \fBlog_statsd_host\fR = localhost
122
+log_statsd_*  enable StatsD logging.
123
+.IP \fBlog_statsd_port\fR
124
+The default is 8125.
125
+.IP \fBlog_statsd_default_sample_rate\fR
126
+The default is 1.
127
+.IP \fBlog_statsd_sample_rate_factor\fR
128
+The default is 1.
129
+.IP \fBlog_statsd_metric_prefix\fR
130
+The default is empty.
131
+.IP \fBclient_timeout\fR
132
+Time to wait while receiving each chunk of data from a client or another
133
+backend node. The default is 60.
134
+.IP \fBeventlet_debug\fR
135
+Debug mode for eventlet library. The default is false.
90 136
 .IP \fBtrans_id_suffix\fR
91 137
 This optional suffix (default is empty) that would be appended to the swift transaction
92 138
 id allows one to easily figure out from which cluster that X-Trans-Id belongs to.
93 139
 This is very useful when one is managing more than one swift cluster.
140
+.IP \fBcors_allow_origin\fR
141
+Use a comma separated list of full url (http://foo.bar:1234,https://foo.bar)
142
+.IP \fBstrict_cors_mode\fR
143
+The default is true.
94 144
 .RE
95 145
 .PD
96 146
 
@@ -104,8 +154,13 @@ are acceptable within this section.
104 154
 
105 155
 .IP "\fBpipeline\fR"
106 156
 It is used when you need apply a number of filters. It is a list of filters
107
-ended by an application. The normal pipeline is "catch_errors healthcheck
108
-cache ratelimit tempauth proxy-logging proxy-server".
157
+ended by an application. The normal pipeline is "catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk tempurl ratelimit tempauth container-quotas account-quotas slo dlo versioned_writes proxy-logging proxy-server".
158
+
159
+Note: The double proxy-logging in the pipeline is not a mistake. The
160
+left-most proxy-logging is there to log requests that were handled in
161
+middleware and never made it through to the right-most middleware (and
162
+proxy server). Double logging is prevented for normal requests. See
163
+proxy-logging docs.
109 164
 .RE
110 165
 .PD
111 166
 
@@ -127,6 +182,7 @@ This is normally \fBegg:swift#healthcheck\fR.
127 182
 An optional filesystem path which, if present, will cause the healthcheck
128 183
 URL to return "503 Service Unavailable" with a body of "DISABLED BY FILE".
129 184
 .RE
185
+.PD
130 186
 
131 187
 
132 188
 .RS 0
@@ -154,11 +210,28 @@ systems are in use for one Swift cluster. The default is AUTH.
154 210
 .IP \fBauth_prefix\fR
155 211
 The auth prefix will cause requests beginning with this prefix to be routed
156 212
 to the auth subsystem, for granting tokens, etc. The default is /auth/.
213
+.IP \fBrequire_group\fR
214
+The require_group parameter names a group that must be presented by
215
+either X-Auth-Token or X-Service-Token. Usually this parameter is
216
+used only with multiple reseller prefixes (e.g., SERVICE_require_group=blah).
217
+By default, no group is needed. Do not use .admin.
157 218
 .IP \fBtoken_life\fR
158 219
 This is the time in seconds before the token expires. The default is 86400.
220
+.IP \fBallow_overrides\fR
221
+This allows middleware higher in the WSGI pipeline to override auth
222
+processing, useful for middleware such as tempurl and formpost. If you know
223
+you're not going to use such middleware and you want a bit of extra security,
224
+you can set this to false. The default is true.
225
+.IP \fBstorage_url_scheme\fR
226
+This specifies what scheme to return with storage urls:
227
+http, https, or default (chooses based on what the server is running as)
228
+This can be useful with an SSL load balancer in front of a non-SSL server.
159 229
 .IP \fBuser_<account>_<user>\fR
160 230
 Lastly, you need to list all the accounts/users you want here. The format is:
161 231
 user_<account>_<user> = <key> [group] [group] [...] [storage_url]
232
+or if you want underscores in <account> or <user>, you can base64 encode them
233
+(with no equal signs) and use this format:
234
+user64_<account_b64>_<user_b64> = <key> [group] [group] [...] [storage_url]
162 235
 
163 236
 There are special groups of: \fI.reseller_admin\fR who can do anything to any account for this auth
164 237
 and also \fI.admin\fR who can do anything within the account.
@@ -184,6 +257,107 @@ Here are example entries, required for running the tests:
184 257
 .RE
185 258
 .PD
186 259
 
260
+.RS 0
261
+.IP "\fB[filter:authtoken]\fR"
262
+.RE
263
+
264
+To enable Keystone authentication you need to have the auth token
265
+middleware first to be configured. Here is an example below, please
266
+refer to the keystone's documentation for details about the
267
+different settings.
268
+
269
+You'll need to have as well the keystoneauth middleware enabled
270
+and have it in your main pipeline so instead of having tempauth in
271
+there you can change it to: authtoken keystoneauth
272
+
273
+.PD 0
274
+.RS 10
275
+.IP "paste.filter_factory = keystonemiddleware.auth_token:filter_factory"
276
+.IP "identity_uri = http://keystonehost:35357/"
277
+.IP "auth_uri = http://keystonehost:5000/"
278
+.IP "admin_tenant_name = service"
279
+.IP "admin_user = swift"
280
+.IP "admin_password = password"
281
+.IP ""
282
+.IP "# delay_auth_decision defaults to False, but leaving it as false will"
283
+.IP "# prevent other auth systems, staticweb, tempurl, formpost, and ACLs from"
284
+.IP "# working. This value must be explicitly set to True."
285
+.IP "delay_auth_decision = False"
286
+.IP
287
+.IP "cache = swift.cache"
288
+.IP "include_service_catalog = False"
289
+.RE
290
+.PD
291
+
292
+
293
+.RS 0
294
+.IP "\fB[filter:keystoneauth]\fR"
295
+.RE
296
+
297
+Keystone authentication middleware.
298
+
299
+.RS 3
300
+.IP \fBuse\fR
301
+Entry point for paste.deploy for the keystoneauth middleware. This is the reference to the installed python egg.
302
+This is normally \fBegg:swift#keystoneauth\fR.
303
+.IP \fBreseller_prefix\fR
304
+The reseller_prefix option lists account namespaces that this middleware is
305
+responsible for. The prefix is placed before the Keystone project id.
306
+For example, for project 12345678, and prefix AUTH, the account is
307
+named AUTH_12345678 (i.e., path is /v1/AUTH_12345678/...).
308
+Several prefixes are allowed by specifying a comma-separated list
309
+as in: "reseller_prefix = AUTH, SERVICE". The empty string indicates a
310
+single blank/empty prefix. If an empty prefix is required in a list of
311
+prefixes, a value of '' (two single quote characters) indicates a
312
+blank/empty prefix. Except for the blank/empty prefix, an underscore ('_')
313
+character is appended to the value unless already present.
314
+.IP \fBoperator_roles\fR
315
+The user must have at least one role named by operator_roles on a
316
+project in order to create, delete and modify containers and objects
317
+and to set and read privileged headers such as ACLs.
318
+If there are several reseller prefix items, you can prefix the
319
+parameter so it applies only to those accounts (for example
320
+the parameter SERVICE_operator_roles applies to the /v1/SERVICE_<project>
321
+path). If you omit the prefix, the option applies to all reseller
322
+prefix items. For the blank/empty prefix, prefix with '' (do not put
323
+underscore after the two single quote characters).
324
+.IP \fBreseller_admin_role\fR
325
+The reseller admin role has the ability to create and delete accounts.
326
+.IP \fBallow_overrides\fR
327
+This allows middleware higher in the WSGI pipeline to override auth
328
+processing, useful for middleware such as tempurl and formpost. If you know
329
+you're not going to use such middleware and you want a bit of extra security,
330
+you can set this to false.
331
+.IP \fBis_admin [DEPRECATED]\fR
332
+If is_admin is true, a user whose username is the same as the project name
333
+and who has any role on the project will have access rights elevated to be
334
+the same as if the user had an operator role. Note that the condition
335
+compares names rather than UUIDs. This option is deprecated.
336
+.IP \fBservice_roles\fR
337
+If the service_roles parameter is present, an X-Service-Token must be
338
+present in the request that when validated, grants at least one role listed
339
+in the parameter. The X-Service-Token may be scoped to any project.
340
+If there are several reseller prefix items, you can prefix the
341
+parameter so it applies only to those accounts (for example
342
+the parameter SERVICE_service_roles applies to the /v1/SERVICE_<project>
343
+path). If you omit the prefix, the option applies to all reseller
344
+prefix items. For the blank/empty prefix, prefix with '' (do not put
345
+underscore after the two single quote characters).
346
+By default, no service_roles are required.
347
+.IP \fBdefault_domain_id\fR
348
+For backwards compatibility, keystoneauth will match names in cross-tenant
349
+access control lists (ACLs) when both the requesting user and the tenant
350
+are in the default domain i.e the domain to which existing tenants are
351
+migrated. The default_domain_id value configured here should be the same as
352
+the value used during migration of tenants to keystone domains.
353
+.IP \fBallow_names_in_acls\fR
354
+For a new installation, or an installation in which keystone projects may
355
+move between domains, you should disable backwards compatible name matching
356
+in ACLs by setting allow_names_in_acls to false:
357
+.RE
358
+.PD
359
+
360
+
187 361
 .RS 0
188 362
 .IP "\fB[filter:cache]\fR"
189 363
 .RE
@@ -202,8 +376,10 @@ Syslog log facility. The default is LOG_LOCAL0.
202 376
 Logging level. The default is INFO.
203 377
 .IP "\fBset log_address\fR"
204 378
 Logging address. The default is /dev/log.
205
-.IP "\fBset log_headers\fR "
379
+.IP "\fBset log_headers\fR"
206 380
 Enables the ability to log request headers. The default is False.
381
+.IP \fBmemcache_max_connections\fR
382
+Sets the maximum number of connections to each memcached server per worker.
207 383
 .IP \fBmemcache_servers\fR
208 384
 If not set in the configuration file, the value for memcache_servers will be
209 385
 read from /etc/swift/memcache.conf (see memcache.conf-sample) or lacking that
@@ -225,7 +401,7 @@ To avoid an instant full cache flush, existing installations should upgrade with
225 401
 
226 402
 If not set in the configuration file, the value for memcache_serialization_support will be read from /etc/swift/memcache.conf if it exists (see memcache.conf-sample). Otherwise, the default value as indicated above will be used.
227 403
 .RE
228
-
404
+.PD
229 405
 
230 406
 
231 407
 .RS 0
@@ -268,14 +444,20 @@ in requests per second. If set to 0 means disabled. The default is 0.
268 444
 .IP \fBcontainer_ratelimit_size\fR
269 445
 When set with container_limit_x = r: for containers of size x, limit requests per second
270 446
 to r. Will limit PUT, DELETE, and POST requests to /a/c/o. The default is ''.
447
+.IP \fBcontainer_listing_ratelimit_size\fR
448
+Similarly to the above container-level write limits, the following will limit
449
+container GET (listing) requests.
271 450
 .RE
451
+.PD
452
+
272 453
 
273 454
 
274 455
 .RS 0
275 456
 .IP "\fB[filter:domain_remap]\fR"
276 457
 .RE
277 458
 
278
-Middleware that translates container and account parts of a domain to path parameters that the proxy server understands. The container.account.storageurl/object gets translated to container.account.storageurl/path_root/account/container/object and account.storageurl/path_root/container/object gets translated to account.storageurl/path_root/account/container/object
459
+Middleware that translates container and account parts of a domain to path parameters that the proxy server understands.
460
+The container.account.storageurl/object gets translated to container.account.storageurl/path_root/account/container/object and account.storageurl/path_root/container/object gets translated to account.storageurl/path_root/account/container/object
279 461
 
280 462
 .RS 3
281 463
 .IP \fBuse\fR
@@ -283,9 +465,13 @@ Entry point for paste.deploy for the domain_remap middleware. This is the refere
283 465
 This is normally \fBegg:swift#domain_remap\fR.
284 466
 .IP "\fBset log_name\fR"
285 467
 Label used when logging. The default is domain_remap.
468
+.IP "\fBset log_facility\fR"
469
+Syslog log facility. The default is LOG_LOCAL0.
470
+.IP "\fBset log_level\fR "
471
+Logging level. The default is INFO.
286 472
 .IP "\fBset log_address\fR"
287 473
 Logging address. The default is /dev/log.
288
-.IP "\fBset log_headers\fR"
474
+.IP "\fBset log_headers\fR "
289 475
 Enables the ability to log request headers. The default is False.
290 476
 .IP \fBstorage_domain\fR
291 477
 The domain to be used by the middleware.
@@ -304,7 +490,7 @@ Defaults to 'AUTH'.
304 490
 The default reseller prefix. This is used when none of the configured
305 491
 reseller_prefixes match. When not set, no reseller prefix is added.
306 492
 .RE
307
-
493
+.PD
308 494
 
309 495
 
310 496
 .RS 0
@@ -325,7 +511,7 @@ Logging address. The default is /dev/log.
325 511
 .IP "\fBset log_headers\fR"
326 512
 Enables the ability to log request headers. The default is False.
327 513
 .RE
328
-
514
+.PD
329 515
 
330 516
 
331 517
 .RS 0
@@ -354,7 +540,7 @@ The domain to be used by the middleware.
354 540
 How deep in the CNAME chain to look for something that matches the storage domain.
355 541
 The default is 1.
356 542
 .RE
357
-
543
+.PD
358 544
 
359 545
 
360 546
 .RS 0
@@ -367,8 +553,6 @@ Note: Put staticweb just after your auth filter(s) in the pipeline
367 553
 .IP \fBuse\fR
368 554
 Entry point for paste.deploy for the staticweb middleware. This is the reference to the installed python egg.
369 555
 This is normally \fBegg:swift#staticweb\fR.
370
-.IP \fBcache_timeout\fR
371
-Seconds to cache container x-container-meta-web-* header values. The default is 300 seconds.
372 556
 .IP "\fBset log_name\fR"
373 557
 Label used when logging. The default is staticweb.
374 558
 .IP "\fBset log_facility\fR"
@@ -379,14 +563,8 @@ Logging level. The default is INFO.
379 563
 Logging address. The default is /dev/log.
380 564
 .IP "\fBset log_headers\fR"
381 565
 Enables the ability to log request headers. The default is False.
382
-.IP "\fBset access_log_name\fR"
383
-Label used when logging. The default is staticweb.
384
-.IP "\fBset access_log_facility\fR"
385
-Syslog log facility. The default is LOG_LOCAL0.
386
-.IP "\fBset access_log_level\fR "
387
-Logging level. The default is INFO.
388 566
 .RE
389
-
567
+.PD
390 568
 
391 569
 
392 570
 .RS 0
@@ -396,6 +574,11 @@ Logging level. The default is INFO.
396 574
 Note: Put tempurl before slo, dlo, and your auth filter(s) in the pipeline
397 575
 
398 576
 .RS 3
577
+.IP \fBuse\fR
578
+Entry point for paste.deploy for the tempurl middleware. This is the reference to the installed python egg.
579
+This is normally \fBegg:swift#tempurl\fR.
580
+.IP \fBmethods\fR
581
+The methods allowed with Temp URLs. The default is 'GET HEAD PUT POST DELETE'.
399 582
 .IP \fBincoming_remove_headers\fR
400 583
 The headers to remove from incoming requests. Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match. incoming_allow_headers is a list of exceptions to these removals.
401 584
 .IP \fBincoming_allow_headers\fR
@@ -404,9 +587,8 @@ The headers allowed as exceptions to incoming_remove_headers. Simply a whitespac
404 587
 The headers to remove from outgoing responses. Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match. outgoing_allow_headers is a list of exceptions to these removals.
405 588
 .IP "\fBoutgoing_allow_headers\fR"
406 589
 The headers allowed as exceptions to outgoing_remove_headers. Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match.
407
-.IP "\fBset log_level\fR "
408 590
 .RE
409
-
591
+.PD
410 592
 
411 593
 
412 594
 .RS 0
@@ -420,6 +602,7 @@ Note: Put formpost just before your auth filter(s) in the pipeline
420 602
 Entry point for paste.deploy for the formpost middleware. This is the reference to the installed python egg.
421 603
 This is normally \fBegg:swift#formpost\fR.
422 604
 .RE
605
+.PD
423 606
 
424 607
 
425 608
 
@@ -434,12 +617,25 @@ Note: Just needs to be placed before the proxy-server in the pipeline.
434 617
 Entry point for paste.deploy for the name_check middleware. This is the reference to the installed python egg.
435 618
 This is normally \fBegg:swift#name_check\fR.
436 619
 .IP \fBforbidden_chars\fR
437
-Characters that will not be allowed in a name.
620
+Characters that will not be allowed in a name. The default is '"`<>.
438 621
 .IP \fBmaximum_length\fR
439
-Maximum number of characters that can be in the name.
622
+Maximum number of characters that can be in the name. The default is 255.
440 623
 .IP \fBforbidden_regexp\fR
441
-Python regular expressions of substrings that will not be allowed in a name.
624
+Python regular expressions of substrings that will not be allowed in a name. The default is /\./|/\.\./|/\.$|/\.\.$.
442 625
 .RE
626
+.PD
627
+
628
+
629
+.RS 0
630
+.IP "\fB[filter:list-endpoints]\fR"
631
+.RS 3
632
+.IP \fBuse\fR
633
+Entry point for paste.deploy for the list_endpoints middleware. This is the reference to the installed python egg.
634
+This is normally \fBegg:swift#list_endpoints\fR.
635
+.IP \fBlist_endpoints_path\fR
636
+The default is '/endpoints/'.
637
+.RE
638
+.PD
443 639
 
444 640
 
445 641
 .RS 0
@@ -474,20 +670,249 @@ Default is localhost.
474 670
 Default is 8125.
475 671
 .IP \fBaccess_log_statsd_default_sample_rate\fR
476 672
 Default is 1.
673
+.IP \fBaccess_log_statsd_sample_rate_factor\fR
674
+The default is 1.
477 675
 .IP \fBaccess_log_statsd_metric_prefix\fR
478 676
 Default is "" (empty-string)
479 677
 .IP \fBaccess_log_headers\fR
480 678
 Default is False.
679
+.IP \fBaccess_log_headers_only\fR
680
+If access_log_headers is True and access_log_headers_only is set only
681
+these headers are logged. Multiple headers can be defined as comma separated
682
+list like this: access_log_headers_only = Host, X-Object-Meta-Mtime
683
+.IP \fBreveal_sensitive_prefix\fR
684
+By default, the X-Auth-Token is logged. To obscure the value,
685
+set reveal_sensitive_prefix to the number of characters to log.
686
+For example, if set to 12, only the first 12 characters of the
687
+token appear in the log. An unauthorized access of the log file
688
+won't allow unauthorized usage of the token. However, the first
689
+12 or so characters is unique enough that you can trace/debug
690
+token usage. Set to 0 to suppress the token completely (replaced
691
+by '...' in the log). The default is 16 chars.
692
+Note: reveal_sensitive_prefix will not affect the value logged with access_log_headers=True.
481 693
 .IP \fBlog_statsd_valid_http_methods\fR
482 694
 What HTTP methods are allowed for StatsD logging (comma-sep); request methods
483 695
 not in this list will have "BAD_METHOD" for the <verb> portion of the metric.
484 696
 Default is "GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS".
485 697
 .RE
698
+.PD
699
+
700
+
701
+.RS 0
702
+.IP "\fB[filter:bulk]\fR"
703
+.RE
704
+
705
+Note: Put before both ratelimit and auth in the pipeline.
706
+
707
+.RS 3
708
+.IP \fBuse\fR
709
+Entry point for paste.deploy for the bulk middleware. This is the reference to the installed python egg.
710
+This is normally \fBegg:swift#bulk\fR.
711
+.IP \fBmax_containers_per_extraction\fR
712
+The default is 10000.
713
+.IP \fBmax_failed_extractions\fR
714
+The default is 1000.
715
+.IP \fBmax_deletes_per_request\fR
716
+The default is 10000.
717
+.IP \fBmax_failed_deletes\fR
718
+The default is 1000.
719
+
720
+In order to keep a connection active during a potentially long bulk request,
721
+Swift may return whitespace prepended to the actual response body. This
722
+whitespace will be yielded no more than every yield_frequency seconds.
723
+The default is 10.
724
+.IP \fByield_frequency\fR
725
+
726
+.IP \fBdelete_container_retry_count\fR
727
+Note: This parameter is used during a bulk delete of objects and
728
+their container. This would frequently fail because it is very likely
729
+that all replicated objects have not been deleted by the time the middleware got a
730
+successful response. It can be configured the number of retries. And the
731
+number of seconds to wait between each retry will be 1.5**retry
732
+The default is 0.
733
+.RE
734
+.PD
735
+
736
+
737
+.RS 0
738
+.IP "\fB[filter:slo]\fR"
739
+.RE
740
+
741
+Note: Put after auth and staticweb in the pipeline.
742
+
743
+.RS 3
744
+.IP \fBuse\fR
745
+Entry point for paste.deploy for the slo middleware. This is the reference to the installed python egg.
746
+This is normally \fBegg:swift#slo\fR.
747
+.IP \fBmax_manifest_segments\fR
748
+The default is 1000.
749
+.IP \fBmax_manifest_size\fR
750
+The default is 2097152.
751
+.IP \fBmin_segment_size\fR
752
+The default is 1048576
753
+.IP \fBrate_limit_after_segment\fR
754
+Start rate-limiting object segments after the Nth segment of a segmented
755
+object. The default is 10 segments.
756
+.IP \fBrate_limit_segments_per_sec\fR
757
+Once segment rate-limiting kicks in for an object, limit segments served to N
758
+per second. The default is 1.
759
+.IP \fBmax_get_time\fR
760
+Time limit on GET requests (seconds). The default is 86400.
761
+.RE
762
+.PD
763
+
764
+
765
+.RS 0
766
+.IP "\fB[filter:dlo]\fR"
767
+.RE
768
+
769
+Note: Put after auth and staticweb in the pipeline.
770
+If you don't put it in the pipeline, it will be inserted for you.
771
+
772
+.RS 3
773
+.IP \fBuse\fR
774
+Entry point for paste.deploy for the dlo middleware. This is the reference to the installed python egg.
775
+This is normally \fBegg:swift#dlo\fR.
776
+.IP \fBrate_limit_after_segment\fR
777
+Start rate-limiting object segments after the Nth segment of a segmented
778
+object. The default is 10 segments.
779
+.IP \fBrate_limit_segments_per_sec\fR
780
+Once segment rate-limiting kicks in for an object, limit segments served to N
781
+per second. The default is 1.
782
+.IP \fBmax_get_time\fR
783
+Time limit on GET requests (seconds). The default is 86400.
784
+.RE
785
+.PD
786
+
787
+
788
+.RS 0
789
+.IP "\fB[filter:container-quotas]\fR"
790
+.RE
791
+
792
+Note: Put after auth in the pipeline.
793
+
794
+.RS 3
795
+.IP \fBuse\fR
796
+Entry point for paste.deploy for the container_quotas middleware. This is the reference to the installed python egg.
797
+This is normally \fBegg:swift#container_quotas\fR.
798
+.RE
799
+.PD
486 800
 
487 801
 
802
+.RS 0
803
+.IP "\fB[filter:account-quotas]\fR"
804
+.RE
805
+
806
+Note: Put after auth in the pipeline.
807
+
808
+.RS 3
809
+.IP \fBuse\fR
810
+Entry point for paste.deploy for the account_quotas middleware. This is the reference to the installed python egg.
811
+This is normally \fBegg:swift#account_quotas\fR.
812
+.RE
488 813
 .PD
489 814
 
490 815
 
816
+.RS 0
817
+.IP "\fB[filter:gatekeeper]\fR"
818
+.RE
819
+
820
+Note: this middleware requires python-dnspython
821
+
822
+.RS 3
823
+.IP \fBuse\fR
824
+Entry point for paste.deploy for the gatekeeper middleware. This is the reference to the installed python egg.
825
+This is normally \fBegg:swift#gatekeeper\fR.
826
+.IP "\fBset log_name\fR"
827
+Label used when logging. The default is gatekeeper.
828
+.IP "\fBset log_facility\fR"
829
+Syslog log facility. The default is LOG_LOCAL0.
830
+.IP "\fBset log_level\fR "
831
+Logging level. The default is INFO.
832
+.IP "\fBset log_address\fR"
833
+Logging address. The default is /dev/log.
834
+.IP "\fBset log_headers\fR"
835
+Enables the ability to log request headers. The default is False.
836
+.RE
837
+.PD
838
+
839
+
840
+.RS 0
841
+.IP "\fB[filter:container_sync]\fR"
842
+.RE
843
+
844
+Note: this middleware requires python-dnspython
845
+
846
+.RS 3
847
+.IP \fBuse\fR
848
+Entry point for paste.deploy for the container_sync middleware. This is the reference to the installed python egg.
849
+This is normally \fBegg:swift#container_sync\fR.
850
+.IP \fBallow_full_urls\fR
851
+Set this to false if you want to disallow any full url values to be set for
852
+any new X-Container-Sync-To headers. This will keep any new full urls from
853
+coming in, but won't change any existing values already in the cluster.
854
+Updating those will have to be done manually, as knowing what the true realm
855
+endpoint should be cannot always be guessed. The default is true.
856
+.IP \fBcurrent\fR
857
+Set this to specify this clusters //realm/cluster as "current" in /info
858
+.RE
859
+.PD
860
+
861
+
862
+.RS 0
863
+.IP "\fB[filter:xprofile]\fR"
864
+.RE
865
+
866
+Note: Put it at the beginning of the pipeline to profile all middleware. But it is safer to put this after healthcheck.
867
+
868
+.RS 3
869
+.IP "\fBuse\fR"
870
+Entry point for paste.deploy for the xprofile middleware. This is the reference to the installed python egg.
871
+This is normally \fBegg:swift#xprofile\fR.
872
+.IP "\fBprofile_module\fR"
873
+This option enable you to switch profilers which should inherit from python
874
+standard profiler. Currently the supported value can be 'cProfile', 'eventlet.green.profile' etc.
875
+.IP "\fBlog_filename_prefix\fR"
876
+This prefix will be used to combine process ID and timestamp to name the
877
+profile data file.  Make sure the executing user has permission to write
878
+into this path (missing path segments will be created, if necessary).
879
+If you enable profiling in more than one type of daemon, you must override
880
+it with an unique value like, the default is /var/log/swift/profile/account.profile.
881
+.IP "\fBdump_interval\fR"
882
+The profile data will be dumped to local disk based on above naming rule
883
+in this interval. The default is 5.0.
884
+.IP "\fBdump_timestamp\fR"
885
+Be careful, this option will enable profiler to dump data into the file with
886
+time stamp which means there will be lots of files piled up in the directory.
887
+The default is false
888
+.IP "\fBpath\fR"
889
+This is the path of the URL to access the mini web UI. The default is __profile__.
890
+.IP "\fBflush_at_shutdown\fR"
891
+Clear the data when the wsgi server shutdown. The default is false.
892
+.IP "\fBunwind\fR"
893
+Unwind the iterator of applications. Default is false.
894
+.RE
895
+.PD
896
+
897
+
898
+.RS 0
899
+.IP "\fB[filter:versioned_writes]\fR"
900
+.RE
901
+
902
+Note: Put after slo, dlo in the pipeline.
903
+If you don't put it in the pipeline, it will be inserted automatically.
904
+
905
+.RS 3
906
+.IP \fBuse\fR
907
+Entry point for paste.deploy for the versioned_writes middleware. This is the reference to the installed python egg.
908
+This is normally \fBegg:swift#versioned_writes\fR.
909
+.IP \fBallow_versioned_writes\fR
910
+Enables using versioned writes middleware and exposing configuration settings via HTTP GET /info.
911
+WARNING: Setting this option bypasses the "allow_versions" option
912
+in the container configuration file, which will be eventually
913
+deprecated. See documentation for more details.
914
+.RE
915
+.PD
491 916
 
492 917
 
493 918
 .SH APP SECTION
@@ -518,10 +943,19 @@ Chunk size to read from object servers. The default is 8192.
518 943
 Chunk size to read from clients. The default is 8192.
519 944
 .IP \fBnode_timeout\fR
520 945
 Request timeout to external services. The default is 10 seconds.
521
-.IP \fBclient_timeout\fR
522
-Timeout to read one chunk from a client. The default is 60 seconds.
946
+.IP \fBrecoverable_node_timeout\fR
947
+How long the proxy server will wait for an initial response and to read a
948
+chunk of data from the object servers while serving GET / HEAD requests.
949
+Timeouts from these requests can be recovered from so setting this to
950
+something lower than node_timeout would provide quicker error recovery
951
+while allowing for a longer timeout for non-recoverable requests (PUTs).
952
+Defaults to node_timeout, should be overriden if node_timeout is set to a
953
+high number to prevent client timeouts from firing before the proxy server
954
+has a chance to retry.
523 955
 .IP \fBconn_timeout\fR
524 956
 Connection timeout to external services. The default is 0.5 seconds.
957
+.IP \fBpost_quorum_timeout\fR
958
+How long to wait for requests to finish after a quorum has been established. The default is 0.5 seconds.
525 959
 .IP \fBerror_suppression_interval\fR
526 960
 Time in seconds that must elapse since the last error for a node to
527 961
 be considered no longer error limited. The default is 60 seconds.
@@ -539,12 +973,63 @@ container sync won't be able to sync posts. The default is True.
539 973
 .IP \fBaccount_autocreate\fR
540 974
 If set to 'true' authorized accounts that do not yet exist within the Swift cluster
541 975
 will be automatically created. The default is set to false.
542
-.IP \fBrate_limit_after_segment\fR
543
-Start rate-limiting object segments after the Nth segment of a segmented
544
-object.  The default is 10 segments.
545
-.IP \fBrate_limit_segments_per_sec\fR
546
-Once segment rate-limiting kicks in for an object, limit segments served to N
547
-per second.  The default is 1.
976
+.IP \fBauto_create_account_prefix\fR
977
+Prefix used when automatically creating accounts. The default is '.'.
978
+.IP \fBmax_containers_per_account\fR
979
+If set to a positive value, trying to create a container when the account
980
+already has at least this maximum containers will result in a 403 Forbidden.
981
+Note: This is a soft limit, meaning a user might exceed the cap for
982
+recheck_account_existence before the 403s kick in.
983
+.IP \fBmax_containers_whitelist\fR
984
+This is a comma separated list of account hashes that ignore the max_containers_per_account cap.
985
+.IP \fBdeny_host_headers\fR
986
+Comma separated list of Host headers to which the proxy will deny requests. The default is empty.
987
+.IP \fBput_queue_depth\fR
988
+Depth of the proxy put queue. The default is 10.
989
+.IP \fBsorting_method\fR
990
+Storage nodes can be chosen at random (shuffle - default), by using timing
991
+measurements (timing), or by using an explicit match (affinity).
992
+Using timing measurements may allow for lower overall latency, while
993
+using affinity allows for finer control. In both the timing and
994
+affinity cases, equally-sorting nodes are still randomly chosen to
995
+spread load.
996
+The valid values for sorting_method are "affinity", "shuffle", and "timing".
997
+.IP \fBtiming_expiry\fR
998
+If the "timing" sorting_method is used, the timings will only be valid for
999
+the number of seconds configured by timing_expiry. The default is 300.
1000
+.IP \fBmax_large_object_get_time\fR
1001
+The maximum time (seconds) that a large object connection is allowed to last. The default is 86400.
1002
+.IP \fBrequest_node_count\fR
1003
+Set to the number of nodes to contact for a normal request. You can use
1004
+'* replicas' at the end to have it use the number given times the number of
1005
+replicas for the ring being used for the request. The default is '2 * replicas'.
1006
+.IP \fBread_affinity\fR
1007
+Which backend servers to prefer on reads. Format is r<N> for region
1008
+N or r<N>z<M> for region N, zone M. The value after the equals is
1009
+the priority; lower numbers are higher priority.
1010
+Default is empty, meaning no preference.
1011
+Example: first read from region 1 zone 1, then region 1 zone 2, then anything in region 2, then everything else:
1012
+read_affinity = r1z1=100, r1z2=200, r2=300
1013
+.IP \fBwrite_affinity\fR
1014
+Which backend servers to prefer on writes. Format is r<N> for region
1015
+N or r<N>z<M> for region N, zone M. If this is set, then when
1016
+handling an object PUT request, some number (see setting
1017
+write_affinity_node_count) of local backend servers will be tried
1018
+before any nonlocal ones. Default is empty, meaning no preference.
1019
+Example: try to write to regions 1 and 2 before writing to any other
1020
+nodes:
1021
+write_affinity = r1, r2
1022
+.IP \fBwrite_affinity_node_count\fR
1023
+The number of local (as governed by the write_affinity setting)
1024
+nodes to attempt to contact first, before any non-local ones. You
1025
+can use '* replicas' at the end to have it use the number given
1026
+times the number of replicas for the ring being used for the
1027
+request. The default is '2 * replicas'.
1028
+.IP \fBswift_owner_headers\fR
1029
+These are the headers whose values will only be shown to swift_owners. The
1030
+exact definition of a swift_owner is up to the auth system in use, but
1031
+usually indicates administrative responsibilities.
1032
+The default is 'x-container-read, x-container-write, x-container-sync-key, x-container-sync-to, x-account-meta-temp-url-key, x-account-meta-temp-url-key-2, x-container-meta-temp-url-key, x-container-meta-temp-url-key-2, x-account-access-control'.
548 1033
 .RE
549 1034
 .PD
550 1035
 

+ 2
- 0
doc/manpages/swift-init.1 View File

@@ -109,6 +109,8 @@ allows one to use the keywords such as "all", "main" and "rest" for the <server>
109 109
 .IP "-c N, --config-num=N \t send command to the Nth server only
110 110
 .IP "-k N, --kill-wait=N \t wait N seconds for processes to die (default 15)
111 111
 .IP "-r RUN_DIR, --run-dir=RUN_DIR directory where the pids will be stored (default /var/run/swift)
112
+.IP "--strict return non-zero status code if some config is missing. Default mode if server is explicitly named."
113
+.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`."
112 114
 .PD 
113 115
 .RE
114 116
 

+ 3
- 1
doc/manpages/swift-recon.1 View File

@@ -83,7 +83,9 @@ Get drive audit error stats
83 83
 .IP "\fB-T, --time\fR"
84 84
 Check time synchronization
85 85
 .IP "\fB--all\fR"
86
-Perform all checks. Equivalent to \-arudlqT \-\-md5
86
+Perform all checks. Equivalent to \-arudlqT
87
+\-\-md5 \-\-sockstat \-\-auditor \-\-updater \-\-expirer
88
+\-\-driveaudit \-\-validate\-servers
87 89
 .IP "\fB--region=REGION\fR"
88 90
 Only query servers in specified region
89 91
 .IP "\fB-z ZONE, --zone=ZONE\fR"

+ 7
- 4
doc/source/admin_guide.rst View File

@@ -110,8 +110,8 @@ You can create scripts to create the account and container rings and rebalance.
110 110
     cd /etc/swift
111 111
     rm -f account.builder account.ring.gz backups/account.builder backups/account.ring.gz
112 112
     swift-ring-builder account.builder create 18 3 1
113
-    swift-ring-builder account.builder add z1-<account-server-1>:6002/sdb1 1
114
-    swift-ring-builder account.builder add z2-<account-server-2>:6002/sdb1 1
113
+    swift-ring-builder account.builder add r1z1-<account-server-1>:6002/sdb1 1
114
+    swift-ring-builder account.builder add r1z2-<account-server-2>:6002/sdb1 1
115 115
     swift-ring-builder account.builder rebalance
116 116
 
117 117
    You need to replace the values of <account-server-1>,
@@ -121,7 +121,8 @@ You can create scripts to create the account and container rings and rebalance.
121 121
    6002, and have a storage device called "sdb1" (this is a directory
122 122
    name created under /drives when we setup the account server). The
123 123
    "z1", "z2", etc. designate zones, and you can choose whether you
124
-   put devices in the same or different zones.
124
+   put devices in the same or different zones. The "r1" designates
125
+   the region, with different regions specified as "r1", "r2", etc.
125 126
 
126 127
 2. Make the script file executable and run it to create the account ring file::
127 128
 
@@ -588,7 +589,9 @@ This information can also be queried via the swift-recon command line utility::
588 589
       --md5                 Get md5sum of servers ring and compare to local copy
589 590
       --sockstat            Get cluster socket usage stats
590 591
       -T, --time            Check time synchronization
591
-      --all                 Perform all checks. Equal to -arudlqT --md5 --sockstat
592
+      --all                 Perform all checks. Equal to
593
+                            -arudlqT --md5 --sockstat --auditor --updater
594
+                            --expirer --driveaudit --validate-servers
592 595
       -z ZONE, --zone=ZONE  Only query servers in specified zone
593 596
       -t SECONDS, --timeout=SECONDS
594 597
                             Time to wait for a response from a server

+ 1
- 5
doc/source/api/form_post_middleware.rst View File

@@ -1,5 +1,3 @@
1
-.. _formpost:
2
-
3 1
 ====================
4 2
 Form POST middleware
5 3
 ====================
@@ -19,9 +17,7 @@ URL middleware uses. For information about how to set these keys, see
19 17
 :ref:`secret_keys`.
20 18
 
21 19
 For information about the form **POST** middleware configuration
22
-options, see `Form
23
-post <http://docs.openstack.org/havana/config-reference/content/object-storage-form-post.html>`__
24
-in the *OpenStack Configuration Reference*.
20
+options, see :ref:`formpost` in the *Source Documentation*.
25 21
 
26 22
 Form POST format
27 23
 ~~~~~~~~~~~~~~~~

+ 2
- 0
doc/source/api/large_objects.rst View File

@@ -293,10 +293,12 @@ a manifest object but a normal object with content same as what you would
293 293
 get on a **GET** request to original manifest object.
294 294
 
295 295
 To duplicate a manifest object:
296
+
296 297
 * Use the **GET** operation to read the value of ``X-Object-Manifest`` and
297 298
   use this value in the ``X-Object-Manifest`` request header in a **PUT**
298 299
   operation.
299 300
 * Alternatively, you can include *``?multipart-manifest=get``*  query
300 301
   string in the **COPY**  request.
302
+
301 303
 This creates a new manifest object that shares the same set of segment
302 304
 objects as the original manifest object.

+ 18
- 1
doc/source/api/object_api_v1_overview.rst View File

@@ -128,7 +128,24 @@ If you have a large number of containers or objects, you can use query
128 128
 parameters to page through large lists of containers or objects. Use the
129 129
 *``marker``*, *``limit``*, and *``end_marker``* query parameters to
130 130
 control how many items are returned in a list and where the list starts
131
-or ends.
131
+or ends. If you want to page through in reverse order, you can use the query
132
+parameter *``reverse``*, noting that your marker and end_markers should be
133
+switched when applied to a reverse listing. I.e, for a list of objects
134
+``[a, b, c, d, e]`` the non-reversed could be:
135
+
136
+.. code::
137
+
138
+  /v1/{account}/{container}/?marker=a&end_marker=d
139
+  b
140
+  c
141
+
142
+However, when reversed marker and end_marker are applied to a reversed list:
143
+
144
+.. code::
145
+
146
+  /v1/{account}/{container}/?marker=d&end_marker=a&reverse=on
147
+  c
148
+  b
132 149
 
133 150
 Object Storage HTTP requests have the following default constraints.
134 151
 Your service provider might use different default values.

+ 1
- 3
doc/source/api/temporary_url_middleware.rst View File

@@ -15,9 +15,7 @@ downloads the object directly from Object Storage, eliminating the need
15 15
 for the website to act as a proxy for the request.
16 16
 
17 17
 Ask your cloud administrator to enable the temporary URL feature. For
18
-information, see `Temporary
19
-URL <http://docs.openstack.org/havana/config-reference/content/object-storage-tempurl.html>`__
20
-in the *OpenStack Configuration Reference*.
18
+information, see :ref:`tempurl` in the *Source Documentation*.
21 19
 
22 20
 Note
23 21
 ~~~~

+ 8
- 5
doc/source/associated_projects.rst View File

@@ -23,12 +23,15 @@ Application Bindings
23 23
     * `SwiftBox <https://github.com/suniln/SwiftBox>`_ - C# library using RestSharp
24 24
     * `jclouds <http://jclouds.incubator.apache.org/documentation/quickstart/openstack/>`_ - Java library offering bindings for all OpenStack projects
25 25
     * `java-openstack-swift <https://github.com/dkocher/java-openstack-swift>`_ - Java bindings for OpenStack Swift
26
+    * `swift_client <https://github.com/mrkamel/swift_client>`_ - Small but powerful Ruby client to interact with OpenStack Swift
27
+    * `nightcrawler_swift <https://github.com/tulios/nightcrawler_swift>`_ - This Ruby gem teleports your assets to a OpenStack Swift bucket/container
28
+    * `swift storage <https://rubygems.org/gems/swift-storage>`_ - Simple Openstack Swift storage client.
26 29
 
27 30
 Authentication
28 31
 --------------
29 32
 
30 33
 * `Keystone <https://github.com/openstack/keystone>`_ - Official Identity Service for OpenStack.
31
-* `Swauth <https://github.com/gholt/swauth>`_ - Older Swift authentication service that only requires Swift itself.
34
+* `Swauth <https://github.com/openstack/swauth>`_ - An alternative Swift authentication service that only requires Swift itself.
32 35
 * `Basicauth <https://github.com/CloudVPS/swift-basicauth>`_ - HTTP Basic authentication support (keystone backed).
33 36
 
34 37
 
@@ -60,7 +63,7 @@ Content Distribution Network Integration
60 63
 Alternative API
61 64
 ---------------
62 65
 
63
-* `Swift3 <https://github.com/stackforge/swift3>`_ - Amazon S3 API emulation.
66
+* `Swift3 <https://github.com/openstack/swift3>`_ - Amazon S3 API emulation.
64 67
 * `CDMI <https://github.com/osaddon/cdmi>`_ - CDMI support
65 68
 
66 69
 
@@ -81,8 +84,8 @@ Custom Logger Hooks
81 84
 
82 85
 Storage Backends (DiskFile API implementations)
83 86
 -----------------------------------------------
84
-* `Swift-on-File <https://github.com/stackforge/swiftonfile>`_ - Enables objects created using Swift API to be accessed as files on a POSIX filesystem and vice versa.
85
-* `swift-ceph-backend <https://github.com/stackforge/swift-ceph-backend>`_ - Ceph RADOS object server implementation for Swift.
87
+* `Swift-on-File <https://github.com/openstack/swiftonfile>`_ - Enables objects created using Swift API to be accessed as files on a POSIX filesystem and vice versa.
88
+* `swift-ceph-backend <https://github.com/openstack/swift-ceph-backend>`_ - Ceph RADOS object server implementation for Swift.
86 89
 * `kinetic-swift <https://github.com/swiftstack/kinetic-swift>`_ - Seagate Kinetic Drive as backend for Swift
87 90
 * `swift-scality-backend <https://github.com/scality/ScalitySproxydSwift>`_ - Scality sproxyd object server implementation for Swift.
88 91
 
@@ -95,7 +98,7 @@ Developer Tools
95 98
 * `SAIO Ansible playbook <https://github.com/thiagodasilva/swift-aio>`_ -
96 99
   Quickly setup a standard development environment using Vagrant and Ansible in
97 100
   a Fedora virtual machine (with built-in `Swift-on-File
98
-  <https://github.com/stackforge/swiftonfile>`_ support).
101
+  <https://github.com/openstack/swiftonfile>`_ support).
99 102
 
100 103
 Other
101 104
 -----

+ 716
- 460
doc/source/deployment_guide.rst
File diff suppressed because it is too large
View File


+ 6
- 5
doc/source/development_auth.rst View File

@@ -352,7 +352,7 @@ folks a start on their own code if they want to use repoze.what::
352 352
             self.ssl = \
353 353
                 conf.get('ssl', 'false').lower() in ('true', 'on', '1', 'yes')
354 354
             self.auth_prefix = conf.get('prefix', '/')
355
-            self.timeout = int(conf.get('node_timeout', 10))
355
+            self.timeout = float(conf.get('node_timeout', 10))
356 356
 
357 357
         def authenticate(self, env, identity):
358 358
             token = identity.get('token')
@@ -375,7 +375,7 @@ folks a start on their own code if they want to use repoze.what::
375 375
                 expiration = float(resp.getheader('x-auth-ttl'))
376 376
                 user = resp.getheader('x-auth-user')
377 377
                 memcache_client.set(key, (time(), expiration, user),
378
-                                    timeout=expiration)
378
+                                    time=expiration)
379 379
                 return user
380 380
             return None
381 381
 
@@ -487,7 +487,8 @@ folks a start on their own code if they want to use repoze.what::
487 487
 Allowing CORS with Auth
488 488
 -----------------------
489 489
 
490
-Cross Origin RequestS require that the auth system allow the OPTIONS method to 
491
-pass through without a token.  The preflight request will make an OPTIONS call 
492
-against the object or container and will not work if the auth system stops it.
490
+Cross Origin Resource Sharing (CORS) require that the auth system allow the
491
+OPTIONS method to pass through without a token.  The preflight request will
492
+make an OPTIONS call against the object or container and will not work if
493
+the auth system stops it.
493 494
 See TempAuth for an example of how OPTIONS requests are handled.

+ 5
- 5
doc/source/development_guidelines.rst View File

@@ -51,16 +51,16 @@ To execute the unit tests:
51 51
 
52 52
 .. note::
53 53
   As of tox version 2.0.0, most environment variables are not automatically
54
-  passed to the test environment. Swift's tox.ini overrides this default
55
-  behavior so that variable names matching SWIFT_* and *_proxy will be passed,
56
-  but you may need to run tox --recreate for this to take effect after
57
-  upgrading from tox<2.0.0.
54
+  passed to the test environment. Swift's `tox.ini` overrides this default
55
+  behavior so that variable names matching ``SWIFT_*`` and ``*_proxy`` will be
56
+  passed, but you may need to run `tox --recreate` for this to take effect
57
+  after upgrading from tox<2.0.0.
58 58
 
59 59
   Conversely, if you do not want those environment variables to be passed to
60 60
   the test environment then you will need to unset them before calling tox.
61 61
 
62 62
   Also, if you ever encounter DistributionNotFound, try to use `tox --recreate`
63
-  or remove the .tox directory to force tox to recreate the dependency list.
63
+  or remove the `.tox` directory to force tox to recreate the dependency list.
64 64
 
65 65
 The functional tests may be executed against a :doc:`development_saio` or
66 66
 other running Swift cluster using the command:

+ 3
- 3
doc/source/development_saio.rst View File

@@ -39,7 +39,7 @@ Installing dependencies
39 39
         sudo apt-get install curl gcc memcached rsync sqlite3 xfsprogs \
40 40
                              git-core libffi-dev python-setuptools
41 41
         sudo apt-get install python-coverage python-dev python-nose \
42
-                             python-simplejson python-xattr python-eventlet \
42
+                             python-xattr python-eventlet \
43 43
                              python-greenlet python-pastedeploy \
44 44
                              python-netifaces python-pip python-dnspython \
45 45
                              python-mock
@@ -50,14 +50,14 @@ Installing dependencies
50 50
         sudo yum install curl gcc memcached rsync sqlite xfsprogs git-core \
51 51
                          libffi-devel xinetd python-setuptools \
52 52
                          python-coverage python-devel python-nose \
53
-                         python-simplejson pyxattr python-eventlet \
53
+                         pyxattr python-eventlet \
54 54
                          python-greenlet python-paste-deploy \
55 55
                          python-netifaces python-pip python-dns \
56 56
                          python-mock
57 57
 
58 58
   Note: This installs necessary system dependencies and *most* of the python
59 59
   dependencies. Later in the process setuptools/distribute or pip will install
60
-  and/or upgrade packages. 
60
+  and/or upgrade packages.
61 61
 
62 62
 Next, choose either :ref:`partition-section` or :ref:`loopback-section`.
63 63
 

+ 7
- 8
doc/source/howto_installmultinode.rst View File

@@ -6,6 +6,13 @@ Please refer to the latest official
6 6
 `Openstack Installation Guides <http://docs.openstack.org/#install-guides>`_
7 7
 for the most up-to-date documentation.
8 8
 
9
+Object Storage installation guide for Openstack Liberty
10
+----------------------------------------------------
11
+
12
+ * `openSUSE 13.2 and SUSE Linux Enterprise Server 12 <http://docs.openstack.org/liberty/install-guide-obs/swift.html>`_
13
+ * `RHEL 7, CentOS 7 <http://docs.openstack.org/liberty/install-guide-rdo/swift.html>`_
14
+ * `Ubuntu 14.04 <http://docs.openstack.org/liberty/install-guide-ubuntu/swift.html>`_
15
+
9 16
 Object Storage installation guide for Openstack Kilo
10 17
 ----------------------------------------------------
11 18
 
@@ -26,11 +33,3 @@ Object Storage installation guide for Openstack Icehouse
26 33
  * `openSUSE and SUSE Linux Enterprise Server <http://docs.openstack.org/icehouse/install-guide/install/zypper/content/ch_swift.html>`_
27 34
  * `Red Hat Enterprise Linux, CentOS, and Fedora <http://docs.openstack.org/icehouse/install-guide/install/yum/content/ch_swift.html>`_
28 35
  * `Ubuntu 12.04/14.04 (LTS) <http://docs.openstack.org/icehouse/install-guide/install/apt/content/ch_swift.html>`_
29
-
30
-Object Storage installation guide for Openstack Havana
31
-------------------------------------------------------
32
-
33
- * `Debian 7.0 <http://docs.openstack.org/havana/install-guide/install/apt-debian/content/ch_swift.html>`_
34
- * `openSUSE and SUSE Linux Enterprise Server <http://docs.openstack.org/havana/install-guide/install/zypper/content/ch_swift.html>`_
35
- * `Red Hat Enterprise Linux, CentOS, and Fedora <http://docs.openstack.org/havana/install-guide/install/yum/content/ch_swift.html>`_
36
- * `Ubuntu 12.04 (LTS) <http://docs.openstack.org/havana/install-guide/install/apt/content/ch_swift.html>`_

+ 2
- 0
doc/source/overview_auth.rst View File

@@ -254,9 +254,11 @@ This configuration works as follows:
254 254
   ``admin`` or ``swiftoperator`` role(s). When validated, the service token
255 255
   gives the ``service`` role.
256 256
 * Swift interprets the above configuration as follows:
257
+
257 258
   * Did the user token provide one of the roles listed in operator_roles?
258 259
   * Did the service token have the ``service`` role as described by the
259 260
     ``SERVICE_service_roles`` options.
261
+
260 262
 * If both conditions are met, the request is granted. Otherwise, Swift
261 263
   rejects the request.
262 264
 

+ 2
- 1
doc/source/overview_backing_store.rst View File

@@ -171,6 +171,7 @@ The sequence of events and actions are as follows:
171 171
   a copy of the <user-token>. In the X-Service-Token header, place your
172 172
   Service's token. If you use python-swiftclient you can achieve this
173 173
   by:
174
+
174 175
       * Putting the URL in the ``preauthurl`` parameter
175 176
       * Putting the <user-token> in ``preauthtoken`` paramater
176 177
       * Adding the X-Service-Token to the ``headers`` parameter
@@ -251,7 +252,7 @@ However, if one Service is compromised, that Service can access
251 252
 data created by another Service. To prevent this, multiple Service Prefixes may
252 253
 be used. This also requires that the operator configure multiple service
253 254
 roles. For example, in a system that has Glance and Cinder, the following
254
-Swift configuration could be used:
255
+Swift configuration could be used::
255 256
 
256 257
     [keystoneauth]
257 258
     reseller_prefix = AUTH_, IMAGE_, BLOCK_

+ 0
- 14
doc/source/overview_erasure_code.rst View File

@@ -2,20 +2,6 @@
2 2
 Erasure Code Support
3 3
 ====================
4 4
 
5
-
6
---------------------------
7
-Beta: Not production ready
8
---------------------------
9
-The erasure code support in Swift is considered "beta" at this point.
10
-Most major functionality is included, but it has not been tested or validated
11
-at large scale. This feature relies on ssync for durability. Deployers are
12
-urged to do extensive testing and not deploy production data using an
13
-erasure code storage policy.
14
-
15
-If any bugs are found during testing, please report them to
16
-https://bugs.launchpad.net/swift
17
-
18
-
19 5
 -------------------------------
20 6
 History and Theory of Operation
21 7
 -------------------------------

+ 16
- 10
doc/source/overview_policies.rst View File

@@ -57,7 +57,7 @@ deployers.  Each container has a new special immutable metadata element called
57 57
 the storage policy index.  Note that internally, Swift relies on policy
58 58
 indexes and not policy names.  Policy names exist for human readability and
59 59
 translation is managed in the proxy.  When a container is created, one new
60
-optional header is supported to specify the policy name.  If nothing is
60
+optional header is supported to specify the policy name. If no name is
61 61
 specified, the default policy is used (and if no other policies defined,
62 62
 Policy-0 is considered the default).  We will be covering the difference
63 63
 between default and Policy-0 in the next section.
@@ -170,12 +170,13 @@ Storage Policies is a versatile feature intended to support both new and
170 170
 pre-existing clusters with the same level of flexibility.  For that reason, we
171 171
 introduce the ``Policy-0`` concept which is not the same as the "default"
172 172
 policy.  As you will see when we begin to configure policies, each policy has
173
-both a name (human friendly, configurable) as well as an index (or simply
174
-policy number). Swift reserves index 0 to map to the object ring that's
175
-present in all installations (e.g., ``/etc/swift/object.ring.gz``).  You can
176
-name this policy anything you like, and if no policies are defined it will
177
-report itself as ``Policy-0``, however you cannot change the index as there must
178
-always be a policy with index 0.
173
+a single name and an arbitrary number of aliases (human friendly,
174
+configurable) as well as an index (or simply policy number). Swift reserves
175
+index 0 to map to the object ring that's present in all installations
176
+(e.g., ``/etc/swift/object.ring.gz``). You can name this policy anything you
177
+like, and if no policies are defined it will report itself as ``Policy-0``,
178
+however you cannot change the index as there must always be a policy with
179
+index 0.
179 180
 
180 181
 Another important concept is the default policy which can be any policy
181 182
 in the cluster.  The default policy is the policy that is automatically
@@ -273,6 +274,8 @@ file:
273 274
     * Policy names must contain only letters, digits or a dash
274 275
     * Policy names must be unique
275 276
     * The policy name 'Policy-0' can only be used for the policy with index 0
277
+    * Multiple names can be assigned to one policy using aliases. All names
278
+      must follow the Swift naming rules.
276 279
     * If any policies are defined, exactly one policy must be declared default
277 280
     * Deprecated policies cannot be declared the default
278 281
     * If no ``policy_type`` is provided, ``replication`` is the default value.
@@ -288,6 +291,7 @@ example configuration.::
288 291
 
289 292
         [storage-policy:0]
290 293
         name = gold
294
+        aliases = yellow, orange
291 295
         policy_type = replication
292 296
         default = yes
293 297
 
@@ -301,8 +305,10 @@ information about the ``default`` and ``deprecated`` options.
301 305
 
302 306
 There are some other considerations when managing policies:
303 307
 
304
-    * Policy names can be changed (but be sure that users are aware, aliases are
305
-      not currently supported but could be implemented in custom middleware!)
308
+    * Policy names can be changed.
309
+    * Aliases are supported and can be added and removed. If the primary name
310
+      of a policy is removed the next available alias will be adopted as the
311
+      primary name. A policy must always have at least one name.
306 312
     * You cannot change the index of a policy once it has been created
307 313
     * The default policy can be changed at any time, by adding the
308 314
       default directive to the desired policy section
@@ -399,7 +405,7 @@ The module, :ref:`storage_policy`, is responsible for parsing the
399 405
 configured policies via class :class:`.StoragePolicyCollection`.  This
400 406
 collection is made up of policies of class :class:`.StoragePolicy`. The
401 407
 collection class includes handy functions for getting to a policy either by
402
-name or by index , getting info about the policies, etc.  There's also one
408
+name or by index , getting info about the policies, etc. There's also one
403 409
 very important function, :meth:`~.StoragePolicyCollection.get_object_ring`.
404 410
 Object rings are members of the :class:`.StoragePolicy` class and are
405 411
 actually not instantiated until the :meth:`~.StoragePolicy.load_ring`

+ 3
- 1
doc/source/policies_saio.rst View File

@@ -26,6 +26,7 @@ to implement a usable set of policies.
26 26
 
27 27
         [storage-policy:0]
28 28
         name = gold
29
+        aliases = yellow, orange
29 30
         default = yes
30 31
 
31 32
         [storage-policy:1]
@@ -82,7 +83,8 @@ Storage Policies effect placement of data in Swift.
82 83
 
83 84
   You should see this: (only showing the policy output here)::
84 85
 
85
-        policies: [{'default': True, 'name': 'gold'}, {'name': 'silver'}]
86
+        policies: [{'aliases': 'gold, yellow, orange', 'default': True,
87
+            'name': 'gold'}, {'aliases': 'silver', 'name': 'silver'}]
86 88
 
87 89
 3. Now create a container without specifying a policy, it will use the
88 90
    default, 'gold' and then put a test object in it (create the file ``file0.txt``

+ 12
- 3
etc/account-server.conf-sample View File

@@ -70,7 +70,7 @@ use = egg:swift#account
70 70
 # "replication_server" (this is the default). To only handle replication,
71 71
 # set to a True value (e.g. "True" or "1"). To handle only non-replication
72 72
 # verbs, set to "False". Unless you have a separate replication network, you
73
-# should not specify any value for "replication_server".
73
+# should not specify any value for "replication_server". Default is empty.
74 74
 # replication_server = false
75 75
 
76 76
 [filter:healthcheck]
@@ -90,8 +90,19 @@ use = egg:swift#recon
90 90
 # log_level = INFO
91 91
 # log_address = /dev/log
92 92
 #
93
+# Maximum number of database rows that will be sync'd in a single HTTP
94
+# replication request. Databases with less than or equal to this number of
95
+# differing rows will always be sync'd using an HTTP replication request rather
96
+# than using rsync.
93 97
 # per_diff = 1000
98
+#
99
+# Maximum number of HTTP replication requests attempted on each replication
100
+# pass for any one container. This caps how long the replicator will spend
101
+# trying to sync a given database per pass so the other databases don't get
102
+# starved.
94 103
 # max_diffs = 100
104
+#
105
+# Number of replication workers to spawn.
95 106
 # concurrency = 8
96 107
 #
97 108
 # Time in seconds to wait between replication passes
@@ -126,8 +137,6 @@ use = egg:swift#recon
126 137
 # Will audit each account at most once per interval
127 138
 # interval = 1800
128 139
 #
129
-# log_facility = LOG_LOCAL0
130
-# log_level = INFO
131 140
 # accounts_per_second = 200
132 141
 # recon_cache_path = /var/cache/swift
133 142
 

+ 11
- 0
etc/container-server.conf-sample View File

@@ -99,8 +99,19 @@ use = egg:swift#recon
99 99
 # log_level = INFO
100 100
 # log_address = /dev/log
101 101
 #
102
+# Maximum number of database rows that will be sync'd in a single HTTP
103
+# replication request. Databases with less than or equal to this number of
104
+# differing rows will always be sync'd using an HTTP replication request rather
105
+# than using rsync.
102 106
 # per_diff = 1000
107
+#
108
+# Maximum number of HTTP replication requests attempted on each replication
109
+# pass for any one container. This caps how long the replicator will spend
110
+# trying to sync a given database per pass so the other databases don't get
111
+# starved.
103 112
 # max_diffs = 100
113
+#
114
+# Number of replication workers to spawn.
104 115
 # concurrency = 8
105 116
 #
106 117
 # Time in seconds to wait between replication passes

+ 4
- 0
etc/drive-audit.conf-sample View File

@@ -1,11 +1,15 @@
1 1
 [drive-audit]
2 2
 # device_dir = /srv/node
3
+#
4
+# You can specify default log routing here if you want:
5
+# log_name = drive-audit
3 6
 # log_facility = LOG_LOCAL0
4 7
 # log_level = INFO
5 8
 # log_address = /dev/log
6 9
 # The following caps the length of log lines to the value given; no limit if
7 10
 # set to 0, the default.
8 11
 # log_max_line_length = 0
12
+#
9 13
 # minutes = 60
10 14
 # error_limit = 1
11 15
 # recon_cache_path = /var/cache/swift

+ 1
- 4
etc/object-server.conf-sample View File

@@ -172,10 +172,7 @@ use = egg:swift#recon
172 172
 # concurrency = 1
173 173
 # stats_interval = 300
174 174
 #
175
-# The sync method to use; default is rsync but you can use ssync to try the
176
-# EXPERIMENTAL all-swift-code-no-rsync-callouts method. Once ssync is verified
177
-# as having performance comparable to, or better than, rsync, we plan to
178
-# deprecate rsync so we can move on with more features for replication.
175
+# default is rsync, alternative is ssync
179 176
 # sync_method = rsync
180 177
 #
181 178
 # max duration of a partition rsync

+ 15
- 3
etc/proxy-server.conf-sample View File

@@ -77,8 +77,15 @@ bind_port = 8080
77 77
 # eventlet_debug = false
78 78
 
79 79
 [pipeline:main]
80
+# This sample pipeline uses tempauth and is used for SAIO dev work and
81
+# testing. See below for a pipeline using keystone.
80 82
 pipeline = catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk tempurl ratelimit tempauth container-quotas account-quotas slo dlo versioned_writes proxy-logging proxy-server
81 83
 
84
+# The following pipeline shows keystone integration. Comment out the one
85
+# above and uncomment this one. Additional steps for integrating keystone are
86
+# covered further below in the filter sections for authtoken and keystoneauth.
87
+#pipeline = catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk tempurl ratelimit authtoken keystoneauth container-quotas account-quotas slo dlo versioned_writes proxy-logging proxy-server
88
+
82 89
 [app:proxy-server]
83 90
 use = egg:swift#proxy
84 91
 # You can override the default log routing for this app here:
@@ -277,9 +284,8 @@ user_test5_tester5 = testing5 service
277 284
 # refer to the keystone's documentation for details about the
278 285
 # different settings.
279 286
 #
280
-# You'll need to have as well the keystoneauth middleware enabled
281
-# and have it in your main pipeline so instead of having tempauth in
282
-# there you can change it to: authtoken keystoneauth
287
+# You'll also need to have the keystoneauth middleware enabled and have it in
288
+# your main pipeline, as show in the sample pipeline at the top of this file.
283 289
 #
284 290
 # [filter:authtoken]
285 291
 # paste.filter_factory = keystonemiddleware.auth_token:filter_factory
@@ -499,6 +505,12 @@ use = egg:swift#cname_lookup
499 505
 # Note: Put staticweb just after your auth filter(s) in the pipeline
500 506
 [filter:staticweb]
501 507
 use = egg:swift#staticweb
508
+# You can override the default log routing for this filter here:
509
+# set log_name = staticweb
510
+# set log_facility = LOG_LOCAL0
511
+# set log_level = INFO
512
+# set log_headers = false
513
+# set log_address = /dev/log
502 514
 
503 515
 # Note: Put tempurl before dlo, slo and your auth filter(s) in the pipeline
504 516
 [filter:tempurl]

+ 10
- 5
etc/swift.conf-sample View File

@@ -21,7 +21,7 @@ swift_hash_path_prefix = changeme
21 21
 # policy with index 0 will be declared the default.  If multiple policies are
22 22
 # defined you must define a policy with index 0 and you must specify a
23 23
 # default.  It is recommended you always define a section for
24
-# storage-policy:0.
24
+# storage-policy:0. Aliases are not required when defining a storage policy.
25 25
 #
26 26
 # A 'policy_type' argument is also supported but is not mandatory.  Default
27 27
 # policy type 'replication' is used when 'policy_type' is unspecified.
@@ -29,6 +29,7 @@ swift_hash_path_prefix = changeme
29 29
 name = Policy-0
30 30
 default = yes
31 31
 #policy_type = replication
32
+aliases = yellow, orange
32 33
 
33 34
 # the following section would declare a policy called 'silver', the number of
34 35
 # replicas will be determined by how the ring is built.  In this example the
@@ -40,7 +41,10 @@ default = yes
40 41
 # this config has specified it as the default.  However if a legacy container
41 42
 # (one created with a pre-policy version of swift) is accessed, it is known
42 43
 # implicitly to be assigned to the policy with index 0 as opposed to the
43
-# current default.
44
+# current default. Note that even without specifying any aliases, a policy
45
+# always has at least the default name stored in aliases because this field is
46
+# used to contain all human readable names for a storage policy.
47
+#
44 48
 #[storage-policy:1]
45 49
 #name = silver
46 50
 #policy_type = replication
@@ -67,12 +71,13 @@ default = yes
67 71
 # refer to Swift documentation for details on how to configure EC policies.
68 72
 #
69 73
 # The example 'deepfreeze10-4' policy defined below is a _sample_
70
-# configuration with 10 'data' and 4 'parity' fragments. 'ec_type'
71
-# defines the Erasure Coding scheme. 'jerasure_rs_vand' (Reed-Solomon
72
-# Vandermonde) is used as an example below.
74
+# configuration with an alias of 'df10-4' as well as 10 'data' and 4 'parity'
75
+# fragments. 'ec_type' defines the Erasure Coding scheme.
76
+# 'jerasure_rs_vand' (Reed-Solomon Vandermonde) is used as an example below.
73 77
 #
74 78
 #[storage-policy:2]
75 79
 #name = deepfreeze10-4
80
+#aliases = df10-4
76 81
 #policy_type = erasure_coding
77 82
 #ec_type = jerasure_rs_vand
78 83
 #ec_num_data_fragments = 10

+ 3
- 3
requirements.txt View File

@@ -2,12 +2,12 @@
2 2
 # of appearance. Changing the order has an impact on the overall integration
3 3
 # process, which may cause wedges in the gate later.
4 4
 
5
-dnspython>=1.9.4
5
+dnspython>=1.12.0;python_version<'3.0'
6
+dnspython3>=1.12.0;python_version&