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

Include documentation for incus-agent installation on VMs #1055

Closed
victoitor opened this issue Jul 28, 2024 · 6 comments
Closed

Include documentation for incus-agent installation on VMs #1055

victoitor opened this issue Jul 28, 2024 · 6 comments
Labels
Documentation Documentation needs updating Easy Good for new contributors
Milestone

Comments

@victoitor
Copy link

Currently, I don't think the documentation has any information on how to install the incus-agent on VMs which were not obtained through the image server. Such documentation can be found on the forum, but it should be usual enough to have it included in the official docs.

@victoitor
Copy link
Author

Btw, I mention something like this:

mount -t 9p config /mnt
cd /mnt
./install.sh

@stgraber stgraber added Documentation Documentation needs updating Easy Good for new contributors labels Jul 29, 2024
@stgraber stgraber added this to the incus-6.4 milestone Jul 29, 2024
@simos
Copy link
Contributor

simos commented Jul 31, 2024

In which location in the doc/ should that information get added?

@victoitor
Copy link
Author

victoitor commented Jul 31, 2024

This is a great question, but not one I have an answer to. I would guess some place inside the instances tab.
To contribute to this discussion, I searched for places in which the incus-agent is mentioned and I found the following links.

It is also mentioned on the following link, but I'm not sure it's related to learning how to install it: https://linuxcontainers.org/incus/docs/main/cloud-init/#cloud-init-and-virtual-machines

Maybe it would make sense on a new submenu inside the instances menu and it should be linked from those places I provided.

@simos
Copy link
Contributor

simos commented Jul 31, 2024

There are four types of documentation, and two of them are howto and explanation.

Most likely this should be a howto document, which means it would have a title like How to enable manually the incus-agent in a VM.

An explanation document would explain the background with incus-agent, why it's needed, how it is provided automatically in the most common cases, and why you need to setup manually in some specific cases.

@stgraber
Copy link
Member

stgraber commented Aug 1, 2024

@simos I'd add it to the instances_create howto as it already covers creating instances from ISO images and manually adding the agent is the logical follow-up step to that.

@simos
Copy link
Contributor

simos commented Aug 1, 2024

I have added the text here, #1067

@stgraber stgraber closed this as completed Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation needs updating Easy Good for new contributors
Development

No branches or pull requests

3 participants