Make comments in the config.yaml for provisioning and certificates clearer. #4542
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…earer.
- Grammar and capitalization ("ID", "DPS", etc).
- Consistent wording to refer to certificates and private keys.
("Path of the X certificate", "Path of the private key of the X certificate").
- Clarify that all certificate and private key paths are specified as file URIs,
with examples.
- Split DPS provisioning sections into one section per attestation method,
and dispense with the awkward "Required if... Optional if..." prologue
on every field.
- Clarify `dynamic_reprovisioning` some more, especially its default.
- Consistently document `always_reprovision_on_startup` and
`auto_generated_ca_lifetime_days` in all config files.
arsing
requested review from
massand,
micahl,
varunpuranik,
lfitchett and
gordonwang0
gordonwang0
reviewed
Mar 5, 2021
gordonwang0
approved these changes
Mar 5, 2021
micahl
approved these changes
Mar 6, 2021
varunpuranik
approved these changes
Mar 6, 2021
darobs
pushed a commit
to darobs/iotedge
that referenced
this pull request
Mar 22, 2021
…earer. (Azure#4542) - Grammar and capitalization ("ID", "DPS", etc). - Consistent wording to refer to certificates and private keys. ("Path of the X certificate", "Path of the private key of the X certificate"). - Clarify that all certificate and private key paths are specified as file URIs, with examples. - Split DPS provisioning sections into one section per attestation method, and dispense with the awkward "Required if... Optional if..." prologue on every field. - Clarify what `always_reprovision_on_startup` and `dynamic_reprovisioning` do more clearly, especially their defaults. - Consistently document `always_reprovision_on_startup` and `auto_generated_ca_lifetime_days` in all config files.
darobs
added a commit
that referenced
this pull request
Mar 30, 2021
* Update pipeline triggers for release/1.1 (#4365) * Make comments in the config.yaml for provisioning and certificates clearer. (#4542) * fail and drop message on authentication error with Scope authentication (#4451) * Update ASP.NET Core Runtime base images (#4573) * Prepare for Release 1.1.1 (#4585) * Fix NugetSecurity warning for Long Haul pipeline (#4588) * add guid to module and device name (#4589) * Fix typo in `always_reprovision_on_startup` config.yaml docs. (#4612) * Prepare for Release 1.1.1 (pt2) (#4617) Co-authored-by: Damon Barry <damonbarry@users.noreply.github.com> Co-authored-by: Arnav Singh <arsing@microsoft.com> Co-authored-by: Anca Antochi <ancan@microsoft.com> Co-authored-by: David Lu <davilu@microsoft.com> Co-authored-by: yophilav <54859653+yophilav@users.noreply.github.com> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Grammar and capitalization ("ID", "DPS", etc).
Consistent wording to refer to certificates and private keys.
("Path of the X certificate", "Path of the private key of the X certificate").
Clarify that all certificate and private key paths are specified as file URIs,
with examples.
Split DPS provisioning sections into one section per attestation method,
and dispense with the awkward "Required if... Optional if..." prologue
on every field.
Clarify what
always_reprovision_on_startupanddynamic_reprovisioningdomore clearly, especially their defaults.
Consistently document
always_reprovision_on_startupandauto_generated_ca_lifetime_daysin all config files.