← Back to branch summary

~ubuntu-branches/ubuntu/trusty/swift/trusty-updates

« back to all changes in this revision

Viewing changes to doc/manpages/object-server.conf.5

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2013-01-28 09:40:30 UTC
  • mfrom: (1.2.16)
  • Revision ID: package-import@ubuntu.com-20130128094030-aetz57x2qz9ye2d4
Tags: 1.7.6-0ubuntu1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/manpages/object-server.conf.5
14
14
.\" implied.
15
15
.\" See the License for the specific language governing permissions and
16
16
.\" limitations under the License.
17
 
.\"  
 
17
.\"
18
18
.TH object-server.conf 5 "8/26/2011" "Linux" "OpenStack Swift"
19
19
 
20
 
.SH NAME 
 
20
.SH NAME
21
21
.LP
22
22
.B object-server.conf
23
 
\- configuration file for the openstack-swift object server 
 
23
\- configuration file for the openstack-swift object server
24
24
 
25
25
 
26
26
 
30
30
 
31
31
 
32
32
 
33
 
.SH DESCRIPTION 
 
33
.SH DESCRIPTION
34
34
.PP
35
 
This is the configuration file used by the object server and other object 
36
 
background services, such as; replicator, updater and auditor. 
 
35
This is the configuration file used by the object server and other object
 
36
background services, such as; replicator, updater and auditor.
37
37
 
38
38
The configuration file follows the python-pastedeploy syntax. The file is divided
39
 
into sections, which are enclosed by square brackets. Each section will contain a 
40
 
certain number of key/value parameters which are described later. 
41
 
 
42
 
Any line that begins with a '#' symbol is ignored. 
43
 
 
44
 
You can find more information about python-pastedeploy configuration format at 
 
39
into sections, which are enclosed by square brackets. Each section will contain a
 
40
certain number of key/value parameters which are described later.
 
41
 
 
42
Any line that begins with a '#' symbol is ignored.
 
43
 
 
44
You can find more information about python-pastedeploy configuration format at
45
45
\fIhttp://pythonpaste.org/deploy/#config-format\fR
46
46
 
47
47
 
48
48
 
49
49
.SH GLOBAL SECTION
50
 
.PD 1 
 
50
.PD 1
51
51
.RS 0
52
 
This is indicated by section named [DEFAULT]. Below are the parameters that 
53
 
are acceptable within this section. 
 
52
This is indicated by section named [DEFAULT]. Below are the parameters that
 
53
are acceptable within this section.
54
54
 
55
55
.IP "\fBbind_ip\fR"
56
 
IP address the object server should bind to. The default is 0.0.0.0 which will make 
 
56
IP address the object server should bind to. The default is 0.0.0.0 which will make
57
57
it bind to all available addresses.
58
 
.IP "\fBbind_port\fR" 
59
 
TCP port the object server should bind to. The default is 6000. 
60
 
.IP \fBbacklog\fR 
61
 
TCP backlog. Maximum number of allowed pending connections. The default value is 4096. 
62
 
.IP \fBworkers\fR 
63
 
Number of object server workers to fork. The default is 1. 
64
 
.IP \fBuser\fR 
65
 
The system user that the object server will run as. The default is swift. 
66
 
.IP \fBswift_dir\fR 
 
58
.IP "\fBbind_port\fR"
 
59
TCP port the object server should bind to. The default is 6000.
 
60
.IP \fBbacklog\fR
 
61
TCP backlog. Maximum number of allowed pending connections. The default value is 4096.
 
62
.IP \fBworkers\fR
 
63
Number of object server workers to fork. The default is 1.
 
64
.IP \fBuser\fR
 
65
The system user that the object server will run as. The default is swift.
 
66
.IP \fBswift_dir\fR
67
67
Swift configuration directory. The default is /etc/swift.
68
 
.IP \fBdevices\fR 
 
68
.IP \fBdevices\fR
69
69
Parent directory or where devices are mounted. Default is /srv/node.
70
 
.IP \fBmount_check\fR 
71
 
Whether or not check if the devices are mounted to prevent accidentally writing to 
 
70
.IP \fBmount_check\fR
 
71
Whether or not check if the devices are mounted to prevent accidentally writing to
72
72
the root device. The default is set to true.
73
 
.IP \fBlog_name\fR 
 
73
.IP \fBlog_name\fR
74
74
Label used when logging. The default is swift.
75
 
.IP \fBlog_facility\fR 
 
75
.IP \fBlog_facility\fR
76
76
Syslog log facility. The default is LOG_LOCAL0.
77
 
.IP \fBlog_level\fR 
 
77
.IP \fBlog_level\fR
78
78
Logging level. The default is INFO.
79
79
.IP \fBlog_address\fR
80
80
Logging address. The default is /dev/log.
84
84
 
85
85
 
86
86
.SH PIPELINE SECTION
87
 
.PD 1 
 
87
.PD 1
88
88
.RS 0
89
89
This is indicated by section name [pipeline:main]. Below are the parameters that
90
 
are acceptable within this section. 
 
90
are acceptable within this section.
91
91
 
92
92
.IP "\fBpipeline\fR"
93
 
It is used when you need to apply a number of filters. It is a list of filters 
94
 
ended by an application. The default should be \fB"healthcheck recon 
95
 
object-server"\fR
 
93
It is used when you need to apply a number of filters. It is a list of filters
 
94
ended by an application. The normal pipeline is "healthcheck recon
 
95
object-server".
96
96
.RE
97
97
.PD
98
98
 
99
99
 
100
100
 
101
101
.SH APP SECTION
102
 
.PD 1 
 
102
.PD 1
103
103
.RS 0
104
104
This is indicated by section name [app:object-server]. Below are the parameters
105
105
that are acceptable within this section.
106
106
.IP "\fBuse\fR"
107
 
Entry point for paste.deploy for the object server. This is the reference to the installed python egg. 
108
 
The default is \fBegg:swift#object\fR.
109
 
.IP "\fBset log_name\fR 
 
107
Entry point for paste.deploy for the object server. This is the reference to the installed python egg.
 
108
This is normally \fBegg:swift#object\fR.
 
109
.IP "\fBset log_name\fR
110
110
Label used when logging. The default is object-server.
111
 
.IP "\fBset log_facility\fR 
 
111
.IP "\fBset log_facility\fR
112
112
Syslog log facility. The default is LOG_LOCAL0.
113
 
.IP "\fB set log_level\fR 
 
113
.IP "\fB set log_level\fR
114
114
Logging level. The default is INFO.
115
 
.IP "\fB set log_requests\fR 
 
115
.IP "\fB set log_requests\fR
116
116
Enables request logging. The default is True.
117
117
.IP "\fB set log_address\fR
118
118
Logging address. The default is /dev/log.
119
119
.IP \fBnode_timeout\fR
120
 
Request timeout to external services. The default is 3 seconds. 
121
 
.IP \fBconn_timeout\fR 
122
 
Connection timeout to external services. The default is 0.5 seconds. 
 
120
Request timeout to external services. The default is 3 seconds.
 
121
.IP \fBconn_timeout\fR
 
122
Connection timeout to external services. The default is 0.5 seconds.
123
123
.RE
124
124
.PD
125
125
 
126
126
 
127
127
 
128
128
.SH FILTER SECTION
129
 
.PD 1 
 
129
.PD 1
130
130
.RS 0
131
131
Any section that has its name prefixed by "filter:" indicates a filter section.
132
132
Filters are used to specify configuration parameters for specific swift middlewares.
133
 
Below are the filters available and respective acceptable parameters. 
 
133
Below are the filters available and respective acceptable parameters.
134
134
.IP "\fB[filter:healthcheck]\fR"
135
135
.RE
136
136
.RS 3
137
137
.IP "\fBuse\fR"
138
 
Entry point for paste.deploy for the healthcheck middleware. This is the reference to the installed python egg. 
139
 
The default is \fBegg:swift#healthcheck\fR.
 
138
Entry point for paste.deploy for the healthcheck middleware. This is the reference to the installed python egg.
 
139
This is normally \fBegg:swift#healthcheck\fR.
 
140
.IP "\fBdisable_path\fR"
 
141
An optional filesystem path which, if present, will cause the healthcheck
 
142
URL to return "503 Service Unavailable" with a body of "DISABLED BY FILE".
140
143
.RE
141
144
 
142
 
.RS 0 
 
145
.RS 0
143
146
.IP "\fB[filter:recon]\fR"
144
147
.RE
145
148
.RS 3
146
149
.IP "\fBuse\fR"
147
 
