snapctl doesn't advertise that it's an internal tool

Bug #1781789 reported by ellie
12
This bug affects 3 people
Affects Status Importance Assigned to Milestone
snapd
Confirmed
Medium
Unassigned

Bug Description

I am suggesting the snapctl package should advertise in some obvious way, when attempting to be used, that it's an internal tool.

Why:

When I searched the web tryingto find out how to start a snap package, I ended up on some snapcraft.io forum post that led me to snapctl. I tried to use snapctl start and was frustrated at the lack of documentation, not realizing it's an internal tool and that I should have used snap start instead.

(Historic note: this ticket description was updated, previously I confusedly complained I couldn't get snapctl to work)

Revision history for this message
Oliver Grawert (ogra) wrote :

the snapctl command is excluselive for internal use inside snap hooks in context of packaging.
for interaction from shell you need to use the snap command.
the documentation is correct here, snapctl should be covered in the packaging documentation though.

Changed in snappy:
status: New → Invalid
Revision history for this message
ellie (et1234567) wrote :

Ah, there is also "snap start kubelet" which I was supposed to use. My bad.

Revision history for this message
ellie (et1234567) wrote :

I wonder, would it help maybe to make snapctl announce more obviously that it's an internal tool, for people stumbling as clumsily through the snap universe as me? :-D unless that's super obvious to all other beginners that just try to launch a service

Revision history for this message
Oliver Grawert (ogra) wrote :

yeah, that would probably make sense, feel free to adjust bug title and summary accordingly and re-open :)

ellie (et1234567)
summary: - The main docs https://docs.snapcraft.io/core/ don't mention snapctl
+ snapctl doesn't advertise that it's an internal tool
Revision history for this message
ellie (et1234567) wrote :

Ok, I updated the ticket in hopefully a useful way!

description: updated
description: updated
Changed in snappy:
status: Invalid → New
Revision history for this message
Paweł Stołowski (stolowski) wrote :

I think that is a sensible suggestion, thanks for pointing this out.

no longer affects: snappy
Changed in snapd:
importance: Undecided → Medium
status: New → Confirmed
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.