docs: add instructions for connecting edge host to wifi #2092
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
✅ Deploy Preview for docs-spectrocloud ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
lennessyy
requested review from
karl-cardenas-coding,
addetz and
caroldelwing
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
docs/docs-content/clusters/edge/site-deployment/site-installation/site-user-data.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/edge/site-deployment/site-installation/site-user-data.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/edge/site-deployment/site-installation/site-user-data.md
Show resolved
Hide resolved
karl-cardenas-coding
approved these changes
Jan 24, 2024
There was a problem hiding this comment.
Neat guide @lennessyy I left you some minor comments suggestions.
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
caroldelwing
approved these changes
Jan 24, 2024
| @@ -0,0 +1,139 @@ | |||
| --- | |||
| sidebar_label: "Connect Intel NUC Edge Host to Wifi" | |||
There was a problem hiding this comment.
Suggested change
| sidebar_label: "Connect Intel NUC Edge Host to Wifi" | |
| sidebar_label: "Connect Intel NUC Edge Host to Wi-Fi" |
Wifi or Wi-Fi?
| --- | ||
|
|
||
| This how-to walks you through how to connect an Edge host to a Wi-Fi network with | ||
| [wpa_supplicant](https://wiki.archlinux.org/title/wpa_supplicant), using Intel NUCs as an example. An Intel NUC is a |
There was a problem hiding this comment.
Is it valid to add the NUC (Next Unit of Computing) definition?
| This how-to walks you through how to connect an Edge host to a Wi-Fi network with | ||
| [wpa_supplicant](https://wiki.archlinux.org/title/wpa_supplicant), using Intel NUCs as an example. An Intel NUC is a | ||
| mini PC that can be used as an Edge host for Palette Edge. You can apply the steps in this how-to with other hardware, | ||
| but steps for configuring the network interface might be be different. |
There was a problem hiding this comment.
Suggested change
| but steps for configuring the network interface might be be different. | |
| but the steps for configuring the network interface might be different. |
| To connect an Edge host to Wi-Fi using `wpa_supplicant`, you need to build `wpa_supplicant` into the OS image used for | ||
| the Edge host and provide the Wi-Fi credentials to the Edge host. Depending on how Edge devices are managed at an | ||
| organization, these two steps are often done by different teams. If they are being done by the same team or person, you | ||
| can merge the user-data in the step [Supply Site-Specific User Data](#supply-site-specific-user-data) with the original |
There was a problem hiding this comment.
Suggested change
| can merge the user-data in the step [Supply Site-Specific User Data](#supply-site-specific-user-data) with the original | |
| can merge the user data in the step [Supply Site-Specific User Data](#supply-site-specific-user-data) with the original |
| but steps for configuring the network interface might be be different. | ||
|
|
||
| To connect an Edge host to Wi-Fi using `wpa_supplicant`, you need to build `wpa_supplicant` into the OS image used for | ||
| the Edge host and provide the Wi-Fi credentials to the Edge host. Depending on how Edge devices are managed at an |
There was a problem hiding this comment.
Suggested change
| the Edge host and provide the Wi-Fi credentials to the Edge host. Depending on how Edge devices are managed at an | |
| the Edge host and provide the Wi-Fi credentials to the Edge host. Depending on how Edge devices are managed in an |
| ### Procedure | ||
|
|
||
| 1. Create a file named `user-data`, and include the following content. Replace `network-name` and `network-password` | ||
| with the name and password of your Wifi network. |
There was a problem hiding this comment.
Suggested change
| with the name and password of your Wifi network. | |
| with the name and password of your Wi-Fi network. |
|
|
||
| ### Validate | ||
|
|
||
| 1. Power up the Edge host and wait for it to boot to the registration screen. Do not connect the Edge host with a wired |
There was a problem hiding this comment.
Maybe a call out box for Do not connect the Edge host with a wired?
docs/docs-content/clusters/edge/site-deployment/site-installation/site-user-data.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/edge/site-deployment/site-installation/site-user-data.md
Outdated
Show resolved
Hide resolved
Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>
lennessyy
added
auto-backport
| :::tip | ||
|
|
||
| Consider including some other lightweight network utilities in the OS image that can help you troubleshoot or set up | ||
| network configurations alternatively if needed. For example, if you are using Ubuntu, consider replacing the RUN |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud.ableism] Avoid using ableism terms. Use 'issue' instead of 'RUN'.
💔 All backports failed
Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation and see the Github Action logs for details |
Merged
|
🎉 This PR is included in version 4.2.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 4.2.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
1 task
2 tasks
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.
Describe the Change
This PR adds instructions on how to connect an Intel NUC edge host to Wifi.
Review Changes
💻 Connect to Wifi
🎫 Jira Ticket