iotedgedev 3.3.4__zip → 3.3.6__zip

s/docs/{Azure-Setup.md → azure-setup.md}

@@ -1,4 +1,4 @@
-#### Automated Setup
+## Automated Setup
 
 The following will show you how to setup your Azure Resources via the CLI instead of using the Portal.
 
@@ -16,7 +16,7 @@ Here are all the `iotedgedev iothub setup` command options:
 
 > You can override all of these parameters with environment variables. Please see the .env file in your solution for details.
 
-```
+```sh
 iotedgedev iothub setup
     --credentials USERNAME PASSWORD
     --service-principal USERNAME PASSWORD TENANT
@@ -31,7 +31,7 @@ iotedgedev iothub setup
 
 You can use the following `az cli` command to create a service principal:
 
-```
+```sh
 az ad sp create-for-rbac -n "iotedgedev01"
 ```
 
@@ -39,17 +39,17 @@ az ad sp create-for-rbac -n "iotedgedev01"
 
 Alternatively, you can deploy the IoT Hub **and** Container Registry with this **Deploy to Azure** template:
 
-[![Azure Deployment](https://azuredeploy.net/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fazure%2Fiotedgedev%2Fmaster%2Fassets%2Fdeploy%2FARMDeployment%2Fazuredeploy.json)
+[![Deploy to Azure Button](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fazure%2Fiotedgedev%2Fmain%2Fassets%2Fdeploy%2FARMDeployment%2Fazuredeploy.json)
 
 > Note: If you do not need a Container Registry, or are planning to use a local registry, then you should run the **iotedgedev iothub setup** command instead of running this **Deploy to Azure** template, because the template includes a Container Registry.
 
-#### Manual Setup
-1. [**Create Azure IoT Hub**](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-csharp-csharp-getstarted#create-an-iot-hub)
-1. **Create Edge Device** using the Azure Portal
-    - In your IoT Hub, click "IoT Edge", then click "Add IoT Edge Device"
+## Manual Setup
 
-1.  **Container Registry**
-    When you develop for IoT Edge, you need to host your images in a container registry, which the IoT Edge runtime will fetch the modules images from when it starts. 
+1. [**Create Azure IoT Hub**](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-csharp-csharp-getstarted#create-an-iot-hub)
+2. **Create Edge Device** using the Azure Portal
+   - In your IoT Hub, click "IoT Edge", then click "Add IoT Edge Device"
+3. **Container Registry**
+    When you develop for IoT Edge, you need to host your images in a container registry, which the IoT Edge runtime will fetch the modules images from when it starts.
 
     > By default, the IoT Edge Dev Tool will use the Local Registry.
 
@@ -59,35 +59,36 @@ Alternatively, you can deploy the IoT Hub **and** Container Registry with this *
 
         Set `CONTAINER_REGISTRY_SERVER` to `localhost:5000` and leave `CONTAINER_REGISTRY_USERNAME` and `CONTAINER_REGISTRY_PASSWORD` blank.
 
-        ```
+        ```sh
         CONTAINER_REGISTRY_SERVER="localhost:5000"
         ```
 
