add aws docs

bpmct · bpmct · commit e563e1567f2a · 2023-09-26T19:19:51.000Z
diff --git a/examples/templates/aws-linux/README.md b/examples/templates/aws-linux/README.md
@@ -7,17 +7,21 @@ verified: true
 tags: [vm, linux, aws, persistent-vm]
 ---
 
-# aws-linux
+# Remote Development on AWS EC2 VMs
 
-To get started, run `coder templates init`. When prompted, select this template.
-Follow the on-screen instructions to proceed.
+Provision AWS EC2 VMs as [Coder workspaces](https://coder.com/docs/coder-v2/latest) with this example template.
+
+<!-- TODO: Add screenshot -->
+
+## Prerequisites
 
-## Authentication
+### Authentication
 
-This template assumes that coderd is run in an environment that is authenticated
-with AWS. For example, run `aws configure import` to import credentials on the
-system and user running coderd. For other ways to authenticate [consult the
-Terraform docs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration).
+By default, this template authenticates to AWS with using the provider's default [authentication methods](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration).
+
+The simplest way (without making changes to the template) is via environment variables (e.g. `AWS_ACCESS_KEY_ID`) or a [credentials file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html#cli-configure-files-format). If you are running Coder on a VM, this file must be in `/home/coder/aws/credentials`.
+
+To use another [authentication method](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication), edit the template.
 
 ## Required permissions / policy
 
@@ -73,6 +77,20 @@ instances provisioned by Coder:
 }
 ```
 
+## Architecture
+
+> **Note**
+> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
+
+This template provisions the following resources:
+
+- AWS Instance
+
+Coder uses `aws_ec2_instance_state` to start and stop the VM. This example template is fully persistent, meaning the full filesystem is preserved when the workspace restarts. See this [community example](https://github.com/bpmct/coder-templates/tree/main/aws-linux-ephemeral) of an ephemeral AWS instance.
+
+To get started, run `coder templates init`. When prompted, select this template.
+Follow the on-screen instructions to proceed.
+
 ## code-server
 
 `code-server` is installed via the `startup_script` argument in the `coder_agent`
