docs: add terraform to mkdocs

Ref: #1987
This commit is contained in:
Jef LeCompte
2021-02-23 12:14:41 -05:00
parent d341ef72aa
commit 488bc544c9
3 changed files with 9 additions and 6 deletions
+1 -1
View File
@@ -16,7 +16,7 @@ jobs:
with: with:
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
release-type: simple release-type: simple
changelog-path: docs/changelog.md changelog-path: CHANGELOG.md
package-name: streetmerchant package-name: streetmerchant
- name: Login into GitHub Container Registry - name: Login into GitHub Container Registry
if: ${{ steps.release.outputs.release_created }} if: ${{ steps.release.outputs.release_created }}
+1
View File
@@ -0,0 +1 @@
../../terraform/README.md
+7 -5
View File
@@ -1,15 +1,16 @@
# Terraform for AWS Fargate # Terraform for AWS Fargate
Here's some configurable terraform to get you up and running with the streetmerchant docker image in AWS ECS Fargate. Here is a configurable terraform to get you up and running with the streetmerchant docker image in AWS ECS Fargate.
Running on cloud infrastructure, your mileage may vary, and you'll need to integrate with one of the chat notifications rather than having your local browser navigate to a url for you. Running on cloud infrastructure (your mileage may vary), you'll need to integrate with one of the chat notifications rather than having your local browser navigate to a URL for you.
The author's findings were that it worked ok; running the container from within EU-West-2 region was suficient to get a timely alert for PS5 stock on amazon, and follow the link to a successful basket add. The author's findings were that it worked ok; running the container from within EU-West-2 region was sufficient to get a timely alert for PS5 stock on Aamzon and follow the link to a successful checkout.
Dependencies: Dependencies:
- Terraform 14 - Terraform 14
##Getting started ## Getting started
There's an example tfvars file to start you off; rename this with your own preferences. Anything you can set in the `dotenv` file you'll need to set in terraform.tfvars to get the env vars into your fargate container. There's an example tfvars file to start you off; rename this with your own preferences. Anything you can set in the `dotenv` file you'll need to set in terraform.tfvars to get the env vars into your fargate container.
@@ -18,6 +19,7 @@ Authenticate yourself with your own AWS account as with any aws commandline tool
If you wish, add a specific section to your aws credentials file and set that profile name in `terraform.tfvars`. If you wish, add a specific section to your aws credentials file and set that profile name in `terraform.tfvars`.
Then you can: Then you can:
```shell ```shell
cd ./terraform cd ./terraform
terraform init terraform init
@@ -28,5 +30,5 @@ terraform apply
## What's included ## What's included
- container, running streetmerchant, with your chosen config - container running streetmerchant with your chosen config
- cloud metrics and a dashboard tracking 'out of stock' and 'error' responses from your configured stores - cloud metrics and a dashboard tracking 'out of stock' and 'error' responses from your configured stores