-    1. Azure Container Registry
+    2. Azure Container Registry
 
         You can create an [**Azure Container Registry**](https://docs.microsoft.com/en-us/azure/container-registry/container-registry-get-started-portal) and host your images there.
             - Make sure you enable Admin Access when you create the Azure Container Registry
 
         After created, open .env and set the following:
 
-        ```
+        ```sh
         CONTAINER_REGISTRY_SERVER="ACR URI" 
         CONTAINER_REGISTRY_USERNAME="ACR USERNAME"
         CONTAINER_REGISTRY_PASSWORD="ACR PASSWORD"
         ```
 
         Example:
-        ```
+
+        ```sh
         CONTAINER_REGISTRY_SERVER="jong.azurecr.io" 
         CONTAINER_REGISTRY_USERNAME="jong"
         CONTAINER_REGISTRY_PASSWORD="p@$$w0rd"
         ```
 
-    1. Docker Hub
+    3. Docker Hub
 
         You can also host your images on Docker Hub. Create a Docker Hub account and then open .env and enter the following:
 
-        ```
+        ```sh
         CONTAINER_REGISTRY_SERVER="DOCKER HUB USERNAME" 
         CONTAINER_REGISTRY_USERNAME="DOCKER HUB USERNAME"
         CONTAINER_REGISTRY_PASSWORD="DOCKER HUB PASSWORD"
@@ -95,8 +96,8 @@ Alternatively, you can deploy the IoT Hub **and** Container Registry with this *
 
         Example:
 
-        ```
+        ```sh
         CONTAINER_REGISTRY_SERVER="jongallant" 
         CONTAINER_REGISTRY_USERNAME="jongallant"
         CONTAINER_REGISTRY_PASSWORD="p@$$w0rd"
-        ```
+        ```

s/docs/{Command-List.md → command-list.md}

@@ -335,6 +335,7 @@ Options:
   --iothub-name TEXT              The IoT Hub Name (Creates a new IoT Hub if not found).  [required]
   --edge-device-id TEXT           The IoT Edge Device Id (Creates a new Edge Device if not found).  [required]
   -u, --update-dotenv             If True, the current .env will be updated with the IoT Hub and Device connection strings.  [default: False; required]
+  --create-edge-vm                Create an Edge-enabled Virtual Machine by using <https://aka.ms/iotedge-vm-deploy>.  [default: False; required]
   -h, --help                      Show this message and exit.
 ```
 

s/docs/{Edge-Device-Setup.md → edge-device-setup.md}

@@ -7,17 +7,18 @@ IoT Edge Dev Tool is intended to help with IoT Edge development and doesn't nece
 
 Having said that, there's nothing stopping you from deploying IoT Edge Dev Tool to your IoT Edge device. It may be helpful if you want to run the `iotedgedev docker clean` command to clean up Docker containers and images. Or if you want to run `iotedgedev docker log --show` to see all the log files on the device or `iotedgedev docker log --save` to output to the LOGS_PATH directory.
 
-> Please note that you will need .NET Core SDK 2.1 to add C# modules and C# Function modules on a Raspberry Pi. Check [Manual Dev Machine Setup](manual-dev-machine-setup#c-module-and-c-azure-functions-module) to learn how to install.
+> Please note that you will need .NET Core SDK 2.1 to add C# modules and C# Function modules on a Raspberry Pi. Check [Manual Dev Machine Setup](environment-setup/manual-dev-machine-setup) to learn how to install.
 
 ### Raspberry Pi
 
-##### Config Changes
+#### Config Changes
+
 If you are running on Raspberry Pi you need to use the arm32v7 Dockerfile. Open `deployment.template.json`, find the JSON dictionary for `filtermodule`, and replace `"image": "${MODULES.filtermodule.amd64}",` with `"image": "${MODULES.filtermodule.arm32v7}",`
 
-##### Environment Variable Change
+#### Environment Variable Change
 
 Open your `.env` file and add `arm32v7` to your `ACTIVE_DOCKER_PLATFORMS` setting. This will tell the IoT Edge Dev Tool to also build the arm32v7 images.
 
-```
+```sh
 ACTIVE_DOCKER_PLATFORMS="amd64,arm32v7"
 ```

s/docs/environment-setup/install-docker.md

@@ -0,0 +1,9 @@
+# Install [Docker CE](https://docs.docker.com/install/)
+
+- Windows
+  - Be sure to check whether you are running in Linux container mode or Windows container mode.
+- Linux
+  - We've seen some issues with docker.io. If Edge doesn't run for you, then try installing Docker CE directly instead of via docker.io. Use the [CE install steps](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/#install-docker-ce), or use the [convenience script](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/#install-using-the-convenience-script).
+  - By default, you need `sudo` to run `docker` commands. If you want to avoid this, please follow the [post-installation steps for Linux](https://docs.docker.com/install/linux/linux-postinstall/#manage-docker-as-a-non-root-user).
+
+Note: If the device is behind the proxy server, you can set the [proxy manually](https://docs.docker.com/network/proxy/#configure-the-docker-client).

s/docs/environment-setup/manual-dev-machine-setup.md

@@ -0,0 +1,79 @@
+Here is what you need to do to get Azure IoT Edge Dev Tool (aka `iotedgedev`) running on your dev machine manually instead of using the IoT Edge Dev Container.
+
+If you are using a separate Edge device, like a Raspberry Pi, you do not need to run all of these steps on your IoT Edge device, you can install and setup Edge runtime directly on the device. See the [Edge Device Setup](edge-device-setup) wiki page for more information on setting up your Edge device.
+
+> Note: See the ["Test Coverage"](test-coverage) wiki page to see what the IoT Edge Dev Tool has been tested with.
+
+1. Install **Python 2.7+ or Python 3.6+** and **pip** (Python 3.6 is recommended)
+    - Windows: [Install from Python's website](https://www.python.org/downloads/)
+    - Linux: `sudo apt install python-pip` or `sudo apt install python3-pip`
+    - macOS: The OpenSSL used by the system built-in Python is old and vulnerable. Please use Python installed with [Homebrew](https://docs.brew.sh/Homebrew-and-Python)
+
+2. Install **[Azure CLI 2.0](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest)**
+
+3. Install **[Azure CLI IoT extension](https://github.com/Azure/azure-iot-cli-extension/)**
+
+    - New Install: `az extension add --name azure-iot`
+    - Update Install: `az extension update --name azure-iot`
+
+4. (Python < 3.5 only) Install **[Node.js](https://nodejs.org/en/download/)** and the **`iothub-explorer`** package
+
+    - uamqp, which is needed by Azure CLI IoT extension for monitoring messages, is not supported in Python < 3.5. For Python < 3.5 users, please install [Node.js](https://nodejs.org/en/download/) and the `iothub-explorer` Node.js package: `npm i -g iothub-explorer`
+
+5. (Raspberry Pi only) Install extra system dependencies
+
+    ```sh
+    sudo apt-get install python2.7-dev libffi-dev libssl-dev -y
+    ```
+
+6. (Linux only) Install [Docker Compose](https://docs.docker.com/compose/)
+
+    ```sh
+    pip install -U docker-compose
+    ```
+
+7. Install **`iotedgedev`**
+
+    > You do not need to do this if you're going to be developing on iotedgedev
+
+    > You do not need to run this on the Edge device. See the [Edge Device Setup](edge-device-setup) page for more information on setting up your Edge device.
+
+    > You can also run under a Python Virtual Environment.  See the [Python Virtual Environment Setup](python-virtual-environment-setup) instructions page for details on how to set that up.
+
+    > There is a known dependency conflict between `iotedgedev` and now-deprecated `azure-iot-edge-runtime-ctl`. Please make sure you have uninstalled `azure-iot-edge-runtime-ctl` before installing `iotedgedev`: `pip uninstall azure-iot-edge-runtime-ctl`, or use a clean virtual environment.
+
+    ```sh
+    pip install -U iotedgedev
+    ```
+
+8. Install module dependencies
+
+    - **C# module and C# Azure Functions module**
+
+        Install **[.NET Core SDK 2.1 or later](https://www.microsoft.com/net/download)**
+        > You need .NET Core SDK 2.1 or later to run it on ARM. There is no official document on installing .NET Core SDK on ARM yet, but you can follow the [ARM32v7 Dockerfile](https://github.com/dotnet/dotnet-docker/blob/master/src/sdk/3.1/buster/arm32v7/Dockerfile).
+
+    - **Python module**
+
+      1. Install **[Git](https://git-scm.com/)**
+      2. Install **[Cookiecutter](https://github.com/audreyr/cookiecutter)**
+
+      ```sh
+      pip install -U cookiecutter
+      ```
+
+    - **Node.js module**
+
+      1. Install **[Node.js](https://nodejs.org/en/download/)**
+      2. Install **[Yeoman](http://yeoman.io/)** and **[Azure IoT Edge Node.js module generator](https://github.com/Azure/generator-azure-iot-edge-module)** packages
+
+      ```sh
+      npm i -g yo generator-azure-iot-edge-module
+      ```
+
+    - **Java module**
+
+      1. Install **[JDK](https://www.oracle.com/technetwork/java/javase/downloads/index.html)**
+      2. Install **[Maven](https://maven.apache.org/)**
+
+9. Follow the [Usage Wiki](../usage.md) to learn the usage of IoT Edge Dev Tool

s/docs/{Python-Virtual-Environment-Setup.md → environment-setup/python-virtual-environment-setup.md}

@@ -4,18 +4,17 @@ You can run IoT Edge Dev Tool inside a [Python Virtual Environment](https://docs
 
     `pip install virtualenv`
 
-1. Create a virtual environment
+2. Create a virtual environment
 
     `virtualenv venv`
 
     > `venv` is just a env name that can be anything you want, but we recommend sticking with `venv` if you want to contribute to IoT Edge Dev Tool because the `.gitignore` file excludes it.
 
     > To create a virtual environment with a Python version different with your system default, just use the `--python/-p` option to specify the Python executable path, *e.g.*:
-    > ```
-    > virtualenv --python /usr/bin/python2.7 py27
-    > ```
+    >
+    > `virtualenv --python /usr/bin/python2.7 py27`
 
-1. Activate the virtual environment
+3. Activate the virtual environment
 
     - Windows
         - cmd.exe: `venv\Scripts\activate.bat`
@@ -24,11 +23,11 @@ You can run IoT Edge Dev Tool inside a [Python Virtual Environment](https://docs
     - Posix: `source venv/bin/activate`
     > It will be active until you deactivate it or close the terminal instance.
 
-1. Install dependencies
+4. Install dependencies
 
-    Continue with the instructions above starting with the [Manual Dev Machine Setup](manual-dev-machine-setup) -> Install Dependencies.
+    Continue with the instructions above starting with the [Manual Dev Machine Setup](Environment-Setup/manual-dev-machine-setup) -> Install Dependencies.
 
-1. Deactivate the virtual environment
+5. Deactivate the virtual environment
 
     When you are done with your virtualenv, you can deactivate it with the follow command:
 

s/docs/environment-setup/run-devcontainer-docker.md

@@ -0,0 +1,24 @@
+# Run the IoT Edge Dev Container with Docker
+
+Before you run the container, you will need to create a local folder to store your IoT Edge solution files.
+
+## Windows
+
+```cmd
+mkdir c:\temp\iotedge
+docker run -ti -v /var/run/docker.sock:/var/run/docker.sock -v c:/temp/iotedge:/home/iotedge mcr.microsoft.com/iotedge/iotedgedev
+```
+
+## Linux
+
+```bash
+sudo mkdir /home/iotedge
+sudo docker run -ti -v /var/run/docker.sock:/var/run/docker.sock -v ~/iotedge:/home/iotedge mcr.microsoft.com/iotedge/iotedgedev
+```
+
+## macOS
+
+```bash
+mkdir ~/iotedge
+docker run -ti -v /var/run/docker.sock:/var/run/docker.sock -v ~/iotedge:/home/iotedge mcr.microsoft.com/iotedge/iotedgedev
+```

s/docs/home.md

@@ -0,0 +1,10 @@
+Welcome to the IoT Edge Dev Tool wiki!
+
+The **IoT Edge Dev Tool** greatly simplifies [Azure IoT Edge](https:/azure.microsoft.com/en-us/services/iot-edge/) development down to simple commands driven by environment variables.
+
+- It gets you started with IoT Edge development with the [IoT Edge Dev Container](quickstart) and IoT Edge solution scaffolding that contains a default module and all the required configuration files.
+- It speeds up your inner-loop dev (dev, debug, test) by reducing multi-step build & deploy processes into one-line CLI commands as well as drives your outer-loop CI/CD pipeline. _You can use all the same commands in both stages of your development life-cycle._
+
+## Issues
+
+Please use the [GitHub issues page](https://github.com/azure/iotedgedev/issues) to report any issues.

s/docs/{Migration-Guides.md → migration-guides.md}

@@ -1,9 +1,9 @@
 IoT Edge Dev Tool 0.82.0 provides support for the GA release of Azure IoT Edge and other new features, while on the other hand, introduces some breaking changes to better serve these new features. If you have used IoT Edge Dev Tool during the Azure IoT Edge public preview, this document will help you migrate your code and workflow to IoT Edge Dev Tool 0.82.0.
 
-### Retirement of `iotedgectl`
+## Retirement of `iotedgectl`
 With the GA release of Azure IoT Edge, iotedgectl (a.k.a, [azure-iot-edge-runtime-ctl](https://pypi.org/project/azure-iot-edge-runtime-ctl/)) is retired. In IoT Edge Dev Tool 0.82.0, we replace `iotedgectl` with the IoT Edge Simulator provided by the [iotedgehubdev CLI](https://pypi.org/project/iotedgehubdev/). The `setup`, `start`, and `stop` commands will now control IoT Edge Simulator instead.
 
-### Updated command list and options
+## Updated command list and options
 IoT Edge Dev Tool 0.82.0 comes with a new CLI UX. All commands are organized into four categories: `docker`, `iothub`, `simulator`, and `solution`. The general style is **iotedgedev _category_ _command_ --_parameter_**. For some frequently used commands, there is also an **iotedgedev _command_ --_parameter_** style shortcut (only if the shortcut won't cause confusion, similar to the relationship between `docker logs` and `docker container logs`). The shortcuts also add backward compatibility with some public preview style commands.
 
 Here is what you would see when you type `iotedgedev --help` (shortcuts are intentionally listed before the categories):
@@ -79,30 +79,30 @@ Options:
 
 Below is a full table of the public preview commands, new commands, and shortcuts (if applicable):
 
-Public Preview Command | New Command | Shortcut
--- | -- | --
-`--set-config` | `solution genconfig` | `genconfig `
-`solution --create --module --template` | `solution new --module/-t --template/-t` | `new`
-`init` | `solution init` | `init`
-`e2e` | `solution e2e` |
-`addmodule --template` | `solution add --template/-t` | `add --template/-t`
-`build --push --deploy` | `solution build --push/-p --deploy/-d` | `build --push/-p --deploy/-d`
-`push --deploy --no-build` | `solution push --deploy/-d --no-build` | `push --deploy/-d --no-build`
-`deploy` | `solution deploy` | `deploy`
-`monitor --timeout` | `iothub monitor --timeout/-t` | `monitor --timeout/-t`
-`azure --setup --credentials --service-principal --subscription --resource-group-location --resource-group-name --iothub-sku --iothub-name --edge-device-id --update-dotenv` | `iothub setup --credentials --service-principal --subscription --resource-group-location --resource-group-name --iothub-sku --iothub-name --edge-device-id --update-dotenv/-u` |  
-`modules --add --template` | `solution add --template` | `add --template/-t`
-`modules --build --push --deploy` | `solution build --push/-p --deploy/-d` | `build --push/-p --deploy/-d`
-`modules --push --deploy` | `solution push --deploy/-d --no-build` | `push --deploy/-d --no-build`
-`modules --deploy` | `solution deploy` | `deploy`
-`runtime --setup` | *deprecated, see [Retirement of `iotedgectl`](#retirement-of-iotedgectl) section* |  
-`runtime --start` | *deprecated, see [Retirement of `iotedgectl`](#retirement-of-iotedgectl) section* |  
-`runtime --stop` | *deprecated, see [Retirement of `iotedgectl`](#retirement-of-iotedgectl) section* |  
-`runtime --restart` | *deprecated, see [Retirement of `iotedgectl`](#retirement-of-iotedgectl) section* |  
-`runtime --status` | *deprecated, see [Retirement of `iotedgectl`](#retirement-of-iotedgectl) section* |  
-`docker --setup-registry` | `docker setup` |  
-`docker --clean --remove-modules --remove-containers --remove-images` | `docker clean --modules/-m --containers/-c --image/-i` |  
-`docker --logs --show-logs --save-logs` | `docker log --show/-l --save/-s` | `docker log --show/-l --save/-s`
+| Public Preview Command                                                                                                                                                       | New Command                                                                                                                                                                    | Shortcut                         |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------- |
+| `--set-config`                                                                                                                                                               | `solution genconfig`                                                                                                                                                           | `genconfig `                     |
+| `solution --create --module --template`                                                                                                                                      | `solution new --module/-t --template/-t`                                                                                                                                       | `new`                            |
+| `init`                                                                                                                                                                       | `solution init`                                                                                                                                                                | `init`                           |
+| `e2e`                                                                                                                                                                        | `solution e2e`                                                                                                                                                                 |
+| `addmodule --template`                                                                                                                                                       | `solution add --template/-t`                                                                                                                                                   | `add --template/-t`              |
+| `build --push --deploy`                                                                                                                                                      | `solution build --push/-p --deploy/-d`                                                                                                                                         | `build --push/-p --deploy/-d`    |
+| `push --deploy --no-build`                                                                                                                                                   | `solution push --deploy/-d --no-build`                                                                                                                                         | `push --deploy/-d --no-build`    |
+| `deploy`                                                                                                                                                                     | `solution deploy`                                                                                                                                                              | `deploy`                         |
+| `monitor --timeout`                                                                                                                                                          | `iothub monitor --timeout/-t`                                                                                                                                                  | `monitor --timeout/-t`           |
+| `azure --setup --credentials --service-principal --subscription --resource-group-location --resource-group-name --iothub-sku --iothub-name --edge-device-id --update-dotenv` | `iothub setup --credentials --service-principal --subscription --resource-group-location --resource-group-name --iothub-sku --iothub-name --edge-device-id --update-dotenv/-u` |
+| `modules --add --template`                                                                                                                                                   | `solution add --template`                                                                                                                                                      | `add --template/-t`              |
+| `modules --build --push --deploy`                                                                                                                                            | `solution build --push/-p --deploy/-d`                                                                                                                                         | `build --push/-p --deploy/-d`    |
+| `modules --push --deploy`                                                                                                                                                    | `solution push --deploy/-d --no-build`                                                                                                                                         | `push --deploy/-d --no-build`    |
+| `modules --deploy`                                                                                                                                                           | `solution deploy`                                                                                                                                                              | `deploy`                         |
+| `runtime --setup`                                                                                                                                                            | *deprecated, see [Retirement of `iotedgectl`](#retirement-of-iotedgectl) section*                                                                                              |
+| `runtime --start`                                                                                                                                                            | *deprecated, see [Retirement of `iotedgectl`](#retirement-of-iotedgectl) section*                                                                                              |
+| `runtime --stop`                                                                                                                                                             | *deprecated, see [Retirement of `iotedgectl`](#retirement-of-iotedgectl) section*                                                                                              |
+| `runtime --restart`                                                                                                                                                          | *deprecated, see [Retirement of `iotedgectl`](#retirement-of-iotedgectl) section*                                                                                              |
+| `runtime --status`                                                                                                                                                           | *deprecated, see [Retirement of `iotedgectl`](#retirement-of-iotedgectl) section*                                                                                              |
+| `docker --setup-registry`                                                                                                                                                    | `docker setup`                                                                                                                                                                 |
+| `docker --clean --remove-modules --remove-containers --remove-images`                                                                                                        | `docker clean --modules/-m --containers/-c --image/-i`                                                                                                                         |
+| `docker --logs --show-logs --save-logs`                                                                                                                                      | `docker log --show/-l --save/-s`                                                                                                                                               | `docker log --show/-l --save/-s` |
 
 ### Deployment manifest template
 IoT Edge Dev Tool 0.82.0 relies on the deployment manifest template to build the solution (see [Deprecation of `ACTIVE_MODULES`](#deprecation-of-active_modules) section for details). By default, it's the `deployment.template.json` file in the root of the solution folder, but you can also customize it with the `DEPLOYMENT_CONFIG_TEMPLATE_FILE` environment variable. The major difference between deployment manifest template and deployment manifest is that module image URLs in deployment manifest template can be placeholders (whose format looks like `${MODULES.filtermodule.amd64}`). The image placeholders can help you easily update the referenced module and image platform without typing lengthy image URLs. When building solutions, IoT Edge Dev Tool will parse the image placeholders, expand them with the actual image URLs and save the results in the deployment manifest in the config output folder. By default, it's the `deployment.json` file in the `config` folder, but you can also customize it with the `DEPLOYMENT_CONFIG_FILE` and `CONFIG_OUTPUT_DIR` environment variables. In addition, when adding modules, IoT Edge Dev Tool will add a corresponding section for the module in the deployment manifest template with `${MODULES.<module-name>.amd64}` as the image.

s/docs/quickstart.md

@@ -0,0 +1,152 @@
+# Quickstart
+
+This quickstart will run a container, create a solution, setup Azure resources, build and deploy modules to your device, setup and start the IoT Edge simulator, monitor messages flowing into IoT Hub, and finally deploy to the IoT Edge runtime.
+
+At the end of this quickstart, you should have the following:
+
+- Development environment.
+- IoT Hub deployed in your Azure subscription.
+- A directory with the [IoT edge deployment manifest](https://docs.microsoft.com/en-us/azure/iot-edge/module-composition?view=iotedge-2020-11), [.env file](.env.tmp) with the environment variables needed for the `iotedgedev` tool, and the source file of a custom IoT edge module (`filtermodule`).
+- The docker image of the `filtermodule`.
+- Deploying the IoT edge modules defined in the manifest on a VM or IoT Edge simulator.
+- Monitoring the messages sent to the IoT Hub.
+- Cleaning up the docker containers and images.
+
+## Pre-requisites
+
+- Docker (see [Install Docker docs](environment-setup/install-docker) for details) and add user to `docker` Unix group (see [documentation](https://docs.docker.com/engine/install/linux-postinstall/)).
+
+## Quickstart steps
+
+1. Setup your environment
+
+    There are three options to setup your environment:
+
+    - Setup the development environment manually. Please follow the [Manual Development Machine Setup Wiki](environment-setup/manual-dev-machine-setup.md).
+    - Starting the devcontainer in VS Code (see [Developing inside a Container](https://code.visualstudio.com/docs/remote/containers) for steps on how to do so).
+    - Starting the devcontainer with Docker. Please follow the [Run the IoT Edge Dev Container with Docker docs](environment-setup/run-devcontainer-docker.md).
+
+1. Initialize IoT Edge solution and setup Azure resources.
+
+    ```sh
+    iotedgedev init <foldername>
+    ```
+
+    > `iotedgedev init` will create a solution in a new folder and setup your Azure IoT Hub in a single command. The solution comes with a default C# module named `filtermodule`.
+
+    <details>
+    <summary>More information</summary>
+
+    1. You will see structure of current folder like below:
+
+    ```tree
+        │  .env
+        │  .gitignore
+        │  deployment.debug.template.json
+        │  deployment.template.json
+        │
+        ├─.vscode
+        │      launch.json
+        │
+        └─modules
+            └─filtermodule
+                │  .gitignore
+                │  Dockerfile.amd64
+                │  Dockerfile.amd64.debug
+                │  Dockerfile.arm32v7
+                │  Dockerfile.windows-amd64
+                │  filtermodule.csproj
+                │  module.json
+                │  Program.cs
+    ```
+
+    1. Open `.env` file, you will see the `IOTHUB_CONNECTION_STRING` and `DEVICE_CONNECTION_STRING` environment variables filled correctly.
+    2. Open `deployment.template.json` file.
+        1. You will see below section in the modules section:
+
+        ```json
+        "filtermodule": {
+            "version": "1.0",
+            "type": "docker",
+            "status": "running",
+            "restartPolicy": "always",
+            "settings": {
+                "image": "${MODULES.filtermodule}",
+                "createOptions": {}
+            }
+        }
+        ```
+
+        1. Two default routes are added:
+
+        ```json
+        "routes": {
+            "sensorTofiltermodule": "FROM /messages/modules/tempSensor/outputs/temperatureOutput INTO BrokeredEndpoint(\"/modules/filtermodule/inputs/input1\")",
+            "filtermoduleToIoTHub": "FROM /messages/modules/filtermodule/outputs/* INTO $upstream"
+        }
+        ```
+
+    3. You will see privacy statement like below:
+
+        ```txt
+        Welcome to iotedgedev!
+        -------------------------
+        Telemetry
+        ---------
+        The iotedgedev collects usage data in order to improve your experience.
+        The data is anonymous and does not include commandline argument values.
+        The data is collected by Microsoft.
+        
+        You can change your telemetry settings by updating 'collect_telemetry' to 'no' in ~/.iotedgedev/setting.ini
+        ```
+
+    </details>
+
+3. Build IoT Edge module images.
+
+    ```sh
+    iotedgedev build
+    ```
+
+    > This step will build user modules in deployment.template.json targeting amd64 platform.
+
+    <details>
+    <summary>More information</summary>
+
+    1. You will see a "BUILD COMPLETE" for each module and no error messages in the terminal output.
+    2. Open `config/deployment.amd64.json` file, you will see the module image placeholders expanded correctly.
+    3. Run `sudo docker image ls`, you will see the module images you just built.
+
+    </details>
+
+4. Run IoT Edge modules.
+
+    Edge modules can be started in two different ways using `iotedgedev`:
+
+    - Deploying them on a VM; please find the steps to do so in [Set up and start modules on a virtual machine](run-modules-on-vm);
+    - or in your own development machine using the `iotedgedev` simulator; please follow [Set up and start the IoT Edge Simulator](run-modules-on-simulator).
+
+5. Monitor messages sent from device to IoT Hub.
+
+    ```sh
+    iotedgedev monitor
+    ```
+
+    <details>
+    <summary>More information</summary>
+
+    1. You will see your expected messages sending to IoT Hub
+    2. Stopping the monitor doesn't stop the simulator. It will continue running until it is explicitely stopped using `iotedgedev stop` and at that time all containers used by the simulator will be cleaned up.
+
+    </details>
+
+6. Stop docker containers and remove images.
+
+    ```sh
+    # stop containers started by the simulator
+    iotedgedev stop
+    # remove stopped containers
+    iotedgedev docker clean -c
+    # remove docker images
+    iotedgedev docker clean -
+    ```

s/docs/run-modules-on-simulator.md

@@ -0,0 +1,18 @@
+
+# Set up and start the IoT Edge Simulator
+
+In order to run the modules defined in a deployment configuration (such as `config/deployment.amd64.json`) on your development machine using the `iotedgedev` simulator run the following command:
+
+```sh
+iotedgedev start --setup --file config/deployment.amd64.json
+```
+
+> The [IoT Edge Hub Simulator](https://github.com/Azure/iotedgehubdev) starts the containers defined in the IoT edge device manifest in your local machine.
+
+<details>
+<summary>More information</summary>
+
+1. You will see an "IoT Edge Simulator has been started in solution mode." message at the end of the terminal output
+2. Run ` docker ps`, you will see your modules running as well as an edgeHubDev container
+
+</details>

s/docs/run-modules-on-vm.md

@@ -0,0 +1,54 @@
+# Set up and start modules on a virtual machine
+
+1. [**Set up virtual machine to run Azure IoT Edge**](https://docs.microsoft.com/en-us/azure/iot-edge/how-to-install-iot-edge-ubuntuvm)
+2. **Create and configure an ACR (Azure Container Registry)**
+   1. [Create an Azure Container Registry](https://docs.microsoft.com/en-us/azure/container-registry/container-registry-get-started-portal)
+   2. Configure `.env` that was generated in the `iotedgedev init` step with the ACR by modifying these lines with appropriate values:
+
+       ```sh
+       CONTAINER_REGISTRY_SERVER="localhost:5000"
+       CONTAINER_REGISTRY_USERNAME=""
+       CONTAINER_REGISTRY_PASSWORD=""
+       ```
+
+3. **Push modules to ACR with**
+
+    `iotedgedev push`
+
+4. **Add registry credentials to deployment manifest**
+
+    1. Replace generated `deployment.template.json` field `registryCredentials` with
+
+        ```json
+        "registryCredentials": {
+              "privateAcr": {
+                "username": "$CONTAINER_REGISTRY_USERNAME",
+                "password": "$CONTAINER_REGISTRY_PASSWORD",
+                "address": "$CONTAINER_REGISTRY_SERVER"
+              }
+            }
+        ```
+
+        > Note: `privateAcr` can be renamed to anything else
+    2. Regenerate the `config/deployment.amd64.json`
+
+        `iotedgedev genconfig`
+
+5. **Deploy modules to device**
+
+    `iotedgedev solution deploy`
+
+6. **Troubleshooting**
+
+    - Verify modules deployment status via executing:
+
+        ```bash
+        # Populate variables from .env
+        edge_device_id=$(dotenv get DEVICE_CONNECTION_STRING |  grep -oP '(?<=DeviceId=).*(?=;Shared)')
+        iot_hub_connection_string=$(dotenv get IOTHUB_CONNECTION_STRING)
+        # Execute query
+        az iot hub module-identity list --device-id $edge_device_id --login $iot_hub_connection_string
+        ```
+
+    - [Troubleshoot IoT Edge devices from the Azure portal](https://docs.microsoft.com/en-us/azure/iot-edge/troubleshoot-in-portal)
+    - SSH into the virtual machine and follow [troubleshoot your IoT Edge device](https://docs.microsoft.com/en-us/azure/iot-edge/troubleshoot)

s/docs/{Troubleshooting.md → troubleshooting.md}

@@ -1,20 +1,21 @@
 1. `Invalid Reference Format`
-    ```
+
+    ```sh
     500 Server Error: Internal Server Error for url: http+docker://localunixsocket/v1.30/images
     500 Server Error: Internal Server Error ("invalid reference format")
     ```
 
     Solution: You likely installed Docker via `sudo apt install docker.io`. Use the proper steps for [CE here](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/#install-docker-ce), or use the [convenience script](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/#install-using-the-convenience-script).
 
-1. `('Connection aborted.', error(2, 'No such file or directory'))`
+2. `('Connection aborted.', error(2, 'No such file or directory'))`
 
     This means that you have likely do not have `DOCKER_HOST` Environment Variable set.
 
-    ```
+    ```sh
     ERROR: Could not login to Container Registry. Please verify your credentials in CONTAINER_REGISTRY_ environment variables.
     ```
 
-    ```
+    ```sh
     ('Connection aborted.', error(2, 'No such file or directory'))
     ERROR: Could not connect to docker daemon.
     ERROR: Docker is unavailable