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: Add paragraph on how to delete images #12711

Merged
merged 2 commits into from
Jan 18, 2024

Conversation

ggouzi
Copy link
Contributor

@ggouzi ggouzi commented Jan 8, 2024

Add a small section regarding image deletion. I did not find it elsewhere

@github-actions github-actions bot added the Documentation Documentation needs updating label Jan 8, 2024

lxc image delete <image_ID>

Deleting an image won't affect running instances that are already using it, but it will prevent you from launching new instances based on that image.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should also clarify here that "but it will prevent you from launching new instances based on that image." is only true for manually created images (i.e non-cached ones) and if instead a cached one is deleted it will simply be re-downloaded again on next use.

Signed-off-by: ggouzi <gaetan.gouzi@canonical.com>
@@ -67,6 +67,16 @@ To edit the full image properties, including the top-level properties, enter the

lxc image edit <image_ID>

## Delete an image
To delete an image on a server, enter the following command:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a little ambiguous - what is "a server"? This could be misunderstood as "a remote server", but you actually mean the local server.
So maybe leave it out (just "To delete an image, enter ...") or be specific that we talk about a local image ("To delete a local copy of an image, enter ...").

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, for consistency, can you add an empty line after the heading?

Signed-off-by: ggouzi <gaetan.gouzi@canonical.com>
Copy link
Contributor

@ru-fu ru-fu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@tomponline tomponline merged commit 8784acc into canonical:main Jan 18, 2024
26 checks passed
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation needs updating
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants