Updated the examples (#9293)

1. Changed the `Example Contents` header to something more descriptive.
2. Minor edits for grammar and formatting.
This commit is contained in:
James Turnbull 2016-10-09 05:42:39 -04:00 committed by Radek Simko
parent c1a359c723
commit 28cbd48cd3
4 changed files with 20 additions and 20 deletions

View File

@ -8,13 +8,13 @@ description: |-
# Basic Two-Tier AWS Architecture
[**Example Contents**](https://github.com/hashicorp/terraform/tree/master/examples/aws-two-tier)
[**Example Source Code**](https://github.com/hashicorp/terraform/tree/master/examples/aws-two-tier)
This provides a template for running a simple two-tier architecture on Amazon
Web services. The premise is that you have stateless app servers running behind
Web Services. The premise is that you have stateless app servers running behind
an ELB serving traffic.
To simplify the example, this intentionally ignores deploying and
To simplify the example, it intentionally ignores deploying and
getting your application onto the servers. However, you could do so either via
[provisioners](/docs/provisioners/index.html) and a configuration
management tool, or by pre-baking configured AMIs with
@ -22,7 +22,7 @@ management tool, or by pre-baking configured AMIs with
After you run `terraform apply` on this configuration, it will
automatically output the DNS address of the ELB. After your instance
registers, this should respond with the default nginx web page.
registers, this should respond with the default Nginx web page.
As with all examples, just copy and paste the example and run
As with all the examples, just copy and paste the example and run
`terraform apply` to see it work.

View File

@ -8,7 +8,7 @@ description: |-
# Consul Example
[**Example Contents**](https://github.com/hashicorp/terraform/tree/master/examples/consul)
[**Example Source Code**](https://github.com/hashicorp/terraform/tree/master/examples/consul)
[Consul](https://www.consul.io) is a tool for service discovery, configuration
and orchestration. The Key/Value store it provides is often used to store
@ -20,14 +20,14 @@ can be used to interface with Consul from inside a Terraform configuration.
For our example, we use the [Consul demo cluster](http://demo.consul.io)
to both read configuration and store information about a newly created EC2 instance.
The size of the EC2 instance will be determined by the "tf\_test/size" key in Consul,
and will default to "m1.small" if that key does not exist. Once the instance is created
the "tf\_test/id" and "tf\_test/public\_dns" keys will be set with the computed
The size of the EC2 instance will be determined by the `tf\_test/size` key in Consul,
and will default to `m1.small` if that key does not exist. Once the instance is created
the `tf\_test/id` and `tf\_test/public\_dns` keys will be set with the computed
values for the instance.
Before we run the example, use the [Web UI](http://demo.consul.io/ui/#/nyc3/kv/)
to set the "tf\_test/size" key to "t1.micro". Once that is done,
copy the configuration into a configuration file ("consul.tf" works fine).
to set the `tf\_test/size` key to `t1.micro`. Once that is done,
copy the configuration into a configuration file (`consul.tf` works fine).
Either provide the AWS credentials as a default value in the configuration
or invoke `apply` with the appropriate variables set.
@ -38,14 +38,14 @@ set.
We can now teardown the infrastructure following the
[instructions here](/intro/getting-started/destroy.html). Because
we set the 'delete' property of two of the Consul keys, Terraform
we set the `delete` property of two of the Consul keys, Terraform
will cleanup those keys on destroy. We can verify this by using
the Web UI.
The point of this example is to show that Consul can be used with
Terraform both to enable dynamic inputs, but to also store outputs.
Inputs like AMI name, security groups, puppet roles, bootstrap scripts,
Inputs like AMI name, security groups, Puppet roles, bootstrap scripts,
etc can all be loaded from Consul. This allows the specifics of an
infrastructure to be decoupled from its overall architecture. This enables
details to be changed without updating the Terraform configuration.

View File

@ -8,13 +8,13 @@ description: |-
# Count Example
[**Example Contents**](https://github.com/hashicorp/terraform/tree/master/examples/aws-count)
[**Example Source Code**](https://github.com/hashicorp/terraform/tree/master/examples/aws-count)
The count parameter on resources can simplify configurations
The `count` parameter on resources can simplify configurations
and let you scale resources by simply incrementing a number.
Additionally, variables can be used to expand a list of resources
for use elsewhere.
As with all examples, just copy and paste the example and run
As with all the examples, just copy and paste the example and run
`terraform apply` to see it work.

View File

@ -3,19 +3,19 @@ layout: "intro"
page_title: "Cross Provider"
sidebar_current: "examples-cross-provider"
description: |-
This is a simple example of the cross-provider capabilities of Terraform.
An example of the cross-provider capabilities of Terraform.
---
# Cross Provider Example
[**Example Contents**](https://github.com/hashicorp/terraform/tree/master/examples/cross-provider)
[**Example Source Code**](https://github.com/hashicorp/terraform/tree/master/examples/cross-provider)
This is a simple example of the cross-provider capabilities of
Terraform.
Very simply, this creates a Heroku application and points a DNS
This creates a Heroku application and points a DNS
CNAME record at the result via DNSimple. A `host` query to the outputted
hostname should reveal the correct DNS configuration.
As with all examples, just copy and paste the example and run
As with all the examples, just copy and paste the example and run
`terraform apply` to see it work.