← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/manpages/container-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/container-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 container-server.conf 5 "8/26/2011" "Linux" "OpenStack Swift"
19
19
 
20
 
.SH NAME 
 
20
.SH NAME
21
21
.LP
22
22
.B container-server.conf
23
 
\- configuration file for the openstack-swift container server 
 
23
\- configuration file for the openstack-swift container 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 container server and other container 
36
 
background services, such as; replicator, updater, auditor and sync. 
 
35
This is the configuration file used by the container server and other container
 
36
background services, such as; replicator, updater, auditor and sync.
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 container server should bind to. The default is 0.0.0.0 which will make 
 
56
IP address the container 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 container server should bind to. The default is 6001. 
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 container server workers to fork. The default is 1. 
64
 
.IP \fBuser\fR 
65
 
The system user that the container server will run as. The default is swift. 
66
 
.IP \fBswift_dir\fR 
 
58
.IP "\fBbind_port\fR"
 
59
TCP port the container server should bind to. The default is 6001.
 
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 container server workers to fork. The default is 1.
 
64
.IP \fBuser\fR
 
65
The system user that the container 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 
95
 
container-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
 
95
recon container-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:container-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 container server. This is the reference to the installed python egg. 
108
 
The default is \fBegg:swift#container\fR.
109
 
.IP "\fBset log_name\fR 
 
107
Entry point for paste.deploy for the container server. This is the reference to the installed python egg.
 
108
This is normally \fBegg:swift#container\fR.
 
109
.IP "\fBset log_name\fR
110
110
Label used when logging. The default is container-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
 
.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. 
 
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.
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".
 
143
.RE
 
144
 
 
145
.RS 0
 
146
.IP "\fB[filter:recon]\fR"
 
147
.RS 3
 
148
.IP "\fBuse\fR"
 
149
Entry point for paste.deploy for the recon middleware. This is the reference to the installed python egg.
 
150
This is normally \fBegg:swift#recon\fR.
 
151
.IP "\fBrecon_cache_path\fR"
 
152
The recon_cache_path simply sets the directory where stats for a few items will be stored.
 
153
Depending on the method of deployment you may need to create this directory manually
 
154
and ensure that swift has read/write. The default is /var/cache/swift.
140
155
.RE
141
156
.PD
142
157
 
150
165
.IP "\fB[container-replicator]\fR"
151
166
.RE
152
167
.RS 3
153
 
.IP \fBlog_name\fR 
 
168
.IP \fBlog_name\fR
154
169
Label used when logging. The default is container-replicator.
155
 
.IP \fBlog_facility\fR 
 
170
.IP \fBlog_facility\fR
156
171
Syslog log facility. The default is LOG_LOCAL0.
157
 
.IP \fBlog_level\fR 
 
172
.IP \fBlog_level\fR
158
173
Logging level. The default is INFO.
159
174
.IP \fBlog_address\fR
160
175
Logging address. The default is /dev/log.
161
 
.IP \fBvm_test_mode\fR 
 
176
.IP \fBvm_test_mode\fR
162
177
Indicates that you are using a VM environment. The default is no.
163
 
.IP \fBer_diff\fR 
 
178
.IP \fBer_diff\fR
164
179
The default is 1000.
165
180
.IP \fBmax_diffs\fR
166
181
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.
167
 
.IP \fBconcurrency\fR 
 
182
.IP \fBconcurrency\fR
168
183
Number of replication workers to spawn. The default is 8.
169
184
.IP "\fBrun_pause [deprecated]\fR"
170
185
Time in seconds to wait between replication passes. The default is 10.
171
186
.IP \fBinterval\fR
172
187
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 30.
173
 
.IP \fBnode_timeout\fR 
174
 
Request timeout to external services. The default is 10 seconds. 
175
 
.IP \fBconn_timeout\fR 
176
 
Connection timeout to external services. The default is 0.5 seconds. 
177
 
.IP \fBreclaim_age\fR 
178
 
Time elapsed in seconds before an container can be reclaimed. The default is 
179
 
604800 seconds. 
 
188
.IP \fBnode_timeout\fR
 
189
Request timeout to external services. The default is 10 seconds.
 
190
.IP \fBconn_timeout\fR
 
191
Connection timeout to external services. The default is 0.5 seconds.
 
192
.IP \fBreclaim_age\fR
 
193
Time elapsed in seconds before an container can be reclaimed. The default is
 
194
604800 seconds.
180
195
.RE
181
196
 
182
197
 
184
199
.IP "\fB[container-updater]\fR"
185
200
.RE
186
201
.RS 3
187
 