Entry point for paste.deploy for the healthcheck middleware. This is the reference to the installed python egg. 
148
 
The default is \fBegg:swift#recon\fR.
 
150
Entry point for paste.deploy for the recon middleware. This is the reference to the installed python egg.
 
151
This is normally \fBegg:swift#recon\fR.
149
152
.IP "\fBrecon_cache_path\fR"
150
 
The recon_cache_path simply sets the directory where stats for a few items will be stored. 
151
 
Depending on the method of deployment you may need to create this directory manually 
152
 
and ensure that swift has read/write.The default is /var/cache/swift. 
 
153
The recon_cache_path simply sets the directory where stats for a few items will be stored.
 
154
Depending on the method of deployment you may need to create this directory manually
 
155
and ensure that swift has read/write. The default is /var/cache/swift.
153
156
.RE
154
157
.PD
155
158
 
163
166
.IP "\fB[object-replicator]\fR"
164
167
.RE
165
168
.RS 3
166
 
.IP \fBlog_name\fR 
 
169
.IP \fBlog_name\fR
167
170
Label used when logging. The default is object-replicator.
168
 
.IP \fBlog_facility\fR 
 
171
.IP \fBlog_facility\fR
169
172
Syslog log facility. The default is LOG_LOCAL0.
170
 
.IP \fBlog_level\fR 
 
173
.IP \fBlog_level\fR
171
174
Logging level. The default is INFO.
172
175
.IP \fBlog_address\fR
173
176
Logging address. The default is /dev/log.
174
 
.IP \fBvm_test_mode\fR 
 
177
.IP \fBvm_test_mode\fR
175
178
Indicates that you are using a VM environment. The default is no.
176
 
.IP \fBdaemonize\fR 
 
179
.IP \fBdaemonize\fR
177
180
Whether or not to run replication as a daemon. The default is yes.
178
 
.IP \fBrun_pause\fR 
 
181
.IP \fBrun_pause\fR
179
182
Time in seconds to wait between replication passes. The default is 30.
180
 
.IP \fBconcurrency\fR 
 
183
.IP \fBconcurrency\fR
181
184
Number of replication workers to spawn. The default is 1.
182
 
.IP \fBstats_interval\fR 
 
185
.IP \fBstats_interval\fR
183
186
Interval in seconds between logging replication statistics. The default is 300.
184
 
.IP \fBrsync_timeout\fR 
185
 
Max duration of a partition rsync. The default is 900 seconds. 
186
 
.IP \fBrsync_io_timeout\fR 
187
 
Passed to rsync for I/O OP timeout. The default is 30 seconds. 
188
 
.IP \fBhttp_timeout\fR 
189
 
Max duration of an HTTP request. The default is 60 seconds. 
190
 
.IP \fBlockup_timeout\fR 
191
 
Attempts to kill all workers if nothing replicates for lockup_timeout seconds. The 
192
 
default is 1800 seconds. 
193
 
.IP \fBreclaim_age\fR 
194
 
Time elapsed in seconds before an object can be reclaimed. The default is 
195
 
604800 seconds. 
 
187
.IP \fBrsync_timeout\fR
 
188
Max duration of a partition rsync. The default is 900 seconds.
 
189
.IP \fBrsync_io_timeout\fR
 
190
Passed to rsync for I/O OP timeout. The default is 30 seconds.
 
191
.IP \fBhttp_timeout\fR
 
192
Max duration of an HTTP request. The default is 60 seconds.
 
193
.IP \fBlockup_timeout\fR
 
194
Attempts to kill all workers if nothing replicates for lockup_timeout seconds. The
 
195
default is 1800 seconds.
 
196
.IP \fBreclaim_age\fR
 
197
Time elapsed in seconds before an object can be reclaimed. The default is
 
198
604800 seconds.
196
199
.IP \fBrecon_enable\fR
197
200
Enable logging of replication stats for recon. The default is on.
198
201
.IP "\fBrecon_cache_path\fR"
199
 
The recon_cache_path simply sets the directory where stats for a few items will be stored. 
200
 
Depending on the method of deployment you may need to create this directory manually 
201
 
and ensure that swift has read/write.The default is /var/cache/swift. 
 
202
The recon_cache_path simply sets the directory where stats for a few items will be stored.
 
203
Depending on the method of deployment you may need to create this directory manually
 
204
and ensure that swift has read/write.The default is /var/cache/swift.
202
205
.RE
203
206
 
204
207
 
206
209
.IP "\fB[object-updater]\fR"
207
210
.RE
208
211
.RS 3
209
 
.IP \fBlog_name\fR 
 
212
.IP \fBlog_name\fR
210
213
Label used when logging. The default is object-updater.
211
 
.IP \fBlog_facility\fR 
 
214
.IP \fBlog_facility\fR
212
215
Syslog log facility. The default is LOG_LOCAL0.
213
 
.IP \fBlog_level\fR 
 
216
.IP \fBlog_level\fR
214
217
Logging level. The default is INFO.
215
218
.IP \fBlog_address\fR
216
219
Logging address. The default is /dev/log.
217
 
.IP \fBinterval\fR 
218
 
Minimum time for a pass to take. The default is 300 seconds. 
219
 
.IP \fBconcurrency\fR 
220
 
Number of reaper workers to spawn. The default is 1. 
221
 
.IP \fBnode_timeout\fR 
222
 
Request timeout to external services. The default is 10 seconds. 
223
 
.IP \fBconn_timeout\fR 
224
 
Connection timeout to external services. The default is 0.5 seconds. 
 
220
.IP \fBinterval\fR
 
221
Minimum time for a pass to take. The default is 300 seconds.
 
222
.IP \fBconcurrency\fR
 
223
Number of reaper workers to spawn. The default is 1.
 
224
.IP \fBnode_timeout\fR
 
225
Request timeout to external services. The default is 10 seconds.
 
226
.IP \fBconn_timeout\fR
 
227
Connection timeout to external services. The default is 0.5 seconds.
225
228
.IP \fBslowdown = 0.01\fR
226
 
Slowdown will sleep that amount between objects. The default is 0.01 seconds. 
 
229
Slowdown will sleep that amount between objects. The default is 0.01 seconds.
227
230
.RE
228
231
.PD
229
232
 
232
235
.IP "\fB[object-auditor]\fR"
233
236
.RE
234
237
.RS 3
235
 
.IP \fBlog_name\fR 
 
238
.IP \fBlog_name\fR
236
239
Label used when logging. The default is object-auditor.
237
 
.IP \fBlog_facility\fR 
 
240
.IP \fBlog_facility\fR
238
241
Syslog log facility. The default is LOG_LOCAL0.
239
 
.IP \fBlog_level\fR 
 
242
.IP \fBlog_level\fR
240
243
Logging level. The default is INFO.
241
244
.IP \fBlog_address\fR
242
245
Logging address. The default is /dev/log.
243
246
 
244
 
.IP \fBfiles_per_second\fR 
245
 
Maximum files audited per second. Should be tuned according to individual 
246
 
system specs. 0 is unlimited. The default is 20. 
247
 
.IP \fBbytes_per_second\fR 
248
 
Maximum bytes audited per second. Should be tuned according to individual 
249
 
system specs. 0 is unlimited. The default is 10000000. 
250
 
.IP \fBlog_time\fR 
 
247
.IP \fBfiles_per_second\fR
 
248
Maximum files audited per second. Should be tuned according to individual
 
249
system specs. 0 is unlimited. The default is 20.
 
250
.IP \fBbytes_per_second\fR
 
251
Maximum bytes audited per second. Should be tuned according to individual
 
252
system specs. 0 is unlimited. The default is 10000000.
 
253
.IP \fBlog_time\fR
251
254
The default is 3600 seconds.
252
 
.IP \fBzero_byte_files_per_second\fR 
253
 
The default is 50. 
 
255
.IP \fBzero_byte_files_per_second\fR
 
256
The default is 50.
254
257
.RE
255
258
 
256
259
 
257
260
 
258
 
 
 
261
 
259
262
.SH DOCUMENTATION
260
263
.LP
261
264
More in depth documentation about the swift-object-server and
262
 
also Openstack-Swift as a whole can be found at 
263
 
.BI http://swift.openstack.org/admin_guide.html 
264
 
and 
 
265
also Openstack-Swift as a whole can be found at
 
266
.BI http://swift.openstack.org/admin_guide.html
 
267
and
265
268
.BI http://swift.openstack.org
266
269
 
267
270