Update READMEs

Chuxel · Chuxel · commit 6762209e07d1 · 2019-04-22T18:53:41.000-07:00
diff --git a/containers/azure-functions-dotnetcore-2.1/README.md b/containers/azure-functions-dotnetcore-2.1/README.md
@@ -14,7 +14,6 @@
 
 This definition requires an Azure subscription to use. You can create a [free account here](https://azure.microsoft.com/en-us/free/serverless/) and learn more about using [Azure Functions with VS Code here](https://docs.microsoft.com/en-us/azure/azure-functions/functions-create-first-function-vs-code). Once you have an Azure account, follow these steps:
 
-
 1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
 
 2. To use VS Code's copy of this definition:
diff --git a/containers/docker-existing-docker-compose/README.md b/containers/docker-existing-docker-compose/README.md
@@ -12,19 +12,34 @@
 
 > **Note:** There is also a single [Dockerfile](../docker-existing-dockerfile) variation of this same definition.
 
-## Usage
+## Using this definition with an existing folder
 
-To use the definition with an existing project that contains a `docker-compose.yml` file:
+This definition requires an existing `docker-compose.yml` file that you would prefer not to modify but still want to add additional ports, a volume mount, or override the default command so that the container does not shut down if you stop the application.  The `.devcontainer/docker-compose.yml` and `.devcontainer/devcontainer.json` file will needs to be modified for your scenario.
 
-1. Copy the `.devcontainer` folder into your project root.
-2. Modify the `.devcontainer/dev-container.yml` and `devcontainer.json` files as needed (see comments)
-3. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.
+Follow these steps to use it:
 
-[See here for more information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open).
+1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
+
+2. To use VS Code's copy of this definition:
+   1. Start VS Code and open your project folder.
+   2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
+   3. Select the Existing Docker Compose (Extend) definition.
+
+3. To use latest-and-greatest copy of this definition from the repository:
+   1. Clone this repository.
+   2. Copy the contents of `containers/docker-existing-docker-compose/.devcontainer` to the root of your project folder.
+   3. Start VS Code and open your project folder.
+
+4. After following step 2 or 3, you will need to modify the following files in `.devcontainer` folder that was added to your project:
+   1. Update `your-service-name-here` in both the `docker-compose.yml` file and `devcontainer.json` to the name of the service you want to extend.
+   2. Update the `volume` mapping in `docker-compose.yml` to point to your source code location and the `workspacePath` in `devcontainer.json` to match it.
+   3. Each file has some information on additional settings to consider.
+
+5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
 
-If you prefer, you can also just look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
 ## License
 
 Copyright (c) Microsoft Corporation. All rights reserved.
 
-Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). 
+Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE)
+
diff --git a/containers/docker-existing-dockerfile/.devcontainer/devcontainer.json b/containers/docker-existing-dockerfile/.devcontainer/devcontainer.json
@@ -2,8 +2,11 @@
     // "See https://aka.ms/vscode-remote/devcontainer.json for format details."
     "name": "Existing Dockerfile",
 
+    // "Sets the run context to one level up instead of the .devcontainer folder.
+    "context": "..",
+
     // "Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename."
-    "dockerFile": "../Dockerfile",
+    "dockerFile": "Dockerfile",    
     
     // "Use the optional 'appPort' property to expose ports not already in your Dockerfile"
     "appPort": [],
@@ -13,7 +16,7 @@
 
     // "The optional 'runArgs' property can be used to specify Docker CLI arguments to use when the container."
     // "is started. If you install the Docker CE CLI in your container, the runArgs list below will lets you interact"
-    // "with your host's Docker service from inside the container. See the docker-in-docker and docker-in-docker-compose"
+    // "with your host's Docker service from inside the container. See the docker-in-docker and docker-in-docker"
     // "definitions for details."
     "runArgs": ["-v","/var/run/docker.sock:/var/run/docker.sock"]
 }
diff --git a/containers/docker-existing-dockerfile/README.md b/containers/docker-existing-dockerfile/README.md
@@ -12,15 +12,27 @@
 
 > **Note:** There is also a [Docker Compose](../docker-existing-docker-compose) variation of this same definition.
 
