Skip to content

Add netlab-ui tool documentation and configuration files - #3913

Draft
Muddyblack wants to merge 1 commit into
ipspace:devfrom
Muddyblack:netlabui-tool
Draft

Muddyblack wants to merge 1 commit into
ipspace:devfrom
Muddyblack:netlabui-tool

Conversation

@Muddyblack

Copy link
Copy Markdown
Collaborator

the newer version is not yet out or finished but I wanted to init this PR already.

@ipspace

ipspace commented Oct 1, 2026

Copy link
Copy Markdown
Owner

Waiting for @Muddyblack to publish his container

@ipspace ipspace added the blocked Use on a PR that is blocked by another PR waiting to be merged label Oct 1, 2026
@ipspace

ipspace commented Oct 23, 2026

Copy link
Copy Markdown
Owner

@Muddyblack -- How is this one coming along? I would love to replace Graphite tool with something better ;)

@Muddyblack

Copy link
Copy Markdown
Collaborator Author

Yeah I wanted at some point to first get it to work that you could add a new lab to a running lab. But I should do a release as its uncertain if its even really doable :D

I will add one new thing this weekend test it out a bit and then I will ping you soon :) So that bug hunting could begin :D

@Muddyblack

Copy link
Copy Markdown
Collaborator Author

argh I think I will separate the backed as own item. So it could also be used as vscode extension lets see.

I also saw clab-app has advanced a lot but I guess that part I will do later as there is no new clab-ui version 😅

For the UI, netlab runs containerlab always via sudo, so users will need to belong to a group configured to run clab without a sudo password right now.
Else I would have to ask sudo pw via the gui feels awkward.

@ipspace

ipspace commented Oct 25, 2026

Copy link
Copy Markdown
Owner

For the UI, netlab runs containerlab always via sudo, so users will need to belong to a group configured to run clab without a sudo password right now.

netlab uses sudoless containerlab since release 26.08: https://netlab.tools/release/26.08/#release-26-08

The only exception is the Podman runtime, where we have to enforce the root user; otherwise, the netlab utilities wouldn't see the containers started by containerlab.

@Muddyblack

Copy link
Copy Markdown
Collaborator Author

to be honest that sudo annoyed from day one I started using netlab :D good its gone

SO I will need to get the newest version ups and sorry I got sick and I also have just limited time ^^

@Muddyblack

Copy link
Copy Markdown
Collaborator Author

okay lets try it version 0.0.3 should work I tested it via nixos and ubuntu for now.

It also exists as pypi package so you could also just do pipx install netlab-ui

@Muddyblack
Muddyblack requested a review from ipspace November 2, 2026 13:52
@ipspace

ipspace commented Nov 3, 2026

Copy link
Copy Markdown
Owner

It doesn't work for me. I use a scratch directory for GH pull requests and set up the paths to point there (PATH and PYTHONPATH). First, the container complained about the wrong netlab version (it obviously tried to load the installed package), then I upgraded that package, got the UI up and running, could see the lab, but could not do anything.

Yeah, I know this is a totally useless description on par with "the network doesn't work", so please tell me what you need to figure this out.

Next, you should test the setup over an SSH session. netlab assumes the tools will be reachable over the IP address of the SSH endpoint and puts that IP address into sys.ipurl, so the URL that's printed does not work.

Anyway, looking at https://github.com/Muddyblack/netlab-ui, it seems to me we got the hierarchy wrong. Your tool should be the primary tool the user would install, and it should be used to install and control netlab. Am I missing something?

@Muddyblack

Copy link
Copy Markdown
Collaborator Author

Mh I thought It is nice that a user can use an already existing netlab so it doesn't waste space on the pc having it double and all uses the version you would expect it to use when using the cli.

Or did you expect to be shipped with?

But I can maybe do it better in asking the user to install it on its own if nothing was found? Or the user can directly point to whee he has his own installation.
I will make this part better.

What did not work starting a lab clicking any button? You did press the unlock button right?:
image

@Muddyblack

Copy link
Copy Markdown
Collaborator Author

for the not able to do anything. any lab thats not in workspace currently only opens as read only. ahm I dont like that I will change that currently ~/labs is the default workspace so sth in there should work for you.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blocked Use on a PR that is blocked by another PR waiting to be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants