Merge branch 'feature/vscode-remote-dev-container' into 'master'

adding devcontainer.json file, adding visual studio code section

See merge request all-staff/hashiqube!158

Author: Riaan Nolan

README.md

@@ -121,6 +121,7 @@ Now you can use DNS like nomad.service.consul:9999 vault.service.consul:9999 via
 * [__Ansible-Tower__](ansible-tower/#ansible-tower) - Is a web-based solution that makes Ansible even more easy to use for IT teams of all kinds. It’s designed to be the hub for all of your automation tasks.
 * [__Dbt__](dbt/#dbt) - Dbt is a data transformation tool that enables data analysts and engineers to transform, test and document data in the cloud data warehouse
 * [__Airflow__](apache-airflow/#apache-airflow) - Apache Airflow is an open-source workflow management platform for data engineering pipelines
+* [__Visual-Studio-Code__](visual-studio-code/#visual-studio-code) - Visual Studio Code is a code editor redefined and optimized for building and debugging modern web and cloud applications
 
 Once the stack is up you will have a large number of services running and available on `localhost` <br />
 For Documentation please open http://localhost:3333 in your browser

SUMMARY.md

@@ -17,3 +17,4 @@
   * [Multi-cloud](multi-cloud/README.md)
   * [Newrelic-kubernetes-monitoring](newrelic-kubernetes-monitoring/README.md)
   * [Typography](typography/README.md)
+  * [Visual-studio-code](visual-studio-code/README.md)

devcontainer.json

@@ -0,0 +1,28 @@
+// https://code.visualstudio.com/docs/devcontainers/attach-container#:~:text=To%20attach%20to%20a%20Docker,you%20want%20to%20connect%20to
+{
+  // A command string or list of command arguments to run after VS Code attaches to the container
+  "postStartCommand": "su - vagrant",
+
+  // Set *default* container specific settings.json values on container create.
+  "settings": {
+    "terminal.integrated.defaultProfile.linux": "bash"
+  },
+
+  // Add the IDs of extensions you want installed when the container is created.
+  "extensions": ["dbaeumer.vscode-eslint"],
+
+  // An array port numbers to forward
+  // "forwardPorts": [8000],
+
+  // Indicates the type of shell to use to "probe" for user environment variables to include in VS Code or other connected tool's processes
+  "userEnvProbe": "loginInteractiveShell",
+
+  // Set environment variables for VS Code and sub-processes
+  "remoteEnv": { "MY_VARIABLE": "some-value" },
+  
+  // Default path to open when attaching to a new container.
+  "workspaceFolder": "/vagrant",
+
+  // Container user VS Code should use when connecting
+  "remoteUser": "vagrant"
+}

visual-studio-code/README.md

@@ -0,0 +1,78 @@
+# Visual Studio Code
+
+https://code.visualstudio.com/
+
+Visual Studio Code or VSCode is a Code Editor, also referred to as an IDE. It's made by Microsoft, it's completely free, very powerful and run on all Operating Systems and Architectures. 
+
+It has many extensions and plugins and can help you write betetr code faster. 
+
+![VSCode](images/vscode.png?raw=true "VSCode")
+
+## Download and Install VSCode
+
+To use VSCode, please down load it from here: 
+https://code.visualstudio.com/Download
+
+## Download and Install Popular VSCode Extensions 
+
+Also install these popular Extensions to help you get started: 
+
+- Azure Terraform Extension
+https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureterraform
+
+- Terraform Extension
+https://marketplace.visualstudio.com/items?itemName=HashiCorp.terraform
+
+- Install Git History Extension
+https://marketplace.visualstudio.com/items?itemName=donjayamanne.githistory
+
+- Install GitLens Extension
+https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens
+
+- YAML Extension
+https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml
+
+- Docker Remote Extension (Dev Containers / Remote Containers)
+https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers
+
+- AWS Toolkit
+https://aws.amazon.com/visualstudiocode/
+
+- AWS CloudFormation Extension
+https://marketplace.visualstudio.com/items?itemName=aws-scripting-guy.cform
+
+- Dracula Dark Theme
+https://marketplace.visualstudio.com/items?itemName=dracula-theme.theme-dracula
+
+- Live Share Extension 
+https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare-pack
+
+## Using Dev Containers also called Remote Containers with VSCode 
+
+https://code.visualstudio.com/docs/devcontainers/containers
+
+The Visual Studio Code Dev Containers extension lets you use a container as a full-featured development environment. It allows you to open any folder inside (or mounted into) a container and take advantage of Visual Studio Code's full feature set. A devcontainer.json file in your project tells VS Code how to access (or create) a development container with a well-defined tool and runtime stack. This container can be used to run an application or to separate tools, libraries, or runtimes needed for working with a codebase.
+
+Workspace files are mounted from the local file system or copied or cloned into the container. Extensions are installed and run inside the container, where they have full access to the tools, platform, and file system. This means that you can seamlessly switch your entire development environment just by connecting to a different container.
+
+## Using Hashiqube as a Dev Container (Development Environment)
+
+- Start Hashiqube with `vagrant up --provision`
+
+- Install the Docker Remote Extension (Dev Containers / Remote Containers)
+https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers
+
+- In VSCode Top Menu, click on View -> Command Palette and type in
+`Dev Containers: Attach to Running Container...`
+
+![Dev Containers: Attach to Running Container](images/vscode-view-command-palette-attach-to-running-container.png?raw=true "Dev Containers: Attach to Running Container")
+
+- Select the running Hashiqube Container
+
+![Dev Containers: Attach to Running Container](images/vscode-view-command-palette-attach-to-running-container-select-hashiqube-container.png?raw=true "Dev Containers: Attach to Running Container")
+
+- You are now inside Hashiqube Docker container, and you can work locally an interact with Hashiqube
+
+:bulb: Remember to do `su - vagrant` and `cd /vagrant` to become the vagrant user so that you work as the vagrant user, you can then issue `kubectl` or `terraform` commands if you ran the provisioners first from a terminal on your laptop. 
+
+![VSCode](images/vscode-hashiqube-devcontainer.png?raw=true "VSCode")