Azure / azure-iot-cli-extension

Azure IoT extension for Azure CLI
Other
83 stars 65 forks source link

Incorrect alias definition for 'layered' parameter #664

Closed navba-MSFT closed 1 year ago

navba-MSFT commented 1 year ago

The description for the --layered parameter, says "This option is an alias for --no-validation." I don't think it is an alias for --no-validation - it seems to have a different operation.

https://learn.microsoft.com/en-us/cli/azure/iot/edge/deployment?view=azure-cli-latest

Fixes Azure/azure-cli#26502


This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Thank you for contributing to the IoT extension!

This checklist is used to make sure that common guidelines for a pull request are followed.

General Guidelines

Intent for Production

Basic expectations

Azure IoT CLI maintainers reserve the right to enforce any of the outlined expectations.

A PR is considered ready for review when all basic expectations have been met (or do not apply).

digimaun commented 1 year ago

In todays az iot edge deployment create command --layered has the same effect as --no-validation which is to disable client side json schema validation for $edgeHub and $edgeAgent. The schemas used are for full/base deployments.

navba-MSFT commented 1 year ago

In todays az iot edge deployment create command --layered has the same effect as --no-validation which is to disable client side json schema validation for $edgeHub and $edgeAgent. The schemas used are for full/base deployments.

@digimaun Thanks for reviewing. If I understood this correctly, the current description This option is an alias for --no-validation. is valid ?

digimaun commented 1 year ago

In todays az iot edge deployment create command --layered has the same effect as --no-validation which is to disable client side json schema validation for $edgeHub and $edgeAgent. The schemas used are for full/base deployments.

@digimaun Thanks for reviewing. If I understood this correctly, the current description This option is an alias for --no-validation. is valid ?

Yea the description is accurate. In short, a layered deployment is determined based on an existing base deployment and the form of the users modulesContent, rather than a service toggle. The edge deployment create command description describes this more. There is history around this, we've talked about potential deprecation of the flag, however it currently remains where we may add some form of layered validation.