Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to install nmc or nmstatectl #411

Merged

Conversation

anmazzotti
Copy link
Contributor

This should add a bit of clarity regarding nmc or nmstatectl installation on images, reinforcing the fact that these tools are not included out of the box in Elemental.

@anmazzotti anmazzotti requested a review from a team as a code owner October 8, 2024 09:32
@anmazzotti anmazzotti self-assigned this Oct 8, 2024
Copy link

netlify bot commented Oct 8, 2024

Deploy Preview for elemental-docs-staging ready!

Name Link
🔨 Latest commit 540dd3d
🔍 Latest deploy log https://app.netlify.com/sites/elemental-docs-staging/deploys/670536f51aea8700089c067e
😎 Deploy Preview https://deploy-preview-411--elemental-docs-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@fgiudici fgiudici left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

docs/networking.md Outdated Show resolved Hide resolved
@@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

anmazzotti and others added 3 commits October 8, 2024 15:43
Co-authored-by: Francesco Giudici <[email protected]>
Signed-off-by: Andrea Mazzotti <[email protected]>
@anmazzotti anmazzotti force-pushed the clarify_nmstate_and_nmc_installation branch from 9d59705 to 540dd3d Compare October 8, 2024 13:43
@anmazzotti anmazzotti merged commit 48df9ce into rancher:main Oct 8, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants