Update auto docs; add dhcp boot modes doc #226
Merged
Conversation
This file contains hidden or 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
Signed-off-by: Jacob Weinstock <[email protected]>
The auto modes generally require more than just themselves. This updates the docs to make that known. Signed-off-by: Jacob Weinstock <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #226 +/- ##
==========================================
- Coverage 46.77% 46.69% -0.09%
==========================================
Files 101 101
Lines 8553 8553
==========================================
- Hits 4001 3994 -7
- Misses 4303 4308 +5
- Partials 249 251 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: Jacob Weinstock <[email protected]>
Signed-off-by: Jacob Weinstock <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR updates and adds documentation related to DHCP boot modes and auto enrolment/discovery features for Tinkerbell. Key changes include:
- The addition of a new document (DHCP_BOOT_MODES.md) outlining various DHCP boot modes.
- Updates to AUTO_ENROLLMENT.md to include a note regarding the required DHCP mode.
- Updates to AUTO_DISCOVERY.md to reference the updated Auto Enrollment documentation.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/technical/DHCP_BOOT_MODES.md | New documentation added for different DHCP boot modes. |
| docs/technical/AUTO_ENROLLMENT.md | Added a note clarifying the required DHCP mode for Auto Enrollment. |
| docs/technical/AUTO_DISCOVERY.md | Added a note linking to Auto Enrollment documentation for clarity. |
Comments suppressed due to low confidence (3)
docs/technical/DHCP_BOOT_MODES.md:46
- Consider adding a summary table that outlines the differences and key configuration flags for each DHCP boot mode to improve quick reference for users.
When a DHCP server exists on the network, Tinkerbell should be set to run `proxy` or `auto-proxy` mode. This will allow Tinkerbell to provide the next boot information to clients that request it and the existing DHCP server will provide IP address information. Layer 2 access to machines or a DHCP relay agent that will forward the DHCP requests to Tinkerbell is required.
docs/technical/AUTO_ENROLLMENT.md:21
- [nitpick] For consistency across documentation files, consider reviewing the note styling and formatting to align with similar notes in other documents.
> As Auto Enrollment requires the Tink Agent to connect to the Tink Server and the expectation is that no Hardware object exists, it is generally required that the `--dhcp-mode` CLI flag or the `TINKERBELL_DHCP_MODE` environment variable be set to `auto-proxy`.
docs/technical/AUTO_DISCOVERY.md:18
- Ensure that the reference to Auto Enrollment is correct and up-to-date, and consider checking that formatting remains consistent with the rest of the documentation.
> As Auto Discovery requires the Tink Agent to connect to the Tink Server and the expectation is that no Hardware object exists, it is generally required that Auto Enrollment be enabled.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Update and add docs.
Why is this needed
Fixes: #
How Has This Been Tested?
How are existing users impacted? What migration steps/scripts do we need?
Checklist:
I have: