Skip to content
This repository
Browse code

docs/config: added docs for bucket-support setting

Related to #263.
  • Loading branch information...
commit 6aa3990f34465caeabe641e2ee98f2e580a5f632 1 parent 7a093f9
Francisco Souza authored January 22, 2013

Showing 1 changed file with 25 additions and 12 deletions. Show diff stats Hide diff stats

  1. 37  docs/config.rst
37  docs/config.rst
Source Rendered
@@ -160,26 +160,34 @@ optional, and defaults to "tsuru-key".
160 160
 Amazon Web Services (AWS) configuration
161 161
 ---------------------------------------
162 162
 
163  
-Tsuru uses Amazon Web Services (AWS) Simple Storage Service (S3) to provide
164  
-static storage for apps. In the process of app creation, tsuru creates a S3
165  
-bucket and AWS Identity and Access Management (IAM) credentials to access this
166  
-bucket. In order to be able to comunicate with AWS API's, tsuru needs some
167  
-settings, listed below.
  163
+Tsuru is able to use Amazon Web Services (AWS) Simple Storage Service (S3) to
  164
+provide static storage for apps. Whenever ``bucket-support`` is true, Tsuru
  165
+will create a S3 bucket and AWS Identity and Access Management (IAM)
  166
+credentials to access this bucket during the app creation process. In order to
  167
+be able to comunicate with AWS API's, tsuru needs some settings, listed below.
168 168
 
169 169
 For more details on AWS authentication, AWS AIM and AWS S3, check AWS docs:
170 170
 https://aws.amazon.com/documentation/.
171 171
 
  172
+bucket-support
  173
+++++++++++++++
  174
+
  175
+``bucket-support`` is a boolean flag, that turns on the bucket per app feature.
  176
+This field is optional, and defaults to false.
  177
+
172 178
 aws:access-key-id
173 179
 +++++++++++++++++
174 180
 
175 181
 ``aws:access-key-id`` is the access key ID used by tsuru to authenticate with
176  
-AWS API. This setting is required and has no default value.
  182
+AWS API. Given that ``bucket-support`` is true, this setting is required and
  183
+has no default value.
177 184
 
178 185
 aws:secret-access-key
179 186
 +++++++++++++++++++++
180 187
 
181 188
 ``aws:secret-access-key`` is the secret access key used by tsuru to
182  
-authenticate with AWS API. This setting is required and has no default value.
  189
+authenticate with AWS API. Given that ``bucket-support`` is true, this
  190
+setting is required and has no default value.
183 191
 
184 192
 aws:iam:endpoint
185 193
 ++++++++++++++++
@@ -193,19 +201,22 @@ aws:s3:region-name
193 201
 ++++++++++++++++++
194 202
 
195 203
 ``aws:s3:region-name`` is the name of the region that tsuru will use to create
196  
-S3 buckets. This setting is required and has no default value.
  204
+S3 buckets. Given that ``bucket-support`` is true, this setting is required and
  205
+has no default value.
197 206
 
198 207
 aws:s3:endpoint
199 208
 +++++++++++++++
200 209
 
201 210
 ``aws:s3:endpoint`` is the S3 endpoint that tsuru will call to create buckets
202  
-for its applications. This setting is required and has no default value.
  211
+for its applications. Given that ``bucket-support`` is true, this setting is
  212
+required and has no default value.
203 213
 
204 214
 aws:s3:location-constraint
205 215
 ++++++++++++++++++++++++++
206 216
 
207 217
 ``aws:s3:location-constraint`` indicates whether buckets should be stored in
208  
-the selected region. This setting is required and has no default value.
  218
+the selected region. Given that ``bucket-support`` is true, this setting is
  219
+required and has no default value.
209 220
 
210 221
 For more details, check the documentation for buckets and regions:
211 222
 http://docs.aws.amazon.com/AmazonS3/latest/dev/LocationSelection.html.
@@ -214,7 +225,8 @@ aws:s3:lowercase-bucket
214 225
 +++++++++++++++++++++++
215 226
 
216 227
 ``aws:s3:lowercase-bucket`` will be true if the region requires bucket names to
217  
-be lowercase. This setting is required and has no default value.
  228
+be lowercase. Given that ``bucket-support`` is true, this setting is required
  229
+and has no default value.
218 230
 
219 231
 provisioner
220 232
 +++++++++++
@@ -247,7 +259,7 @@ Juju provisioner configuration
247 259
 Sample file
248 260
 ===========
249 261
 
250  
-Here is a complete example, with VPC, HTTP/TLS and load balacing enabled:
  262
+Here is a complete example, with S3, VPC, HTTP/TLS and load balacing enabled:
251 263
 
252 264
 .. highlight:: yaml
253 265
 
@@ -270,6 +282,7 @@ Here is a complete example, with VPC, HTTP/TLS and load balacing enabled:
270 282
       salt: salt
271 283
       token-expire-days: 14
272 284
       token-key: key
  285
+    bucket-support: true
273 286
     aws:
274 287
       access-key-id: access-key
275 288
       secret-access-key: s3cr3t

0 notes on commit 6aa3990

Please sign in to comment.
Something went wrong with that request. Please try again.