diff --git a/.devcontainer/README.md b/.devcontainer/README.md index 4c7a070de..4bc8b2251 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -40,8 +40,18 @@ All configuration related to the development container is in the `.devcontainer` The container will build on your machine. The first build may take some time; the `Reopen in Container` command will be much faster after the initial container build, and VS Code will prompt you if the container needs to be rebuilt when the `Dockerfile` or container configuration settings have changed. -1. (Optional) if you'd like to interact with the devcontainer's terminal from another terminal other than VS Code's built in terminal, you can docker's `exec` command: +1. (Optional) if you'd like to interact with the devcontainer's terminal from another terminal other than VS Code's built in terminal, you can docker's `exec` command. + + > NOTE: VS Code attaches to the container as the user named "vscode", so you have to do the same thing when attaching to a BASH session in the container by specifying the user as an argument to the `docker exec` command. If you do not specify the user then you will be connected as root, which will cause permissions issues in git (if you are launching VS Code from WSL). + + ```BASH + docker exec --interactive --tty --user vscode missionlz-dev /bin/bash + ``` + + Or, the equivalent short form below: ```BASH - docker exec -it missionlz-dev /bin/bash + docker exec -it -u vscode missionlz-dev /bin/bash ``` + + When you are logged into the devcontainer's terminal, you will find the working directory diff --git a/README.md b/README.md index e47366f38..80452b6ec 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,13 @@ Terraform resources to deploy Tier 0, 1, and 2, and the components of a [SACA](https://docs.microsoft.com/en-us/azure/azure-government/compliance/secure-azure-computing-architecture). -## Changelog - -See the [changelog](./CHANGELOG.md) for notes on major increments and breaking changes. - ## Getting Started To get started, you'll need to do 4 things: 1. [Prepare the Terraform provider cache](#Prepare-the-Terraform-provider-cache) 2. [Configure the Terraform Backend](#Configure-the-Terraform-Backend) -3. [Set Terraform Configuration Values](#Set-Terraform-Configuration-Values) +3. [Set Terraform Configuration Variables](#Set-Terraform-Configuration-Variables) 4. [Deploy Terraform Configuration](#Deploy-Terraform-Configuration) ### Prepare the Terraform provider cache @@ -30,7 +26,7 @@ src/provider_archive/unzipprovider.sh ### Configure the Terraform Backend -The MLZ deployment architecture uses a single Service Principal who's credentials are stored in central "config" Key Vault. Terraform state storage is distributed into a seperate storage account for each tier. When deploying the MLZ architecture, all tiers can be deployed into a single subscription or each tier can be deployed into it's on subscription. +The MLZ deployment architecture uses a single Service Principal whose credentials are stored in a central "config" Key Vault. Terraform state storage is distributed into a seperate storage account for each tier. When deploying the MLZ architecture, all tiers can be deployed into a single subscription or each tier can be deployed into it's on subscription. Create the `mlz_tf_cfg.var` file using the `mlz_tf_cfg.var.sample` as the template. The information in the `mlz_tf_cfg.var` file, along with the parameter values provided when executing the `mlz_tf_setup.sh` script will be used by the `mlz_tf_setup.sh` script to automatically create and populate the `config.vars` file for each tier. The `config.vars` files that get generated by executing the `mlz_tf_setup.sh` script will saved inside the deployment folder for each tier (example: \src\core\tier-0\config.vars).