Skip to content

Commit

Permalink
Fixes markdownlint for examples
Browse files Browse the repository at this point in the history
  • Loading branch information
gdavison committed Aug 10, 2022
1 parent b70c9c4 commit b51a14b
Show file tree
Hide file tree
Showing 11 changed files with 21 additions and 20 deletions.
2 changes: 1 addition & 1 deletion examples/asg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To run, configure your AWS provider as described in https://www.terraform.io/doc

Running the example

For planning phase
For planning phase

```
terraform plan -var 'key_name={your_key_name}'
Expand Down
1 change: 1 addition & 0 deletions examples/ecs-alb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Alternatively to using `-var` with each command, the `terraform.template.tfvars`

Once the stack is created, wait for a few minutes and test the stack by launching a browser with the ALB url.

<!-- markdownlint-disable-next-line no-trailing-punctuation -->
## Destroy :boom:

```
Expand Down
4 changes: 2 additions & 2 deletions examples/eip/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Elastic IP Example

The eip example launches a web server, installs nginx. It also creates security group
The eip example launches a web server, installs nginx. It also creates security group.

To run, configure your AWS provider as described in https://www.terraform.io/docs/providers/aws/index.html

Running the example

run `terraform apply -var 'key_name={your_key_name}'`
run `terraform apply -var 'key_name={your_key_name}'`

Alternatively to using `-var` with each command, the `terraform.template.tfvars` file can be copied to `terraform.tfvars` and updated.

Expand Down
3 changes: 2 additions & 1 deletion examples/elasticsearch-domain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
This example creates an Elasticsearch Domain with [fine-grained access control](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/fgac.html) enabled

## Fine-Grained Access Control Requirements

- Elasticsearch 6.7 or later
- Encryption of data at rest and node-to-node encryption enabled
- Require HTTPS for all traffic to the domain enabled
Expand Down Expand Up @@ -34,4 +35,4 @@ To remove the stack

```bash
terraform destroy
```
```
6 changes: 3 additions & 3 deletions examples/elb/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# ELB with stickiness Example

The example launches a web server, installs nginx, creates an ELB for instance. It also creates security groups for the ELB and EC2 instance.
The example launches a web server, installs nginx, creates an ELB for instance. It also creates security groups for the ELB and EC2 instance.

To run, configure your AWS provider as described in https://www.terraform.io/docs/providers/aws/index.html

This example assumes you have created a Key Pair. Visit
https://console.aws.amazon.com/ec2/v2/home?region=us-east-1#KeyPairs:sort=keyName
to create a key if you do not have one.
to create a key if you do not have one.

Run this example using:

terraform apply -var 'key_name=YOUR_KEY_NAME'

Alternatively to using `-var` with each command, the `terraform.template.tfvars` file can be copied to `terraform.tfvars` and updated.

Wait a couple of minutes for the EC2 userdata to install nginx, and then type the ELB DNS Name from outputs in your browser and see the nginx welcome page
Wait a couple of minutes for the EC2 userdata to install nginx, and then type the ELB DNS Name from outputs in your browser and see the nginx welcome page.
5 changes: 3 additions & 2 deletions examples/lambda-file-systems/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@ To run, configure your AWS provider as described in https://www.terraform.io/doc

### Running the example

run `terraform apply` to see it work.
Run `terraform apply` to see it work.

### Test the lambda function

```bash
aws lambda invoke --region us-east-1 --function-name hello_lambda response.json
```
Invoke lambda function several times, check the content of response.json.

Invoke lambda function several times, check the content of `response.json`.

On each invoke, the lambda function will append one line of data to /mnt/efs/test.txt, and return all content from the file.
6 changes: 3 additions & 3 deletions examples/rds/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
## Creating an RDS instance in AWS
# Creating an RDS instance in AWS

This example provides sample configuration for creating a mysql or postgres instance. For Oracle/SQL Servers, replace default values with appropriate values, they are not included in sample since the number of options are high.

The example creates db subnet groups and a VPC security group as inputs to the instance creation

For AWS provider, set up your AWS environment as outlined in https://www.terraform.io/docs/providers/aws/index.html
For AWS provider, set up your AWS environment as outlined in https://www.terraform.io/docs/providers/aws/index.html.

If you need to use existing security groups and subnets, remove the `sg.tf` and `subnets.tf` files and replace the corresponding sections in `main.tf` under `aws_db_instance`

Pass the password variable through your ENV variable.

Several parameters are externalized, review the different variables.tf files and change them to fit your needs. Carefully review the CIDR blocks, egress/ingress rules, availability zones that are very specific to your account.

Once ready run `terraform plan` to review.
Once ready run `terraform plan` to review.
At the minimum, provide the vpc_id as input variable.

Once satisfied with plan, run `terraform apply`
Expand Down
3 changes: 2 additions & 1 deletion examples/s3-api-gateway-integration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ This example demonstrates how to create an S3 Proxy using AWS API Gateway. It ta
*Note: In order to see the API Gateway that this configuration creates you must navigate to the correct region in your AWS console. To ensure the API works as desired, the region you use to create the API should be different than the S3 buckets being queried. If not, you may encounter a 500 Internal Server Error response. This limitation does not apply to any deployed API.*

Only three variables are required to run this example. They can be provided by ```cp terraform.template.tfvars terraform.tfvars```, modifying ```terraform.tfvars``` with your variables, and running ```terraform apply```. Alternatively, the variables can be provided as flags by running:
```

```console
terraform apply -var="aws_region=us-west-2"
```

3 changes: 1 addition & 2 deletions examples/sagemaker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Export credentials for your account:

export AWS_ACCESS_KEY_ID=<your-access-key-id>
export AWS_SECRET_ACCESS_KEY=<your-secret-access-key>

Create docker container and push it to ECR:

./build_and_push.sh foo
Expand All @@ -26,7 +26,6 @@ In the directory where this README is located, run the following:

terraform init
terraform apply


Go back to `amazon-sagemaker-examples/advanced_functionality/scikit_bring_your_own/container/` and make a test call to the deployed model:

Expand Down
2 changes: 1 addition & 1 deletion examples/transit-gateway-intra-region-peering/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ terraform apply \
## Prerequisites

- This example requires one AWS accounts within the same AWS Organizations Organization
- Ensure Resource Access Manager is enabled in your organization. For more information, see the [Resource Access Manager User Guide](https://docs.aws.amazon.com/ram/latest/userguide/getting-started-sharing.html).
- Ensure Resource Access Manager is enabled in your organization. For more information, see the [Resource Access Manager User Guide](https://docs.aws.amazon.com/ram/latest/userguide/getting-started-sharing.html).
6 changes: 2 additions & 4 deletions examples/two-tier/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,15 @@ getting your application onto the servers. However, you could do so either via
management tool, or by pre-baking configured AMIs with
[Packer](http://www.packer.io).

This example will also create a new EC2 Key Pair in the specified AWS Region.
This example will also create a new EC2 Key Pair in the specified AWS Region.
The key name and path to the public key must be specified via the
terraform command vars.

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.

To run, configure your AWS provider as described in

https://www.terraform.io/docs/providers/aws/index.html
To run, configure your AWS provider as described in https://www.terraform.io/docs/providers/aws/index.html.

Run with a command like this:

Expand Down

0 comments on commit b51a14b

Please sign in to comment.