Document how to install nmc or nmstatectl #411
Merged
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 elemental-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
fgiudici
approved these changes
Oct 8, 2024
docs/networking.md
Outdated
| @@ -31,6 +31,39 @@ The [MachineRegistration](machineregistration-reference) supports Declarative Ne | |||
|
|
|||
| - (optionally) [nmstatectl](https://github.com/nmstate/nmstate/releases) can be used with `nmstate` network [configurator](#configurators). | |||
|
|
|||
| #### Installing nmc or nmstatectl on OS images | |||
|
|
|||
| When using the `nmc` or `nmstate` configurators, the [nmc](https://github.com/suse-edge/nm-configurator/releases) or [nmstatectl](https://github.com/nmstate/nmstate/releases) tool needs to be installed on the system. | |||
There was a problem hiding this comment.
Nit: not sure "system" will make immediately clear we refer to the host/OS image. We usually call "machine" the host on which elemental is installed. Wondering if could be worth to use "machine" or something other name that would make crystal clear that we are referring to the host and/or the OS image that we install on it. 🤔
Not a strong opinion btw, so feel free to just ignore.
Suggested change
| When using the `nmc` or `nmstate` configurators, the [nmc](https://github.com/suse-edge/nm-configurator/releases) or [nmstatectl](https://github.com/nmstate/nmstate/releases) tool needs to be installed on the system. | |
| When using the `nmc` or `nmstate` configurators, the [nmc](https://github.com/suse-edge/nm-configurator/releases) or [nmstatectl](https://github.com/nmstate/nmstate/releases) tool needs to be installed on the machine. |
Signed-off-by: Andrea Mazzotti <[email protected]>
Co-authored-by: Francesco Giudici <[email protected]>
Signed-off-by: Andrea Mazzotti <[email protected]>
anmazzotti
force-pushed
the
clarify_nmstate_and_nmc_installation
branch
from
9d59705
to
540dd3d
Compare
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.
This should add a bit of clarity regarding
nmcornmstatectlinstallation on images, reinforcing the fact that these tools are not included out of the box in Elemental.