Skip to content

Commit 41b91f3

Browse files
jamtur01stack72
jamtur01
authored and
stack72
committed
website: Quick pass over some docs pages (hashicorp#9705)
* Pass over the Fastly docs * Pass over the file provisioner docs
1 parent 113b74d commit 41b91f3

2 files changed

Lines changed: 99 additions & 100 deletions

File tree

‎website/source/docs/providers/fastly/r/service_v1.html.markdown‎

Lines changed: 92 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: |-
99
# fastly\_service\_v1
1010

1111
Provides a Fastly Service, representing the configuration for a website, app,
12-
api, or anything else to be served through Fastly. A Service encompasses Domains
12+
API, or anything else to be served through Fastly. A Service encompasses Domains
1313
and Backends.
1414

1515
The Service resource requires a domain name that is correctly set up to direct
@@ -40,7 +40,7 @@ resource "fastly_service_v1" "demo" {
4040
4141
```
4242

43-
Basic usage with an Amazon S3 Website, and removes the `x-amz-request-id` header:
43+
Basic usage with an Amazon S3 Website and that removes the `x-amz-request-id` header:
4444

4545
```
4646
resource "fastly_service_v1" "demo" {
@@ -86,7 +86,9 @@ resource "aws_s3_bucket" "website" {
8686
}
8787
```
8888

89-
Basic usage with [custom VCL](https://docs.fastly.com/guides/vcl/uploading-custom-vcl) (must be enabled on your Fastly account):
89+
Basic usage with [custom
90+
VCL](https://docs.fastly.com/guides/vcl/uploading-custom-vcl) (must be
91+
enabled on your Fastly account):
9092

9193
```
9294
resource "fastly_service_v1" "demo" {
@@ -118,7 +120,7 @@ resource "fastly_service_v1" "demo" {
118120
}
119121
```
120122

121-
**Note:** For an AWS S3 Bucket, the Backend address is
123+
-> **Note:** For an AWS S3 Bucket, the Backend address is
122124
`<domain>.s3-website-<region>.amazonaws.com`. The `default_host` attribute
123125
should be set to `<bucket_name>.s3-website-<region>.amazonaws.com`. See the
124126
Fastly documentation on [Amazon S3][fastly-s3].
@@ -127,164 +129,159 @@ Fastly documentation on [Amazon S3][fastly-s3].
127129

128130
The following arguments are supported:
129131

130-
* `name` - (Required) The unique name for the Service to create
132+
* `name` - (Required) The unique name for the Service to create.
131133
* `domain` - (Required) A set of Domain names to serve as entry points for your
132-
Service. Defined below
134+
Service. Defined below.
133135
* `backend` - (Required) A set of Backends to service requests from your Domains.
134-
Defined below
136+
Defined below.
135137
* `condition` - (Optional) A set of conditions to add logic to any basic
136-
configuration object in this service. Defined below
138+
configuration object in this service. Defined below.
137139
* `cache_setting` - (Optional) A set of Cache Settings, allowing you to override
138140
when an item is not to be cached based on an above `condition`. Defined below
139141
* `gzip` - (Required) A set of gzip rules to control automatic gzipping of
140-
content. Defined below
142+
content. Defined below.
141143
* `header` - (Optional) A set of Headers to manipulate for each request. Defined
142-
below
143-
* `default_host` - (Optional) The default hostname
144-
* `default_ttl` - (Optional) The default Time-to-live (TTL) for requests
144+
below.
145+
* `default_host` - (Optional) The default hostname.
146+
* `default_ttl` - (Optional) The default Time-to-live (TTL) for
147+
requests.
145148
* `force_destroy` - (Optional) Services that are active cannot be destroyed. In
146149
order to destroy the Service, set `force_destroy` to `true`. Default `false`.
147150
* `request_setting` - (Optional) A set of Request modifiers. Defined below
148151
* `s3logging` - (Optional) A set of S3 Buckets to send streaming logs too.
149-
Defined below
150-
* `vcl` - (Optional) A set of custom VCL configuration blocks. Note that the
152+
Defined below.
153+
* `vcl` - (Optional) A set of custom VCL configuration blocks. The
151154
ability to upload custom VCL code is not enabled by default for new Fastly
152155
accounts (see the [Fastly documentation](https://docs.fastly.com/guides/vcl/uploading-custom-vcl) for details).
153156

154-
155157
The `domain` block supports:
156158

157-
* `name` - (Required) The domain that this Service will respond to
158-
* `comment` - (Optional) An optional comment about the Domain
159+
* `name` - (Required) The domain to which this Service will respond.
160+
* `comment` - (Optional) An optional comment about the Domain.
159161

160162
The `backend` block supports:
161163

162-
* `name` - (Required, string) Name for this Backend. Must be unique to this Service
163-
* `address` - (Required, string) An IPv4, hostname, or IPv6 address for the Backend
164-
* `auto_loadbalance` - (Optional, boolean) Denote if this Backend should be
164+
* `name` - (Required, string) Name for this Backend. Must be unique to this Service.
165+
* `address` - (Required, string) An IPv4, hostname, or IPv6 address for the Backend.
166+
* `auto_loadbalance` - (Optional, boolean) Denotes if this Backend should be
165167
included in the pool of backends that requests are load balanced against.
166-
Default `true`
167-
* `between_bytes_timeout` - (Optional) How long to wait between bytes in milliseconds. Default `10000`
168+
Default `true`.
169+
* `between_bytes_timeout` - (Optional) How long to wait between bytes in milliseconds. Default `10000`.
168170
* `connect_timeout` - (Optional) How long to wait for a timeout in milliseconds.
169171
Default `1000`
170-
* `error_threshold` - (Optional) Number of errors to allow before the Backend is marked as down. Default `0`
171-
* `first_byte_timeout` - (Optional) How long to wait for the first bytes in milliseconds. Default `15000`
172+
* `error_threshold` - (Optional) Number of errors to allow before the Backend is marked as down. Default `0`.
173+
* `first_byte_timeout` - (Optional) How long to wait for the first bytes in milliseconds. Default `15000`.
172174
* `max_conn` - (Optional) Maximum number of connections for this Backend.
173-
Default `200`
174-
* `port` - (Optional) The port number Backend responds on. Default `80`
175-
* `ssl_check_cert` - (Optional) Be strict on checking SSL certs. Default `true`
176-
* `weight` - (Optional) The [portion of traffic](https://docs.fastly.com/guides/performance-tuning/load-balancing-configuration.html#how-weight-affects-load-balancing) to send to this Backend. Each Backend receives `weight / total` of the traffic. Default `100`
175+
Default `200`.
176+
* `port` - (Optional) The port number on which the Backend responds. Default `80`.
177+
* `ssl_check_cert` - (Optional) Be strict about checking SSL certs. Default `true`.
178+
* `weight` - (Optional) The [portion of traffic](https://docs.fastly.com/guides/performance-tuning/load-balancing-configuration.html#how-weight-affects-load-balancing) to send to this Backend. Each Backend receives `weight / total` of the traffic. Default `100`.
177179

178180
The `condition` block supports allows you to add logic to any basic configuration
179181
object in a service. See Fastly's documentation
180182
["About Conditions"](https://docs.fastly.com/guides/conditions/about-conditions)
181183
for more detailed information on using Conditions. The Condition `name` can be
182184
used in the `request_condition`, `response_condition`, or
183-
`cache_condition` attributes of other block settings
185+
`cache_condition` attributes of other block settings.
184186

185-
* `name` - (Required) A unique name of the condition
186-
* `statement` - (Required) The statement used to determine if the condition is met
187+
* `name` - (Required) The unique name for the condition.
188+
* `statement` - (Required) The statement used to determine if the condition is met.
187189
* `priority` - (Required) A number used to determine the order in which multiple
188-
conditions execute. Lower numbers execute first
189-
* `type` - (Required) Type of the condition, either `REQUEST` (req), `RESPONSE`
190-
(req, resp), or `CACHE` (req, beresp)
190+
conditions execute. Lower numbers execute first.
191+
* `type` - (Required) Type of condition, either `REQUEST` (req), `RESPONSE`
192+
(req, resp), or `CACHE` (req, beresp).
191193

192194
The `cache_setting` block supports:
193195

194-
* `name` - (Required) A unique name to label this Cache Setting
196+
* `name` - (Required) Unique name for this Cache Setting.
195197
* `action` - (Required) One of `cache`, `pass`, or `restart`, as defined
196-
on Fastly's documentation under ["Caching action descriptions"](https://docs.fastly.com/guides/performance-tuning/controlling-caching#caching-action-descriptions)
197-
* `cache_condition` - (Required) Name of the condition used to test whether this settings object should be used.
198-
This Condition must be of type `CACHE`
198+
on Fastly's documentation under ["Caching action descriptions"](https://docs.fastly.com/guides/performance-tuning/controlling-caching#caching-action-descriptions).
199+
* `cache_condition` - (Required) Name of the condition used to test whether this settings object should be used. This Condition must be of type `CACHE`.
199200
* `stale_ttl` - (Optional) Max "Time To Live" for stale (unreachable) objects.
200-
Default `300`
201-
* `ttl` - (Optional) The "Time To Live" for the object
201+
Default `300`.
202+
* `ttl` - (Optional) The Time-To-Live (TTL) for the object.
202203

203204
The `gzip` block supports:
204205

205-
* `name` - (Required) A unique name
206-
* `content_types` - (Optional) content-type for each type of content you wish to
207-
have dynamically gzipped. Ex: `["text/html", "text/css"]`
206+
* `name` - (Required) A unique name.
207+
* `content_types` - (Optional) The content-type for each type of content you wish to
208+
have dynamically gzip'ed. Example: `["text/html", "text/css"]`.
208209
* `extensions` - (Optional) File extensions for each file type to dynamically
209-
gzip. Ex: `["css", "js"]`
210+
gzip. Example: `["css", "js"]`.
210211

211212

212213
The `Header` block supports adding, removing, or modifying Request and Response
213214
headers. See Fastly's documentation on
214-
[Adding or modifying headers on HTTP requests and responses](https://docs.fastly.com/guides/basic-configuration/adding-or-modifying-headers-on-http-requests-and-responses#field-description-table) for more detailed information on any
215-
of the properties below.
215+
[Adding or modifying headers on HTTP requests and responses](https://docs.fastly.com/guides/basic-configuration/adding-or-modifying-headers-on-http-requests-and-responses#field-description-table) for more detailed information on any of the properties below.
216216

217-
* `name` - (Required) A unique name to refer to this header attribute
217+
* `name` - (Required) Unique name for this header attribute.
218218
* `action` - (Required) The Header manipulation action to take; must be one of
219-
`set`, `append`, `delete`, `regex`, or `regex_repeat`
220-
* `type` - (Required) The Request type to apply the selected Action on; must be one of `request`, `fetch`, `cache` or `response`
221-
* `destination` - (Required) The name of the header that is going to be affected
222-
by the Action
223-
* `ignore_if_set` - (Optional) Do not add the header if it is already present.
224-
(Only applies to `set` action.). Default `false`
225-
* `source` - (Optional) Variable to be used as a source for the header content
226-
(Does not apply to `delete` action.)
227-
* `regex` - (Optional) Regular expression to use (Only applies to `regex` and `regex_repeat` actions.)
228-
* `substitution` - (Optional) Value to substitute in place of regular expression. (Only applies to `regex` and `regex_repeat`.)
229-
* `priority` - (Optional) Lower priorities execute first. (Default: `100`.)
219+
`set`, `append`, `delete`, `regex`, or `regex_repeat`.
220+
* `type` - (Required) The Request type on which to apply the selected Action; must be one of `request`, `fetch`, `cache` or `response`.
221+
* `destination` - (Required) The name of the header that is going to be affected by the Action.
222+
* `ignore_if_set` - (Optional) Do not add the header if it is already present. (Only applies to the `set` action.). Default `false`.
223+
* `source` - (Optional) Variable to be used as a source for the header
224+
content. (Does not apply to the `delete` action.)
225+
* `regex` - (Optional) Regular expression to use (Only applies to the `regex` and `regex_repeat` actions.)
226+
* `substitution` - (Optional) Value to substitute in place of regular expression. (Only applies to the `regex` and `regex_repeat` actions.)
227+
* `priority` - (Optional) Lower priorities execute first. Default: `100`.
230228

231229
The `request_setting` block allow you to customize Fastly's request handling, by
232230
defining behavior that should change based on a predefined `condition`:
233231

234-
* `name` - (Required) The domain that this request setting
232+
* `name` - (Required) The domain for this request setting.
235233
* `request_condition` - (Required) The name of the corresponding `condition` to
236-
determin if this request setting should be applied. The `request_condition` must
237-
match the name of a defined `condition`
234+
determine if this request setting should be applied. The `request_condition` must
235+
match the name of a defined `condition`.
238236
* `max_stale_age` - (Optional) How old an object is allowed to be to serve
239-
stale-if-error or stale-while-revalidate, in seconds. Default `60`
240-
* `force_miss` - (Optional) Force a cache miss for the request. If specfified,
237+
`stale-if-error` or `stale-while-revalidate`, in seconds. Default `60`.
238+
* `force_miss` - (Optional) Force a cache miss for the request. If specified,
241239
can be `true` or `false`.
242-
* `force_ssl` - (Optional) Forces the request use SSL (redirects a non-SSL to SSL)
240+
* `force_ssl` - (Optional) Forces the request to use SSL (Redirects a non-SSL request to SSL).
243241
* `action` - (Optional) Allows you to terminate request handling and immediately
244-
perform an action. When set it can be `lookup` or `pass` (ignore the cache completely)
242+
perform an action. When set it can be `lookup` or `pass` (Ignore the cache completely).
245243
* `bypass_busy_wait` - (Optional) Disable collapsed forwarding, so you don't wait
246-
for other objects to origin
244+
for other objects to origin.
247245
* `hash_keys` - (Optional) Comma separated list of varnish request object fields
248-
that should be in the hash key
249-
* `xff` - (Optional) X-Forwarded-For -- should be `clear`, `leave`, `append`,
250-
`append_all`, or `overwrite`. Default `append`
246+
that should be in the hash key.
247+
* `xff` - (Optional) X-Forwarded-For, should be `clear`, `leave`, `append`,
248+
`append_all`, or `overwrite`. Default `append`.
251249
* `timer_support` - (Optional) Injects the X-Timer info into the request for
252-
viewing origin fetch durations
250+
viewing origin fetch durations.
253251
* `geo_headers` - (Optional) Injects Fastly-Geo-Country, Fastly-Geo-City, and
254-
Fastly-Geo-Region into the request headers
255-
* `default_host` - (Optional) Sets the host header
252+
Fastly-Geo-Region into the request headers.
253+
* `default_host` - (Optional) Sets the host header.
256254

257255
The `s3logging` block supports:
258256

259-
* `name` - (Required) A unique name to identify this S3 Logging Bucket
260-
* `bucket_name` - (Optional) An optional comment about the Domain
257+
* `name` - (Required) A unique name to identify this S3 Logging Bucket.
258+
* `bucket_name` - (Optional) An optional comment about the Domain.
261259
* `s3_access_key` - (Required) AWS Access Key of an account with the required
262260
permissions to post logs. It is **strongly** recommended you create a separate
263261
IAM user with permissions to only operate on this Bucket. This key will be
264-
not be encrypted. You can provide this key via an environment variable, `FASTLY_S3_ACCESS_KEY`
262+
not be encrypted. You can provide this key via an environment variable, `FASTLY_S3_ACCESS_KEY`.
265263
* `s3_secret_key` - (Required) AWS Secret Key of an account with the required
266264
permissions to post logs. It is **strongly** recommended you create a separate
267265
IAM user with permissions to only operate on this Bucket. This secret will be
268-
not be encrypted. You can provide this secret via an environment variable, `FASTLY_S3_SECRET_KEY`
266+
not be encrypted. You can provide this secret via an environment variable, `FASTLY_S3_SECRET_KEY`.
269267
* `path` - (Optional) Path to store the files. Must end with a trailing slash.
270268
If this field is left empty, the files will be saved in the bucket's root path.
271269
* `domain` - (Optional) If you created the S3 bucket outside of `us-east-1`,
272-
then specify the corresponding bucket endpoint. Ex: `s3-us-west-2.amazonaws.com`
270+
then specify the corresponding bucket endpoint. Example: `s3-us-west-2.amazonaws.com`.
273271
* `period` - (Optional) How frequently the logs should be transferred, in
274-
seconds. Default `3600`
272+
seconds. Default `3600`.
275273
* `gzip_level` - (Optional) Level of GZIP compression, from `0-9`. `0` is no
276274
compression. `1` is fastest and least compressed, `9` is slowest and most
277-
compressed. Default `0`
278-
* `format` - (Optional) Apache-style string or VCL variables to use for log formatting. Default
279-
Apache Common Log format (`%h %l %u %t %r %>s`)
275+
compressed. Default `0`.
276+
* `format` - (Optional) Apache-style string or VCL variables to use for log formatting. Defaults to Apache Common Log format (`%h %l %u %t %r %>s`)
280277
* `timestamp_format` - (Optional) `strftime` specified timestamp formatting (default `%Y-%m-%dT%H:%M:%S.000`).
281278
* `request_condition` - (Optional) The VCL request condition to check if this
282279
Request Setting should be applied. For detailed information about Conditionals,
283-
see [Fastly's Documentation on Conditionals][fastly-conditionals]
280+
see [Fastly's Documentation on Conditionals][fastly-conditionals].
284281

285282
The `vcl` block supports:
286283

287-
* `name` - (Required) A unique name for this configuration block
284+
* `name` - (Required) A unique name for this configuration block.
288285
* `content` - (Required) The custom VCL code to upload.
289286
* `main` - (Optional) If `true`, use this block as the main configuration. If
290287
`false`, use this block as an includable library. Only a single VCL block can be
@@ -294,18 +291,18 @@ marked as the main block. Default is `false`.
294291

295292
The following attributes are exported:
296293

297-
* `id` - The ID of the Service
298-
* `name` – Name of this service
299-
* `active_version` - The currently active version of your Fastly Service
300-
* `domain` – Set of Domains. See above for details
301-
* `backend` – Set of Backends. See above for details
302-
* `header` – Set of Headers. See above for details
303-
* `s3logging` – Set of S3 Logging configurations. See above for details
304-
* `vcl` – Set of custom VCL configurations. See above for details
305-
* `default_host` – Default host specified
306-
* `default_ttl` - Default TTL
307-
* `force_destroy` - Force the destruction of the Service on delete
308-
294+
* `id` - The ID of the Service.
295+
* `name` – Name of this service.
296+
* `active_version` - The currently active version of your Fastly
297+
Service.
298+
* `domain` – Set of Domains. See above for details.
299+
* `backend` – Set of Backends. See above for details.
300+
* `header` – Set of Headers. See above for details.
301+
* `s3logging` – Set of S3 Logging configurations. See above for details.
302+
* `vcl` – Set of custom VCL configurations. See above for details.
303+
* `default_host` – Default host specified.
304+
* `default_ttl` - Default TTL.
305+
* `force_destroy` - Force the destruction of the Service on delete.
309306

310307
[fastly-s3]: https://docs.fastly.com/guides/integrations/amazon-s3
311308
[fastly-cname]: https://docs.fastly.com/guides/basic-setup/adding-cname-records

‎website/source/docs/provisioners/file.html.markdown‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,13 @@ resource "aws_instance" "web" {
4848

4949
The following arguments are supported:
5050

51-
* `source` - This is the source file or folder. It can be specified as relative
52-
to the current working directory or as an absolute path. This attribute cannot be specifed with `content`.
51+
* `source` - This is the source file or folder. It can be specified as
52+
relative to the current working directory or as an absolute path. This
53+
attribute cannot be specified with `content`.
5354

5455
* `content` - This is the content to copy on the destination. If destination is a file,
5556
the content will be written on that file, in case of a directory a file named
56-
*tf-file-content* is created. It's recommended to use a file as destination. A
57+
`tf-file-content` is created. It's recommended to use a file as the destination. A
5758
[`template_file`](/docs/providers/template/d/file.html) might be referenced in here, or
5859
any interpolation syntax. This attribute cannot be specified with `source`.
5960

@@ -81,6 +82,7 @@ of `/foo` on the local machine will be uploaded to `/tmp/foo` on the remote mach
8182
If the source, however, is `/foo/` (a trailing slash is present), and the destination is
8283
`/tmp`, then the contents of `/foo` will be uploaded directly into `/tmp` directly.
8384

84-
This behavior was adopted from the standard behavior of rsync.
85+
This behavior was adopted from the standard behavior of
86+
[rsync](https://linux.die.net/man/1/rsync).
8587

86-
**Note:** Under the covers, rsync may or may not be used.
88+
-> **Note:** Under the covers, rsync may or may not be used.

0 commit comments

Comments
 (0)