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

[docs]: new dependency on nc.openbsd should be emphasized in the 24.3 release note #5809

Open
AkihiroSuda opened this issue Oct 10, 2024 · 2 comments
Labels
documentation This Pull Request changes documentation

Comments

@AkihiroSuda
Copy link

AkihiroSuda commented Oct 10, 2024

Documentation request

143bc9e#diff-eb94d50ed1a0a76032438b4bc5bccb389e9cc03d6766d7881463d8ee75f21f8fR25 introduced the dependency on nc.openbsd, but this binary is missing by default on several distros such as ArchLinux (https://gitlab.archlinux.org/archlinux/packaging/packages/cloud-init/-/issues/3).

This is a huge breaking change and should be emphasized in the 24.3 release note.

@AkihiroSuda AkihiroSuda added documentation This Pull Request changes documentation new An issue that still needs triage labels Oct 10, 2024
@TheRealFalcon TheRealFalcon removed the new An issue that still needs triage label Oct 10, 2024
@TheRealFalcon
Copy link
Member

Thanks @AkihiroSuda , we'll update the docs noting this along with python-based solution for those that don't have netcat.

@dvzrv
Copy link

dvzrv commented Oct 27, 2024

Maintaining cloud-init for Arch Linux, I have also found the documentation for the 24.3 release to be lacking (also see #5489 (comment)).
This led to a broken cloud-init package, but also a broken installation medium for the distribution.

It would be great to circumvent these types of issues in the future by clearly stating what is the exact breaking change. 🙏
Also, relying on openbsd-netcat should be re-evaluated, if it can indeed just be replaced by a simple Python script (see #5489 (comment)).
The new dependency comes with issues for some downstreams (such as Arch Linux) and is not really a super well-maintained upstream in my eyes.

To be more specific:
While we do have openbsd-netcat, its feature-set is in part depending on Debian patches (which probably could now be considered "the" upstream) and is not compatible with gnu-netcat.
Arch Linux does not have an alternatives system, so openbsd-netcat and gnu-netcat can not be installed side-by-side.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This Pull Request changes documentation
Projects
None yet
Development

No branches or pull requests

3 participants