.IP \fBlog_name\fR 
 
202
.IP \fBlog_name\fR
188
203
Label used when logging. The default is container-updater.
189
 
.IP \fBlog_facility\fR 
 
204
.IP \fBlog_facility\fR
190
205
Syslog log facility. The default is LOG_LOCAL0.
191
 
.IP \fBlog_level\fR 
 
206
.IP \fBlog_level\fR
192
207
Logging level. The default is INFO.
193
208
.IP \fBlog_address\fR
194
209
Logging address. The default is /dev/log.
195
 
.IP \fBinterval\fR 
196
 
Minimum time for a pass to take. The default is 300 seconds. 
197
 
.IP \fBconcurrency\fR 
198
 
Number of reaper workers to spawn. The default is 4. 
199
 
.IP \fBnode_timeout\fR 
200
 
Request timeout to external services. The default is 3 seconds. 
201
 
.IP \fBconn_timeout\fR 
202
 
Connection timeout to external services. The default is 0.5 seconds. 
 
210
.IP \fBinterval\fR
 
211
Minimum time for a pass to take. The default is 300 seconds.
 
212
.IP \fBconcurrency\fR
 
213
Number of reaper workers to spawn. The default is 4.
 
214
.IP \fBnode_timeout\fR
 
215
Request timeout to external services. The default is 3 seconds.
 
216
.IP \fBconn_timeout\fR
 
217
Connection timeout to external services. The default is 0.5 seconds.
203
218
.IP \fBslowdown = 0.01\fR
204
 
Slowdown will sleep that amount between containers. The default is 0.01 seconds. 
 
219
Slowdown will sleep that amount between containers. The default is 0.01 seconds.
205
220
.IP \fBaccount_suppression_time\fR
206
221
Seconds to suppress updating an account that has generated an error. The default is 60 seconds.
207
222
.RE
212
227
.IP "\fB[container-auditor]\fR"
213
228
.RE
214
229
.RS 3
215
 
.IP \fBlog_name\fR 
 
230
.IP \fBlog_name\fR
216
231
Label used when logging. The default is container-auditor.
217
 
.IP \fBlog_facility\fR 
 
232
.IP \fBlog_facility\fR
218
233
Syslog log facility. The default is LOG_LOCAL0.
219
 
.IP \fBlog_level\fR 
 
234
.IP \fBlog_level\fR
220
235
Logging level. The default is INFO.
221
236
.IP \fBlog_address\fR
222
237
Logging address. The default is /dev/log.
223
 
.IP \fBinterval\fR 
224
 
Will audit, at most, 1 container per device per interval. The default is 1800 seconds. 
 
238
.IP \fBinterval\fR
 
239
Will audit, at most, 1 container per device per interval. The default is 1800 seconds.
225
240
.RE
226
241
 
227
242
 
230
245
.IP "\fB[container-sync]\fR"
231
246
.RE
232
247
.RS 3
233
 
.IP \fBlog_name\fR 
 
248
.IP \fBlog_name\fR
234
249
Label used when logging. The default is container-sync.
235
 
.IP \fBlog_facility\fR 
 
250
.IP \fBlog_facility\fR
236
251
Syslog log facility. The default is LOG_LOCAL0.
237
 
.IP \fBlog_level\fR 
 
252
.IP \fBlog_level\fR
238
253
Logging level. The default is INFO.
239
254
.IP \fBlog_address\fR
240
255
Logging address. The default is /dev/log.
241
256
.IP \fBsync_proxy\fR
242
257
If you need to use an HTTP Proxy, set it here; defaults to no proxy.
243
 
.IP \fBinterval\fR 
244
 
Will audit, at most, each container once per interval. The default is 300 seconds. 
 
258
.IP \fBinterval\fR
 
259
Will audit, at most, each container once per interval. The default is 300 seconds.
245
260
.IP \fBcontainer_time\fR
246
261
Maximum amount of time to spend syncing each container per pass. The default is 60 seconds.
247
262
.RE
249
264
 
250
265
 
251
266
 
252
 
 
 
267
 
253
268
.SH DOCUMENTATION
254
269
.LP
255
270
More in depth documentation about the swift-container-server and
256
 
also Openstack-Swift as a whole can be found at 
257
 
.BI http://swift.openstack.org/admin_guide.html 
258
 
and 
 
271
also Openstack-Swift as a whole can be found at
 
272
.BI http://swift.openstack.org/admin_guide.html
 
273
and
259
274
.BI http://swift.openstack.org
260
275
 
261
276