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

Remove jlmkr install command #176

Closed
Jip-Hop opened this issue May 17, 2024 · 2 comments
Closed

Remove jlmkr install command #176

Jip-Hop opened this issue May 17, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@Jip-Hop
Copy link
Owner

Jip-Hop commented May 17, 2024

Beginning with 24.04 (Dragonfish), TrueNAS SCALE includes the systemd-nspawn containerization program in the base system. Technically there's nothing to install.

Running jlmkr.py install currently automatically sets up an alias so the user can run jlmkr conveniently. But because this is done automatically, the user doesn't know what jailmaker is actually doing under the hood during install (actually very little). So the user can't easily undo/modify these actions, since the user didn't manually execute them. Creating an alias is really all there is to it since 24.04 (and even that could be considered optional)!

So to get rid of legacy code and prevent questions like this: #93 (reply in thread), #117 and #175.

I should remove jlmkr.py install. Update the documentation on how to manually create a shell alias for jlmkr and ask stux to create a new video (or add annotations to skip running install and instead manually create an alias).

Since removing a command would be a breaking change I'm planning this for the next major version.

Removing the install command would make this release of jailmaker incompatible with any (past and future) release which doesn't include systemd-nspawn.

Past releases which don't include systemd-nspawn:

  • 22.12.3.*
  • 22.12.4.* (needs confirmation)

#16

https://ixsystems.atlassian.net/browse/NAS-123533

Version 23.10 includes all dependencies as well (albeit implicitly). So removing the install command from v2.0.0 basically means dropping support for TrueNAS SCALE 22.12.

@Jip-Hop Jip-Hop added documentation Improvements or additions to documentation enhancement New feature or request labels May 17, 2024
@Jip-Hop Jip-Hop added this to the v2.0.0 milestone May 17, 2024
@Jip-Hop Jip-Hop self-assigned this May 17, 2024
@TheFou
Copy link

TheFou commented May 21, 2024

Hi!
Why make the "install" process more complicated (even this little) by removing this command ?
You should simplify it instead by adding a uninstall / remove command, which would remove the aliases.
And maybe bulletproof the install command a little more, so you can be sure it recreates the aliases if needed, to prevent issues you mention.

the user doesn't know what jailmaker is actually doing under the hood during install

The user shouldn't 😄

@Lockszmith-GH
Copy link
Contributor

I'm on the side of "The user should defintly know", otherwise they shouldn't use jails - stick to the GUI with VMs and Apps.

Setting up jails is an involved process, the user MUST understand networking and volume binds, not to mention permissions.

Personally, I don't want anything to touch my USER environment files, as they are highly customized.
So letting users know they need to know the full path, or add an alias in their .bashrc seems like a good step forward.

This isn't over-complicating it for the user, but it is simplifying the support process of those users.

@Jip-Hop Jip-Hop mentioned this issue May 28, 2024
@Jip-Hop Jip-Hop closed this as completed May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants