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

DOC: move OS prereqs out of "advanced configuration" #8805

Closed
mcg1969 opened this issue Nov 9, 2023 · 2 comments
Closed

DOC: move OS prereqs out of "advanced configuration" #8805

mcg1969 opened this issue Nov 9, 2023 · 2 comments

Comments

@mcg1969
Copy link

mcg1969 commented Nov 9, 2023

Thank you for the great work, and in advance for your consideration!

Environmental Info:
K3s Version:

k3s version v1.28.3+k3s1 (49411e70)
go version go1.20.10

Node(s) CPU architecture, OS, and Version:

Linux mgrant.sb.anacondaconnect.com 4.18.0-477.27.1.el8_8.x86_64 #1 SMP Thu Aug 31 10:29:22 EDT 2023 x86_64 x86_64 x86_64 GNU/Linux

Describe the bug:
As the documentation says, nm-cloud-setup must be disabled for installation to proceed. I didn't see this, and therefore struggled to understand why the service would not start. I inspected the startup commands, and found the reference to nm-cloud-setup, and that led me to the conclusion it should be deleted.

"Well, problem solved, RTFM, right?" Indeed. And yet. I would like to suggest that installation prerequisites should not go into a section called Advanced Options / Configuration. I was just trying to do some quick and dirty testing, with nothing "advanced" on my mind! It would therefore not occur to me to read anything in a section with Advanced in the title. There is nothing to suggest I'd need to do this in the Quick Start Guide, nor in the Requirements section.

I would like to suggest the following:

  • A blurb that links to Requirements at the top of the Quick Start Guide. No matter how quick you want to be, you need to meet the requirements, right?
  • A clear callout in said Requirements to common OS-specific requirements such as this. Perhaps is entire section should be moved out of Advanced Options / Configuration and into Requirements.
  • I'd consider copying the nm-cloud-setup check in the systemctl script into the get.k3s.io install script as well, perhaps along with checks for ufw and firewalld.

EDIT: Oh, one more add: I discovered the SELinux enforcement with the default k3s-selinux ruleset is not compatible with local-path-provisoner; that should probably be called out as well. See here: rancher/local-path-provisioner#362

Thank you again!

@mcg1969
Copy link
Author

mcg1969 commented Nov 9, 2023

I'm not above doing this work myself, mind you—if I get some down time I'll consider doing a doc PR.

@mcg1969
Copy link
Author

mcg1969 commented Nov 10, 2023

Closing in favor of k3s-io/docs#195

@mcg1969 mcg1969 closed this as completed Nov 10, 2023
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

No branches or pull requests

1 participant