microsoft
/
vscode-azure-iot-edge
зеркало из https://github.com/microsoft/vscode-azure-iot-edge.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Update CHANGELOG and README (#128)

This commit is contained in:
Ray Fang 2018-04-27 17:21:05 +08:00 коммит произвёл GitHub
Родитель d5d9825223
Коммит bac682ce88
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
2 изменённых файлов: 43 добавлений и 29 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

14
CHANGELOG.md
Просмотреть файл

@ -1,4 +1,18 @@
# Change Log
## 0.3.0 - 2018-04-??
### Added
* Add Node.js module to solution (read the documentation [here](https://docs.microsoft.com/en-us/azure/iot-edge/tutorial-node-module))
* Import existing module from container registry when adding new module to solution
* Support adding extra Docker build options in the `buildOptions` array of module.json
* New IntelliSense features (watch the screencasts [here](https://github.com/Microsoft/vscode-azure-iot-edge/issues/115))
* Dockerfile path validation in module.json
* Image placeholder validation in deployment.template.json
* Dockerfile content hover preview in deployment.template.json
* Go-to-Dockerfile in deployment.template.json
* "Azure" branding to command palette category
### Changed
* Always check out the `master` branch of [Cookiecutter template](https://github.com/Azure/cookiecutter-azure-iot-edge-module/) when adding Python module
## 0.2.0 - 2018-03-27
### Added
* Introduce IoT Edge Solution which includes multiple modules and a deployment manifest template (deployment.template.json)

58
README.md
Просмотреть файл

@ -8,13 +8,13 @@
- Add new IoT Edge module to Edge solution
- Build and publish IoT Edge modules
- Debug IoT Edge modules locally
- Intellisense and code snippets for the deployment manifest
- IntelliSense and code snippets for the deployment manifest
- Manage IoT Edge devices and modules in IoT Hub (with [Azure IoT Toolkit](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.azure-iot-toolkit))
- Deploy IoT solutions to IoT Edge devices
- Manage IoT Edge runtime.
### Note
From 0.2.0, we added a new Azure IoT Edge solution scaffolding. The Azure IoT Edge module structure has also been changed. For the legacy Azure IoT Edge modules (C# module/C# Function) created in previous versions, a command "Edge: Convert to IoT Edge Module" is provided to support the migration. For detail information, please refer to the [migration steps](MIGRATION_STEPS.md).
From 0.2.0, we added a new Azure IoT Edge solution scaffolding. The Azure IoT Edge module structure has also been changed. For the legacy Azure IoT Edge modules (C# module/C# Function) created in previous versions, a command "Azure IoT Edge: Convert to IoT Edge Module" is provided to support the migration. For detail information, please refer to the [migration steps](MIGRATION_STEPS.md).
## Prerequisites
@ -36,36 +36,36 @@ For Node.js developer, you can develop, debug and deploy [Node.js module](https:
We will soon support other languages and more services on Azure IoT Edge.
## Commnads
## Commands
Press `F1` or `Ctrl + Shift + P` to open command palette, type `Edge:` to see all the commands:
- **Edge: Setup Edge**: Setup the IoT Edge runtime.
- **Edge: Start Edge**: Start IoT Edge runtime in your local machine.
- **Edge: New IoT Edge Solution**: Create an IoT Edge solution.
- **Edge: Add IoT Edge Module**: Add a new IoT Edge module to the IoT Edge solution.
- **Edge: Build IoT Edge Module Image**: Containerize IoT Edge module from source code.
- **Edge: Build and Push IoT Edge Module Image**: Containerize and push IoT Edge module image to a Docker registry.
- **Edge: Build IoT Edge Solution**: Build and push all the IoT Edge module image in the solution and expand deployment manifest.
- **Edge: Generate IoT Edge Deployment Manifest**: Generate the deployment manifest file for IoT Edge deployment from deployment template.
- **Edge: Create deployment for Edge device**: Create and submit the deployment to your IoT Edge device with specified deployment manifest.
- **Edge: Setup Edge using configuration file**: Take a configuration file for IoT Edge setup.
- **Edge: Generate Edge setup configuration file**: Generate the json file for IoT Edge: setup IoT Edge using configuration file. Open the json file to see further description.
- **Edge: Stop Edge**: Stop IoT Edge runtime.
- **Edge: Restart Edge**: Restart the IoT Edge runtime.
- **Edge: Uninstall**: Remove all modules and generated files.
- **Edge: Log in to container registry**: Add registry credentials to IoT Edge runtime.
Press `F1` or `Ctrl + Shift + P` to open command palette, type `Azure IoT Edge:` to see all the commands:
- **Azure IoT Edge: Setup Edge**: Setup the IoT Edge runtime.
- **Azure IoT Edge: Start Edge**: Start IoT Edge runtime in your local machine.
- **Azure IoT Edge: New IoT Edge Solution**: Create an IoT Edge solution.
- **Azure IoT Edge: Add IoT Edge Module**: Add a new IoT Edge module to the IoT Edge solution.
- **Azure IoT Edge: Build IoT Edge Module Image**: Containerize IoT Edge module from source code.
- **Azure IoT Edge: Build and Push IoT Edge Module Image**: Containerize and push IoT Edge module image to a Docker registry.
- **Azure IoT Edge: Build IoT Edge Solution**: Build and push all the IoT Edge module image in the solution and expand deployment manifest.
- **Azure IoT Edge: Generate IoT Edge Deployment Manifest**: Generate the deployment manifest file for IoT Edge deployment from deployment template.
- **Azure IoT Edge: Create deployment for Edge device**: Create and submit the deployment to your IoT Edge device with specified deployment manifest.
- **Azure IoT Edge: Setup Edge using configuration file**: Take a configuration file for IoT Edge setup.
- **Azure IoT Edge: Generate Edge setup configuration file**: Generate the JSON file for Azure IoT Edge: Setup IoT Edge using configuration file. Open the JSON file to see further description.
- **Azure IoT Edge: Stop Edge**: Stop IoT Edge runtime.
- **Azure IoT Edge: Restart Edge**: Restart the IoT Edge runtime.
- **Azure IoT Edge: Uninstall**: Remove all modules and generated files.
- **Azure IoT Edge: Log in to container registry**: Add registry credentials to IoT Edge runtime.
You can also trigger following frequently-used commands in context menu.
- **Edge: Add IoT Edge Module**: The context menu of deployment.template.json file in VS Code file explorer. A new module will be added to the **modules** folder.
- **Edge: Build IoT Edge Solution**: The context menu of deployment.template.json file in VS Code file explorer.
- **Edge: Generate IoT Edge Deployment Manifest**: The context menu of deployment.template.json file in VS Code file explorer. The deployment manifest (deployment.json) will be expanded from deployment.template.json.
- **Edge: Build IoT Edge Module Image**: The context menu of the module.json file in VS Code file explorer. With the input platform from user, it will build the image with the target Dockerfile.
- **Edge: Build and Push IoT Edge Module Image**: The context menu of the module.json file in VS Code file explorer. With the input platform from user, it will build and push image with the target Dockerfile.
- **Edge: Create deployment for Edge device**: The context menu of an IoT Edge device in device list. Create a deployment for target IoT Edge device with deployment manifest file you select.
- **Edge: Setup Edge**: The context menu of an IoT Edge device in device list. Setup IoT Edge runtime with target device connection string.
- **Edge: Generate Edge setup configuration file**: The context menu of an IoT Edge device in device list. Device connection string will be passed to the IoT Edge setup configuration file.
- **Edge: Get module twin**: The context menu of a deployed module. Fetch target module twin.
- **Edge: Convert to IoT Edge Module**: The context menu of .csproj file of C# module or host.json of C# IoT Edge function module in VSCode file explorer. Convert the legacy IoT Edge module (C# module and C# function module) to the new structure.
- **Azure IoT Edge: Add IoT Edge Module**: The context menu of deployment.template.json file in VS Code file explorer. A new module will be added to the **modules** folder.
- **Azure IoT Edge: Build IoT Edge Solution**: The context menu of deployment.template.json file in VS Code file explorer.
- **Azure IoT Edge: Generate IoT Edge Deployment Manifest**: The context menu of deployment.template.json file in VS Code file explorer. The deployment manifest (deployment.json) will be expanded from deployment.template.json.
- **Azure IoT Edge: Build IoT Edge Module Image**: The context menu of the module.json file in VS Code file explorer. With the input platform from user, it will build the image with the target Dockerfile.
- **Azure IoT Edge: Build and Push IoT Edge Module Image**: The context menu of the module.json file in VS Code file explorer. With the input platform from user, it will build and push image with the target Dockerfile.
- **Azure IoT Edge: Create deployment for Edge device**: The context menu of an IoT Edge device in device list. Create a deployment for target IoT Edge device with deployment manifest file you select.
- **Azure IoT Edge: Setup Edge**: The context menu of an IoT Edge device in device list. Setup IoT Edge runtime with target device connection string.
- **Azure IoT Edge: Generate Edge setup configuration file**: The context menu of an IoT Edge device in device list. Device connection string will be passed to the IoT Edge setup configuration file.
- **Azure IoT Edge: Get module twin**: The context menu of a deployed module. Fetch target module twin.
- **Azure IoT Edge: Convert to IoT Edge Module**: The context menu of .csproj file of C# module or host.json of C# IoT Edge function module in VSCode file explorer. Convert the legacy IoT Edge module (C# module and C# function module) to the new structure.
## Code Snippets