DPS: update client library documentation #152
Conversation
WalkthroughThe recent updates to the Device Provisioning Service (DPS) involve deprecating old functions, introducing new endpoint management functions, enhancing retry mechanisms, and verifying endpoint certificates. These changes aim to improve flexibility, reliability, and security in device provisioning processes. Changes
Recent Review DetailsConfiguration used: CodeRabbit UI Files ignored due to path filters (1)
Files selected for processing (4)
Additional Context UsedLanguageTool (226)
Additional comments not posted (9)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
✅ Deploy Preview for docsplgd ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Danielius1922
force-pushed
the
adam/feature/dps-multiple-endpoints
branch
from
d0c9041 to
2ca1c3d
Compare
Danielius1922
force-pushed
the
adam/feature/dps-multiple-endpoints
branch
from
2ca1c3d to
24ec46e
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
content/en/docs/services/device-provisioning-service/retry-mechanism.md
Outdated
Show resolved
Hide resolved
content/en/docs/services/device-provisioning-service/retry-mechanism.md
Outdated
Show resolved
Hide resolved
Danielius1922
force-pushed
the
adam/feature/dps-multiple-endpoints
branch
from
8d72034 to
049474e
Compare
content/en/docs/services/device-provisioning-service/features.md
Outdated
Show resolved
Hide resolved
| @@ -23,3 +23,4 @@ weight: 2 | |||
| - **☐ Initial device configuration:** This planned feature aims to provide users with a mechanism to perform the initial configuration of devices during the provisioning process. | |||
| - **☐ Blacklisting and whitelisting devices:** With this feature, users will have the ability to blacklist or whitelist specific devices for enhanced access control. | |||
| - **☐ Manual approval for device configuration:** This planned feature enables a mechanism where devices require manual approval from the user in order to receive configuration settings. Instead of automatic configuration, users will have control over granting permission for device configuration. | |||
| - **☐ Verify Common Name:** Verify that the Common Name of DPS endpoint certificate matches the name of the selected endpoint. | |||
There was a problem hiding this comment.
This is needed in dps-client not in dps-service:
Verify Common Name:** Verify that the Common Name of DPS endpoint certificate matches the name of the selected endpoint by dps client.
| @@ -29,6 +29,8 @@ The configuration can be changed by the `plgd_dps_set_retry_configuration` funct | |||
|
|
|||
| Provisioning consists of 3 main steps: | |||
| @@ -29,6 +29,8 @@ The configuration can be changed by the `plgd_dps_set_retry_configuration` funct | |||
|
|
|||
| Provisioning consists of 3 main steps: | |||
|
|
|||
| * synchronization of time | |||
| * requesting and set of device owner | |||
| * sending of signing certificate request | |||
| * requesting and applying of ACLs | |||
| * requesting and applying of plgd hub connection configuration | |||
There was a problem hiding this comment.
move up before signing certificate.
Danielius1922
force-pushed
the
adam/feature/dps-multiple-endpoints
branch
from
b01f841 to
e11e68f
Compare
|
|
||
| Moreover, once the retry counter reaches higher value than the maximal index of the configuration array, not only is the counter reset back to zero, but the library attempts to change the selected DPS endpoint. If the are more than one DPS endpoint servers configured, then the selected endpoint is changed to the next in the list (the list is considered circular, so the next endpoint after the last endpoint is the first endpoint). | ||
|
|
||
| To set up a custom retry action use `plgd_dps_set_schedule_action`. |
There was a problem hiding this comment.
Add a comma for clarity in the instruction.
- To set up a custom retry action use `plgd_dps_set_schedule_action`.
+ To set up a custom retry action, use `plgd_dps_set_schedule_action`.This correction improves the readability of the instruction.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| To set up a custom retry action use `plgd_dps_set_schedule_action`. | |
| To set up a custom retry action, use `plgd_dps_set_schedule_action`. |
|
Summary by CodeRabbit