dev: improve devcontainer env

Author: sgtoj

.devcontainer/Dockerfile

@@ -1,27 +1,39 @@
-FROM mcr.microsoft.com/devcontainers/base:jammy
+FROM mcr.microsoft.com/vscode/devcontainers/base:jammy
 
-# Install AWS CLI
-RUN apt-get update && \
-    apt-get install -y unzip python3-pip && \
-    pip3 install --no-cache-dir --upgrade awscli && \
-    apt-get clean && \
-    rm -rf /var/lib/apt/lists/*
-
-# Install Docker CLI
-COPY --from=docker:dind /usr/local/bin/docker /usr/local/bin/
+# install aws
+RUN SYSTEM_ARCH=$(uname -m) \
+    && curl "https://awscli.amazonaws.com/awscli-exe-linux-${SYSTEM_ARCH}.zip" -o "awscliv2.zip" \
+    && unzip awscliv2.zip \
+    && aws/install \
+    && aws --version \
+    && rm -rf aws
 
-# Install Terraform
+# install terraform
 ENV TERRAFORM_VERSION=1.5.1
 ENV TF_PLUGIN_CACHE_DIR=$HOME/.terraform.d/plugin-cache
+RUN mkdir -p $TF_PLUGIN_CACHE_DIR
 RUN SYSTEM_ARCH=$(dpkg --print-architecture) \
-    && mkdir -p $TF_PLUGIN_CACHE_DIR \
     && curl -OL https://releases.hashicorp.com/terraform/${TERRAFORM_VERSION}/terraform_${TERRAFORM_VERSION}_linux_${SYSTEM_ARCH}.zip \
     && unzip terraform_${TERRAFORM_VERSION}_linux_${SYSTEM_ARCH}.zip \
     && mv terraform /usr/local/bin/ \
     && terraform version \
     && rm terraform_${TERRAFORM_VERSION}_linux_${SYSTEM_ARCH}.zip
 
-# Verify Installs
+# install docker
+COPY --from=docker:dind /usr/local/bin/docker /usr/local/bin/
+
+# install pip
+RUN apt-get update
+RUN apt-get install -y \
+    python3-pip \
+    shellcheck
+
+# install python packages
+RUN python3 -m pip install \
+    boto3 \
+    black
+
+# verify installs
 RUN terraform --version \
     && aws --version \
     && docker --version

.devcontainer/devcontainer.json

@@ -4,8 +4,11 @@
   "features": {
     "ghcr.io/devcontainers/features/docker-in-docker:2.0.1": {},
   },
+  "mounts": [
+    "source=${localEnv:HOME}/.aws,target=/home/vscode/.aws,type=bind,consistency=cached"
+  ],
   "containerEnv": {
-    "TF_PLUGIN_CACHE_DIR": "/workspaces/terraform-aws-terraform-aws-teleport-cluster/.devcontainer/tmp/.terraform.d/"
+    "TF_PLUGIN_CACHE_DIR": "${containerWorkspaceFolder}/.devcontainer/tmp/.terraform.d/"
   },
   "customizations": {
     "vscode": {
@@ -17,22 +20,30 @@
         "editor.formatOnType": false,
         "editor.inlineSuggest.enabled": true,
         "terminal.integrated.shell.linux": "/bin/bash",
+        "python.formatting.provider": "black",
+        "python.defaultInterpreterPath": "/usr/bin/python3",
         "[markdown]": {
           "editor.rulers": [
             80
           ]
-        }
+        },
+        "[python]": {
+          "editor.defaultFormatter": "ms-python.black-formatter"
+        },
       },
       "extensions": [
         "darkriszty.markdown-table-prettify",
         "editorconfig.editorconfig",
         "github.copilot",
+        "github.copilot-chat",
         "github.vscode-github-actions",
+        "github.vscode-pull-request-github",
         "hashicorp.terraform",
         "ms-azuretools.vscode-docker",
+        "ms-python.black-formatter",
         "timonwong.shellcheck",
         "VisualStudioExptTeam.vscodeintellicode",
       ],
     }
   },
-}
+}

CONTRIBUTING.md

@@ -14,11 +14,11 @@ The development container is based on Ubuntu 22.04 (Jammy) and includes the
 following tools:
 
 - AWS CLI
-- Node.js
-- TypeScript
+- Python v3.8
+- Python Packages: `boto3`, `black`
 - Docker CLI
+- Shellcheck
 - Terraform
-- Open Policy Agent
 
 ### Prerequisites
 
@@ -34,8 +34,8 @@ following tools:
 1. Clone and open this repository:
 
     ```bash
-    git clone https://github.com/sgtoj/terraform-aws-terraform-aws-teleport-cluster.git
-    code terraform-aws-terraform-aws-teleport-cluster
+    git clone https://github.com/sgtoj/terraform-aws-teleport-cluster.git
+    code terraform-aws-teleport-cluster
     ```
 
 2. When prompted to "Reopen in Container", click "Reopen in Container". This

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Brian Ojeda
+Copyright (c) 2023 CruxStack LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -0,0 +1,24 @@
+PROJ_ROOT := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
+
+# allows args to pass to run-cmd example: make run-cmd echo "hello world"
+ifeq (run-cmd,$(firstword $(MAKECMDGOALS)))
+  RUN_ARGS := $(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS))
+  $(eval $(RUN_ARGS):;@:)
+endif
+
+all: deps build
+	@exit 0
+
+deps:
+	@exit 0
+
+build:
+	@exit 0
+
+clean:
+	@find . -type d -name "dist" -exec rm -rf {} +
+	@find . -type d -name ".terraform" -exec rm -rf {} +
+	@find . -type d -name ".terraform.d" -exec rm -rf {} +
+	@find . -type d -name ".tfstate" -exec rm -rf {} +
+	@find . -type d -name ".tfstate.backup" -exec rm -rf {} +
+	@touch .devcontainer/.terraform.d/.gitkeep || true

README.md

@@ -11,7 +11,7 @@ This project is under development. See `dev` branch for latest activity.
 
 ```hcl
 module "teleport_cluster" {
-  source  = "sgtoj/teleport-cluster/aws"
+  source  = "cruxstack/teleport-cluster/aws"
   version = "x.x.x"
 
   # TBD
@@ -29,15 +29,15 @@ In addition to the variables documented below, this module includes several
 other optional variables (e.g., `name`, `tags`, etc.) provided by the
 `cloudposse/label/null` module. Please refer to the [`cloudposse/label` documentation](https://registry.terraform.io/modules/cloudposse/label/null/latest) for more details on these variables.
 
-| Name                                 | Description                                                                                                   |                 Type                 | Default  | Required |
-|--------------------------------------|---------------------------------------------------------------------------------------------------------------|:------------------------------------:|:--------:|:--------:|
-| `placehold`               | N/A           |                string                |   null   |    No    |
+| Name        | Description |  Type  | Default | Required |
+|-------------|-------------|:------:|:-------:|:--------:|
+| `placehold` | N/A         | string |  null   |    No    |
 
 ## Outputs
 
-| Name                                | Description                                                                   |
-|-------------------------------------|-------------------------------------------------------------------------------|
-| `placehold`                   |  N/A                                      |
+| Name        | Description |
+|-------------|-------------|
+| `placehold` | N/A         |
 
 ## Contributing