iotedgedev 3.3.4__zip → 3.3.6__zip
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- s/.git/FETCH_HEAD +3 -1
- s/.git/HEAD +1 -1
- s/.git/hooks/fsmonitor-watchman.sample +3 -2
- s/.git/index +0 -0
- s/.git/logs/HEAD +1 -1
- s/.git/logs/refs/remotes/origin/EO +1 -1
- s/.git/logs/refs/remotes/origin/avagraw/security_fix +1 -1
- s/.git/logs/refs/remotes/origin/cherry-pick-rename +1 -1
- s/.git/logs/refs/remotes/origin/chyuan/fix-validation-not-fail-test +1 -1
- s/.git/logs/refs/remotes/origin/chyuan/update-linux-agent +1 -1
- s/.git/logs/refs/remotes/origin/dependabot/pip/cookiecutter-2.1.1 +1 -0
- s/.git/logs/refs/remotes/origin/dependabot/pip/pyyaml-5.4 +1 -1
- s/.git/logs/refs/remotes/origin/main +1 -1
- s/.git/logs/refs/remotes/origin/ray-deps +1 -1
- s/.git/logs/refs/remotes/origin/ray-dev-setup +1 -1
- s/.git/logs/refs/remotes/origin/ray-tox +1 -1
- s/.git/logs/refs/remotes/origin/release-pipeline-automation +1 -1
- s/.git/logs/refs/remotes/origin/revert-594-user/vikas_bug-pyopenssl +1 -0
- s/.git/logs/refs/remotes/origin/spmcdono/fix-pipeline-test-install +1 -1
- s/.git/logs/refs/remotes/origin/spmcdono/layered-deployments +1 -1
- s/.git/logs/refs/remotes/origin/spmcdono/pypi-package-test-pipeline +1 -1
- s/.git/logs/refs/remotes/origin/spmcdono/remove-py2 +1 -1
- s/.git/logs/refs/remotes/origin/spmcdono/remove-py2-dev +1 -1
- s/.git/logs/refs/remotes/origin/spmcdono/test-native-runtime-install +1 -1
- s/.git/logs/refs/remotes/origin/spmcdono/update-pipeline +1 -1
- s/.git/logs/refs/remotes/origin/user/marine/EliiseS/devcontainer +1 -1
- s/.git/logs/refs/remotes/origin/user/marine/fixsimver +1 -1
- s/.git/logs/refs/remotes/origin/user/marine/layereddeploymentsbuildtest +1 -1
- s/.git/logs/refs/remotes/origin/user/marine/master-to-main +1 -1
- s/.git/logs/refs/remotes/origin/user/marine/pipeline +1 -1
- s/.git/logs/refs/remotes/origin/user/vikas +1 -1
- s/.git/logs/refs/remotes/origin/user/vikas-bud-fix +1 -0
- s/.git/logs/refs/remotes/origin/user/vikas0212/verify-tests +1 -1
- s/.git/logs/refs/remotes/origin/user/vikas2 +1 -1
- s/.git/logs/refs/remotes/origin/user/vikas_bug-pyopenssl +1 -0
- s/.git/logs/refs/remotes/origin/user/vikas_pypi +1 -1
- s/.git/logs/refs/remotes/origin/user/vikas_pypi-1 +1 -1
- s/.git/logs/refs/remotes/origin/user/vikas_supplychain-issue1 +1 -0
- s/.git/logs/refs/remotes/origin/user/vikas_testing +1 -1
- s/.git/logs/refs/remotes/origin/user/vikas_trigger +1 -0
- s/.git/logs/refs/remotes/origin/user/vikas_trigger_new +1 -0
- s/.git/logs/refs/remotes/origin/user/xinzed/dps_conn_str +1 -1
- s/.git/logs/refs/remotes/origin/user/xinzed/update-python-docker +1 -1
- s/.git/logs/refs/remotes/origin/vikas/azure +1 -1
- s/.git/logs/refs/remotes/origin/vikas/dependebot +1 -1
- s/.git/logs/refs/remotes/origin/vikas-triggers +1 -0
- s/.git/logs/refs/remotes/origin/xinzed/3_1_0rc1 +1 -1
- s/.git/logs/refs/remotes/origin/xinzed/update-runtime +1 -1
- s/.git/objects/pack/pack-b6923255c7f7ef51c11dbd2c8db7ce310d4daf99.idx +0 -0
- s/.git/objects/pack/{pack-a8179feb7da51d11a42c37c5b3c8593cffe17075.pack → pack-b6923255c7f7ef51c11dbd2c8db7ce310d4daf99.pack} +0 -0
- s/.git/refs/remotes/origin/dependabot/pip/cookiecutter-2.1.1 +1 -0
- s/.git/refs/remotes/origin/main +1 -1
- s/.git/refs/remotes/origin/revert-594-user/vikas_bug-pyopenssl +1 -0
- s/.git/refs/remotes/origin/user/vikas-bud-fix +1 -0
- s/.git/refs/remotes/origin/user/vikas_bug-pyopenssl +1 -0
- s/.git/refs/remotes/origin/user/vikas_supplychain-issue1 +1 -0
- s/.git/refs/remotes/origin/user/vikas_trigger +1 -0
- s/.git/refs/remotes/origin/user/vikas_trigger_new +1 -0
- s/.git/refs/remotes/origin/vikas-triggers +1 -0
- s/.git/refs/tags/v3.3.5 +1 -0
- s/.git/refs/tags/v3.3.6 +1 -0
- s/.github/ISSUE_TEMPLATE/01_bug_report.yml +55 -0
- s/.github/ISSUE_TEMPLATE/02_feature_request.yml +14 -0
- s/.github/pull_request_template.md +35 -0
- s/.github/workflows/wiki.yml +1 -1
- s/.vscode/launch.json +2 -2
- s/.vscode/settings.json +2 -1
- s/CHANGELOG.md +68 -4
- s/CONTRIBUTING.md +30 -97
- s/Makefile +1 -2
- s/README.md +16 -169
- s/SECURITY.md +41 -0
- s/build/lib/iotedgedev/__init__.py +1 -1
- s/build/lib/iotedgedev/azurecli.py +47 -4
- s/build/lib/iotedgedev/cli.py +98 -52
- s/build/lib/iotedgedev/connectionstring.py +10 -8
- s/build/lib/iotedgedev/edge.py +1 -1
- s/build/lib/iotedgedev/envvars.py +1 -0
- s/build/lib/iotedgedev/output.py +4 -0
- s/dist/iotedgedev-3.3.6-py3-none-any.whl +0 -0
- s/docker/tool/build-docker.sh +3 -3
- s/docker/tool/deps.txt +1 -1
- s/docker/tool/linux/Dockerfile.base +7 -4
- s/docker/tool/windows/Dockerfile.base +1 -1
- s/docs/_Sidebar.md +5 -4
- s/docs/{Azure-Setup.md → azure-setup.md} +19 -18
- s/docs/{Command-List.md → command-list.md} +1 -0
- s/docs/{Edge-Device-Setup.md → edge-device-setup.md} +5 -4
- s/docs/environment-setup/install-docker.md +9 -0
- s/docs/environment-setup/manual-dev-machine-setup.md +79 -0
- s/docs/{Python-Virtual-Environment-Setup.md → environment-setup/python-virtual-environment-setup.md} +7 -8
- s/docs/environment-setup/run-devcontainer-docker.md +24 -0
- s/docs/home.md +10 -0
- s/docs/{Migration-Guides.md → migration-guides.md} +26 -26
- s/docs/quickstart.md +152 -0
- s/docs/run-modules-on-simulator.md +18 -0
- s/docs/run-modules-on-vm.md +54 -0
- s/docs/{Troubleshooting.md → troubleshooting.md} +5 -4
- s/docs/{Usage.md → usage.md} +19 -20
- s/iotedgedev/__init__.py +1 -1
- s/iotedgedev/azurecli.py +47 -4
- s/iotedgedev/cli.py +98 -52
- s/iotedgedev/connectionstring.py +10 -8
- s/iotedgedev/edge.py +1 -1
- s/iotedgedev/envvars.py +1 -0
- s/iotedgedev/output.py +4 -0
- s/iotedgedev.egg-info/PKG-INFO +1 -1
- s/iotedgedev.egg-info/SOURCES.txt +2 -1
- s/iotedgedev.egg-info/requires.txt +2 -2
- s/requirements.txt +3 -3
- s/setup.cfg +1 -1
- s/setup.py +5 -3
- s/tests/__init__.py +1 -1
- s/tests/assets/test_solution_shared_lib/deployment.template.json +1 -1
- s/tests/assets/test_solution_shared_lib/layered_deployment.flattened_props.template.json +43 -9
- s/tests/test_iotedgedev_iothub_deploy.py +0 -1
- s/tests/test_iotedgedev_solution.py +3 -4
- s/tests/test_iotedgedev_solution_build.py +0 -19
- s/tests/test_iotedgedev_solution_deploy.py +197 -0
- s/tests/test_iotedgedev_solution_init.py +34 -0
- s/.git/logs/refs/remotes/origin/eliises/add-device-tagging-docs +0 -1
- s/.git/objects/pack/pack-a8179feb7da51d11a42c37c5b3c8593cffe17075.idx +0 -0
- s/.git/refs/remotes/origin/eliises/add-device-tagging-docs +0 -1
- s/.github/ISSUE_TEMPLATE/bug_report.md +0 -16
- s/.github/ISSUE_TEMPLATE/feature_request.md +0 -7
- s/dist/iotedgedev-3.3.4-py3-none-any.whl +0 -0
- s/docs/Home.md +0 -10
- s/docs/Manual-Dev-Machine-Setup.md +0 -77
- s/docs/Quickstart-with-IoT-Edge-Dev-Container.md +0 -145
- s/pull_request_template.md +0 -9
- s/tests/assets/test_solution_shared_lib/layered_deployment.no_modules.template.json +0 -12
- /s/docs/{Command-Tips.md → command-tips.md} +0 -0
- /s/docs/{Overview.md → overview.md} +0 -0
- /s/docs/{Test-Coverage.md → test-coverage.md} +0 -0
|
@@ -1,145 +0,0 @@
|
|
|
1
|
-
Here is the absolute fastest way to get IoT Edge Dev Tool (aka `iotedgedev`) running on your dev machine with the IoT Edge Dev Container.
|
|
2
|
-
|
|
3
|
-
You can use the IoT Edge Dev Tool container to avoid having to install all the dependencies on your local dev machine. The only thing you need to install is Docker. All of the other dev dependencies are included in the container.
|
|
4
|
-
|
|
5
|
-
1. **Install [Docker CE](https://docs.docker.com/install/)**
|
|
6
|
-
|
|
7
|
-
- For Windows, please follow [the document](https://docs.docker.com/docker-for-windows/#shared-drives) to open Docker Settings and setup a Shared Drive.
|
|
8
|
-
- For macOS, please follow [the document](https://docs.docker.com/docker-for-mac/#file-sharing) to choose local directories to share with your containers.
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
1. **Run the IoT Edge Dev Container**
|
|
12
|
-
|
|
13
|
-
Before you run the container, you will need to create a local folder to store your IoT Edge solution files.
|
|
14
|
-
|
|
15
|
-
**Windows**
|
|
16
|
-
```
|
|
17
|
-
mkdir c:\temp\iotedge
|
|
18
|
-
docker run -ti -v /var/run/docker.sock:/var/run/docker.sock -v c:/temp/iotedge:/home/iotedge microsoft/iotedgedev
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
**Linux**
|
|
22
|
-
```
|
|
23
|
-
sudo mkdir /home/iotedge
|
|
24
|
-
sudo docker run -ti -v /var/run/docker.sock:/var/run/docker.sock -v ~/iotedge:/home/iotedge microsoft/iotedgedev
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
**macOS**
|
|
28
|
-
```
|
|
29
|
-
mkdir ~/iotedge
|
|
30
|
-
docker run -ti -v /var/run/docker.sock:/var/run/docker.sock -v ~/iotedge:/home/iotedge microsoft/iotedgedev
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
1. **Initialize IoT Edge solution and setup Azure resources**
|
|
34
|
-
|
|
35
|
-
`iotedgedev init`
|
|
36
|
-
|
|
37
|
-
> `iotedgedev init` will create a solution and setup your Azure IoT Hub in a single command. The solution comes with a default C# module named `filtermodule`.
|
|
38
|
-
|
|
39
|
-
<details>
|
|
40
|
-
<summary>More information</summary>
|
|
41
|
-
|
|
42
|
-
1. You will see structure of current folder like below:
|
|
43
|
-
|
|
44
|
-
```
|
|
45
|
-
│ .env
|
|
46
|
-
│ .gitignore
|
|
47
|
-
│ deployment.debug.template.json
|
|
48
|
-
│ deployment.template.json
|
|
49
|
-
│
|
|
50
|
-
├─.vscode
|
|
51
|
-
│ launch.json
|
|
52
|
-
│
|
|
53
|
-
└─modules
|
|
54
|
-
└─filtermodule
|
|
55
|
-
│ .gitignore
|
|
56
|
-
│ Dockerfile.amd64
|
|
57
|
-
│ Dockerfile.amd64.debug
|
|
58
|
-
│ Dockerfile.arm32v7
|
|
59
|
-
│ Dockerfile.windows-amd64
|
|
60
|
-
│ filtermodule.csproj
|
|
61
|
-
│ module.json
|
|
62
|
-
│ Program.cs
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
2. Open `.env` file, you will see the `IOTHUB_CONNECTION_STRING` and `DEVICE_CONNECTION_STRING` environment variables filled correctly.
|
|
66
|
-
3. Open `deployment.template.json` file
|
|
67
|
-
1. You will see below section in the modules section:
|
|
68
|
-
|
|
69
|
-
```
|
|
70
|
-
"filtermodule": {
|
|
71
|
-
"version": "1.0",
|
|
72
|
-
"type": "docker",
|
|
73
|
-
"status": "running",
|
|
74
|
-
"restartPolicy": "always",
|
|
75
|
-
"settings": {
|
|
76
|
-
"image": "${MODULES.filtermodule}",
|
|
77
|
-
"createOptions": ""
|
|
78
|
-
}
|
|
79
|
-
}
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
2. Two default routes are added:
|
|
83
|
-
|
|
84
|
-
```
|
|
85
|
-
"routes": {
|
|
86
|
-
"sensorTofiltermodule": "FROM /messages/modules/tempSensor/outputs/temperatureOutput INTO BrokeredEndpoint(\"/modules/filtermodule/inputs/input1\")",
|
|
87
|
-
"filtermoduleToIoTHub": "FROM /messages/modules/filtermodule/outputs/* INTO $upstream"
|
|
88
|
-
}
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
4. You will see privacy statement like below:
|
|
92
|
-
|
|
93
|
-
```
|
|
94
|
-
Welcome to iotedgedev!
|
|
95
|
-
-------------------------
|
|
96
|
-
Telemetry
|
|
97
|
-
---------
|
|
98
|
-
The iotedgedev collects usage data in order to improve your experience.
|
|
99
|
-
The data is anonymous and does not include commandline argument values.
|
|
100
|
-
The data is collected by Microsoft.
|
|
101
|
-
|
|
102
|
-
You can change your telemetry settings by updating 'collect_telemetry' to 'no' in ~/.iotedgedev/setting.ini
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
</details>
|
|
106
|
-
|
|
107
|
-
1. **Build IoT Edge module images**
|
|
108
|
-
|
|
109
|
-
`sudo iotedgedev build`
|
|
110
|
-
|
|
111
|
-
> This step will build user modules in deployment.template.json targeting amd64 platform. You can use the `--file` and `--platform` parameters to change this behavior.
|
|
112
|
-
|
|
113
|
-
<details>
|
|
114
|
-
<summary>More information</summary>
|
|
115
|
-
|
|
116
|
-
1. You will see a "BUILD COMPLETE" for each module and no error messages in the terminal output.
|
|
117
|
-
2. Open `config/deployment.amd64.json` file, you will see the module image placeholders expanded correctly.
|
|
118
|
-
3. Run `sudo docker image ls`, you will see the module images you just built.
|
|
119
|
-
|
|
120
|
-
</details>
|
|
121
|
-
|
|
122
|
-
1. **Setup and start the IoT Edge Simulator to run the solution**
|
|
123
|
-
|
|
124
|
-
`sudo iotedgedev start --setup --file config/deployment.amd64.json`
|
|
125
|
-
|
|
126
|
-
> 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.
|
|
127
|
-
|
|
128
|
-
<details>
|
|
129
|
-
<summary>More information</summary>
|
|
130
|
-
|
|
131
|
-
1. You will see an "IoT Edge Simulator has been started in solution mode." message at the end of the terminal output
|
|
132
|
-
2. Run `sudo docker ps`, you will see your modules running as well as an edgeHubDev container
|
|
133
|
-
|
|
134
|
-
</details>
|
|
135
|
-
|
|
136
|
-
1. **Monitor messages sent from IoT Edge Simulator to IoT Hub**
|
|
137
|
-
|
|
138
|
-
`iotedgedev monitor`
|
|
139
|
-
|
|
140
|
-
<details>
|
|
141
|
-
<summary>More information</summary>
|
|
142
|
-
|
|
143
|
-
1. You will see your expected messages sending to IoT Hub
|
|
144
|
-
|
|
145
|
-
</details>
|
s/pull_request_template.md
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
## iotedgedev Pull Request Checklist
|
|
2
|
-
|
|
3
|
-
- [ ] Versions updated (both __init__.py files, CHANGELOG, setup.py, setup.cfg)
|
|
4
|
-
- [ ] Unit tests pass locally
|
|
5
|
-
- [ ] Quickstart steps locally validated
|
|
6
|
-
- [ ] Passes unit tests in CICD pipeline (green on Github pipeline)
|
|
7
|
-
- [ ] Pypi RC version passes Edge CICD pipeline validation for cross-tool validation
|
|
8
|
-
|
|
9
|
-
## Additional comments
|
|
File without changes
|
|
File without changes
|
|
File without changes
|