-## Usage
+## Using this definition with an existing folder
 
-To use the definition with your own project that contains a `Dockerfile`:
+This definition requires an existing `Dockerfile` in your project and outlines some settings in `.devcontainer/devcontainer.json` to consider when reusing one.
 
-1. Copy the `.devcontainer` folder into your project root.
-2. Modify the `.devcontainer/devcontainer.json` as needed (see comments)
-3. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.
+Follow these steps to use it:
 
-[See here for more information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open).
+1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
+
+2. To use VS Code's copy of this definition:
+   1. Start VS Code and open your project folder.
+   2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
+   3. Select the Existing Dockerfile definition.
+
+3. To use latest-and-greatest copy of this definition from the repository:
+   1. Clone this repository.
+   2. Copy the contents of `containers/docker-existing-dockerfile/.devcontainer` to the root of your project folder.
+   3. Start VS Code and open your project folder.
+
+4. After following step 2 or 3, review the settings and comments in the `.devcontainer/devcontainer.json` file added to your project. Comments in the file will help you expose new ports, install extensions, forward the Docker socket, and more.
+
+5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
 
 ## License
 
diff --git a/containers/docker-in-docker-compose/README.md b/containers/docker-in-docker-compose/README.md
@@ -16,43 +16,59 @@
 
 Dev containers can be useful for all types of applications including those that also deploy into a container based-environment. While you can directly build and run the application inside the dev container you create, you may also want to test it by deploying a built container image into your local Docker Desktop instance without affecting your dev container. This example illustrates how you can do this by running CLI commands and using the [Docker VS Code extension](https://marketplace.visualstudio.com/items?itemName=PeterJausovec.vscode-docker) right from inside your dev container.
 
-## Usage
+## How it works / adapting your existing dev container config
 
-[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open).
+You can adapt your own existing development container Docker Compose setup to support this scenario by following these steps:
 
-If you prefer, you can also just look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
-
-```Dockerfile
-FROM node:8
-```
-
-See the [Docker CE installation steps for Linux](https://docs.docker.com/install/linux/docker-ce/debian/) for details on other distributions. Note that you only need the Docker CLI in this particular case.
-
-## How it works
-
-The trick that makes this work is as follows:
-
-1. First, install the Docker CLI in the container. From `.devcontainer/Dockerfile`:
+1. First, install the Docker CLI in your dev container. From `.devcontainer/Dockerfile`:
 
     ```Dockerfile
-    RUN apt-get install -y apt-transport-https ca-certificates curl gnupg-agent software-properties-common \
+    RUN apt-get install -y apt-transport-https ca-certificates curl gnupg-agent software-properties-common lsb-release \
         && curl -fsSL https://download.docker.com/linux/$(lsb_release -is | tr '[:upper:]' '[:lower:]')/gpg | apt-key add - \
         && add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/$(lsb_release -is | tr '[:upper:]' '[:lower:]') $(lsb_release -cs) stable" \
         && apt-get update \
         && apt-get install -y docker-ce-cli
     ```
 
-2. Then just forward the Docker socket by mounting it in the container. From `.devcontainer/docker-compose.yml`:
+2. Then just forward the Docker socket by mounting it in the container in your Docker Compose config. From `.devcontainer/docker-compose.yml`:
 
     ```yaml
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock
     ```
 
+3. Press <kbd>F1</kbd> and run **Remote-Containers: Rebuild Container** so the changes take effect.
+
 That's it!
 
+## Using this definition with an existing folder
+
+There are no special setup steps are required, but note that the included `.devcontainer/Dockerfile` can be altered to work with other Debian/Ubuntu-based container images such as `node` or `python`. Just, update the `FROM` statement to reference the new base image. For example:
+
+```Dockerfile
+FROM node:8
+```
+
+Beyond that, just follow these steps to use the definition:
+
+1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
+
+2. To use VS Code's copy of this definition:
+   1. Start VS Code and open your project folder.
+   2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
+   3. Select the Docker in Docker Compose definition.
+
+3. To use latest-and-greatest copy of this definition from the repository:
+   1. Clone this repository.
+   2. Copy the contents of `containers/docker-in-docker-compose/.devcontainer` to the root of your project folder.
+   3. Start VS Code and open your project folder.
+
+4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
+
+5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
+
 ## License
 
 Copyright (c) Microsoft Corporation. All rights reserved.
 
-Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). 
+Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE).
diff --git a/containers/docker-in-docker/README.md b/containers/docker-in-docker/README.md
@@ -16,46 +16,60 @@
 
 Dev containers can be useful for all types of applications including those that also deploy into a container based-environment. While you can directly build and run the application inside the dev container you create, you may also want to test it by deploying a built container image into your local Docker Desktop instance without affecting your dev container. This example illustrates how you can do this by running CLI commands and using the [Docker VS Code extension](https://marketplace.visualstudio.com/items?itemName=PeterJausovec.vscode-docker) right from inside your dev container.
 
-## Usage
+## How it works / adapting your existing dev container config
 
-[See here for information on using this definition with an existing project](https://aka.ms/vscode-remote/containers/getting-started/open).
+You can adapt your own existing development container Dockerfile to support this scenario by following these steps:
 
-If you prefer, you can also just look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
-
-No additional setup steps are required, but note that the included `.devcontainer/Dockerfile` can be altered to work with other Debian/Ubuntu-based container images such as `node` or `python`. First, update the `FROM` statement to reference the new base image. For example:
-
-```Dockerfile
-FROM node:8
-```
-
-See the [Docker CE installation steps for Linux](https://docs.docker.com/install/linux/docker-ce/debian/) for details on other distributions. Note that you only need the Docker CLI in this particular case.
-
-## How it works
-
-The trick that makes this work is as follows:
-
-1. First, install the Docker CLI in the container. From `.devcontainer/Dockerfile`:
+1. First, install the Docker CLI in your container. From `.devcontainer/Dockerfile`:
 
     ```Dockerfile
     # Install Docker CE CLI
-    RUN apt-get install -y apt-transport-https ca-certificates curl gnupg-agent software-properties-common \
+    RUN apt-get install -y apt-transport-https ca-certificates curl gnupg-agent software-properties-common lsb-release \
         && curl -fsSL https://download.docker.com/linux/$(lsb_release -is | tr '[:upper:]' '[:lower:]')/gpg | apt-key add - \
         && add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/$(lsb_release -is | tr '[:upper:]' '[:lower:]') $(lsb_release -cs) stable" \
         && apt-get update \
         && apt-get install -y docker-ce-cli
 
     ```
 
-2. Then just forward the Docker socket by mounting it in the container. From `.devcontainer/devcontainer.json`:
+2. Then just forward the Docker socket by mounting it in the container using `runArgs`. From `.devcontainer/devcontainer.json`:
 
     ```json
     "runArgs": ["-v","/var/run/docker.sock:/var/run/docker.sock"]
     ```
 
+3. Press <kbd>F1</kbd> and run **Remote-Containers: Rebuild Container** so the changes take effect.
+
 That's it!
 
+## Using this definition with an existing folder
+
+There are no special setup steps are required, but note that the included `.devcontainer/Dockerfile` can be altered to work with other Debian/Ubuntu-based container images such as `node` or `python`. Just, update the `FROM` statement to reference the new base image. For example:
+
+```Dockerfile
+FROM node:8
+```
+
+Beyond that, just follow these steps to use the definition:
+
+1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
+
+2. To use VS Code's copy of this definition:
+   1. Start VS Code and open your project folder.
+   2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
+   3. Select the Docker in Docker definition.
+
+3. To use latest-and-greatest copy of this definition from the repository:
+   1. Clone this repository.
+   2. Copy the contents of `containers/docker-in-docker/.devcontainer` to the root of your project folder.
+   3. Start VS Code and open your project folder.
+
+4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
+
+5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
+
 ## License
 
 Copyright (c) Microsoft Corporation. All rights reserved.
 
-Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). 
+Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE).
diff --git a/containers/kubernetes-helm/README.md b/containers/kubernetes-helm/README.md
