feat: add aws-snapshot-example template demonstrating aws-ami-snapshot module usage

Author: MAVRICK-1

registry/mavrickrishi/templates/aws-snapshot-example/README.md

@@ -0,0 +1,178 @@
+# AWS EC2 with Snapshot Support
+
+This template creates an AWS EC2 instance with automatic AMI snapshot capabilities using the `aws-ami-snapshot` module.
+
+## Features
+
+- **Automatic AMI Snapshots**: Creates snapshots when workspaces are stopped
+- **Snapshot Restoration**: Restore from previous snapshots when starting workspaces
+- **Lifecycle Management**: Automatic cleanup of old snapshots (keeps last 7)
+- **Persistent Storage**: Data persists across workspace restarts via AMI snapshots
+- **SSH & Code-Server**: Built-in SSH access and VS Code in the browser
+
+## Usage
+
+### Prerequisites
+
+1. AWS credentials configured in your Coder deployment
+2. Proper IAM permissions for EC2, AMI, and DLM operations
+
+### Required IAM Permissions
+
+```json
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Action": [
+        "ec2:RunInstances",
+        "ec2:TerminateInstances",
+        "ec2:DescribeInstances",
+        "ec2:DescribeInstanceAttribute",
+        "ec2:DescribeSecurityGroups",
+        "ec2:CreateSecurityGroup",
+        "ec2:DeleteSecurityGroup",
+        "ec2:AuthorizeSecurityGroupIngress",
+        "ec2:AuthorizeSecurityGroupEgress",
+        "ec2:CreateKeyPair",
+        "ec2:DeleteKeyPair",
+        "ec2:DescribeKeyPairs",
+        "ec2:CreateTags",
+        "ec2:DescribeTags"
+      ],
+      "Resource": "*"
+    },
+    {
+      "Effect": "Allow",
+      "Action": [
+        "ec2:CreateImage",
+        "ec2:DescribeImages",
+        "ec2:DeregisterImage",
+        "ec2:CreateSnapshot",
+        "ec2:DescribeSnapshots",
+        "ec2:DeleteSnapshot"
+      ],
+      "Resource": "*"
+    },
+    {
+      "Effect": "Allow",
+      "Action": [
+        "dlm:CreateLifecyclePolicy",
+        "dlm:GetLifecyclePolicy",
+        "dlm:UpdateLifecyclePolicy",
+        "dlm:DeleteLifecyclePolicy"
+      ],
+      "Resource": "*"
+    },
+    {
+      "Effect": "Allow",
+      "Action": [
+        "iam:CreateRole",
+        "iam:DeleteRole",
+        "iam:AttachRolePolicy",
+        "iam:DetachRolePolicy",
+        "iam:PassRole"
+      ],
+      "Resource": "*"
+    }
+  ]
+}
+```
+
+### Deploying the Template
+
+1. Create the template in Coder:
+   ```bash
+   coder template create aws-snapshot-example \
+     --directory /path/to/this/template
+   ```
+
+2. Create a workspace:
+   ```bash
+   coder create my-workspace --template aws-snapshot-example
+   ```
+
+### How Snapshots Work
+
+1. **Automatic Creation**: When you stop your workspace, an AMI snapshot is automatically created
+2. **Snapshot Selection**: When starting a workspace, you can choose to restore from a previous snapshot
+3. **Lifecycle Management**: Old snapshots are automatically deleted after 7 snapshots are accumulated
+
+### Workspace Parameters
+
+- **Region**: Choose your AWS region
+- **Instance Type**: Select from t3.micro, t3.small, or t3.medium
+- **Enable Snapshots**: Toggle snapshot creation on/off
+- **Snapshot Label**: Add a custom label to your snapshots
+- **Use Previous Snapshot**: Select a snapshot to restore from
+
+### Accessing Your Workspace
+
+Once your workspace is running:
+
+1. **SSH**: Click the SSH button or use:
+   ```bash
+   ssh <username>@<public-ip>
+   ```
+
+2. **Code-Server**: Access VS Code in your browser through the Coder UI
+
+### Development Tools Included
+
+- Docker
+- Git
+- Build essentials
+- Common development utilities (vim, tmux, htop, jq)
+
+## Customization
+
+### Modify Instance Types
+
+Edit the `instance_type` parameter in `main.tf` to add more options:
+
+```hcl
+option {
+  name  = "t3.large (2 vCPU, 8 GB RAM)"
+  value = "t3.large"
+}
+```
+
+### Change Snapshot Retention
+
+Modify the `snapshot_retention_count` in the module configuration:
+
+```hcl
+module "ami_snapshot" {
+  # ...
+  snapshot_retention_count = 14  # Keep 14 snapshots instead of 7
+}
+```
+
+### Add More Software
+
+Edit the `user_data.sh` script or the `startup_script` in the Coder agent to install additional software.
+
+## Troubleshooting
+
+### Snapshots Not Creating
+
+1. Check IAM permissions
+2. Verify the workspace transition completed
+3. Check AWS CloudTrail logs for errors
+
+### Cannot Restore from Snapshot
+
+1. Ensure the snapshot AMI still exists
+2. Verify it's in the same region
+3. Check that the snapshot is owned by your AWS account
+
+### High Costs
+
+- Snapshots incur storage costs
+- Use lifecycle management to limit retained snapshots
+- Consider using smaller instance types for development
+
+## Support
+
+For issues or questions, please refer to the Coder documentation or contact your administrator.