Azure-docs: createOptions needs proper documentation

[Tam66662]

Relevant Azure Service or Technology: IoT Edge Module
Published Documentation: https://docs.microsoft.com/en-us/azure/iot-edge/module-edgeagent-edgehub
Feedback:

There is zero documentation or examples from Microsoft on how to properly configure the createOptions feature to send flags to docker. The current documentation links you directly to Docker's explanation of the "Create Container" properties, but the mapping between Microsoft's createOptions and Docker's properties are not entirely 1:1.

Please provide detailed documentation, along with proper examples, of the most used "docker run" parameters that createOptions supports, such as:

• Mapping host port to container port
• Mapping a host path to a container volume (do we use "Volumes {}" or "HostConfig { Binds [] }" ?)
• Running a docker container as a non-priveleged user (instead of root)
• Passing EULA, Billing, and ApiKey parameters for Microsoft Cognitive Services

Thank you.

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: a79690c6-2784-a53e-7b34-6b428b01f9bf
• Version Independent ID: b97c6e5f-323c-e7e5-b010-5c3e521935b1
• Content: Properties of the agent and hub module twins - Azure IoT Edge
• Content Source: articles/iot-edge/module-edgeagent-edgehub.md
• Service: iot-edge
• GitHub Login: @kgremban
• Microsoft Alias: kgremban

[BharathNimmala-MSFT]

@Tam66662 Thank you for your feedback, our team will further look into it and get back to you at the earliest.

[AshokPeddakotla-MSFT]

@Tam66662 I have assigned the issue to the content author to evaluate and update as appropriate.

[kgremban]

@Tam66662 Thanks for creating this issue, and especially thank you for including createOptions scenarios that you want to use. We've heard similar feedback from other users, and have plans to work on this content. I'll update this issue when there's something published for you to take a look at.

[ckcampbell248]

Adding on that I would like to see examples for mapping devices...for example a USB camera.

[AshokPeddakotla-MSFT]

@kgremban Thanks for the doc update. Just wanted to check if this issue can be closed.

[kgremban]

@AshokPeddakotla-MSFT Thanks for the reminder.

@Tam66662 I added a new article providing some standard information about formatting createOptions, and samples from some common scenarios: https://docs.microsoft.com/en-us/azure/iot-edge/how-to-use-create-options. This is definitely a work in progress, as we'll be building out the content to reflect additional scenarios (including @ckcampbell248's request for accessing external hardware) but I wanted to check in with you to see if this new article answers your core request for information about configuring and formatting create options?

[Tam66662]

@kgremban Thank you for doing this. The link you provided was very helpful and informative and covers my core request. I appreciate the new documentation!