Skip to content

Commit

Permalink
Update README and CHANGELOG (#360)
Browse files Browse the repository at this point in the history
  • Loading branch information
LazarusX authored Nov 26, 2018
1 parent 5dde149 commit 7f6d956
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# Changelog
All notable changes to this project since 0.82.0 will be documented in this file.

## [1.1.0] - 2018-11-26
### Added
- Support parsing `createOptions` in JSON dictionary format
- Support multi-platform deployment manifest template, where modules' image placeholders are platform neutral (`${MODULE.filtermodule}` vs. `${MODULES.filtermodule.amd64}`). You can specify the platforms to build using the `--platform` parameter. By default, we provide "arm32v7", "amd64" and "windows-amd64" as the platform set since these are Azure IoT Edge supporting platforms today
- Add **deployment.debug.template.json** when creating new solutions. This template refers to the debug flavour image of the modules and has debug `createOptions` populated automatically. You can specify the deployment manifest template to build using the `--file` parameter

### Changed
- Default to JSON dictionary format for newly created modules' `createOptions`
- Show more clear message when failing to connect to Docker daemon

## [1.0.0] - 2018-11-01
### Added
- Support adding Java modules
Expand Down
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ The only thing you need to install is Docker. All of the other dev dependencies
```
│ .env
│ .gitignore
| deployment.debug.template.json
│ deployment.template.json
├─.vscode
Expand Down Expand Up @@ -96,7 +97,7 @@ The only thing you need to install is Docker. All of the other dev dependencies
"status": "running",
"restartPolicy": "always",
"settings": {
"image": "${MODULES.filtermodule.amd64}",
"image": "${MODULES.filtermodule}",
"createOptions": {}
}
}
Expand Down Expand Up @@ -130,19 +131,21 @@ The only thing you need to install is Docker. All of the other dev dependencies
1. **Build IoT Edge module images**
`sudo 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.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.
1. Open `config/deployment.amd64.json` file, you will see the module image placeholders expanded correctly.
1. Run `sudo docker image ls`, you will see the module images you just built.
</details>
1. **Setup and start the IoT Edge Simulator to run the solution**
`sudo iotedgedev start --setup`
`sudo iotedgedev start --setup --file config/deployment.amd64.json`
> IoT Edge Simulator does not support running Python and C modules yet. You'll need IoT Edge Runtime to run your Python and C modules.
Expand Down

0 comments on commit 7f6d956

Please sign in to comment.