Skip to content

Update documentation about dynamic SSH key injection #870

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update documentation about dynamic SSH key injection #870

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions docs/user_workloads/accessing_virtual_machines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,21 +161,24 @@ This allows for dynamic injection of SSH public keys at runtime by updating the

Please note that new Secrets cannot be attached to a running VM: You must restart the VM to attach the new Secret.

> Note: This requires the qemu-guest-agent to be installed within the guest.
>
> Note: When using qemuGuestAgent propagation,
> the `/home/$USER/.ssh/authorized_keys` file will be owned by the guest agent.
> **Requirement:** The qemu-guest-agent must be installed within the guest.
Copy link
Member

@aburdenthehand aburdenthehand Feb 14, 2025

Choose a reason for hiding this comment

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

These 4 different admonition types are unfortunately rendered indistinguishable grey here.
I suggest we break this into two headings and then use the admonition markdown. So I'd make this:

Suggested change
> **Requirement:** The qemu-guest-agent must be installed within the guest.
#### Requirements
The `qemu-guest-agent` must be installed within the guest.


> **Deprecation Notice:** The implementation supporting qemu-guest-agent versions older than 5.2 is deprecated
Copy link
Member

@aburdenthehand aburdenthehand Feb 14, 2025

Choose a reason for hiding this comment

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

Suggested change
> **Deprecation Notice:** The implementation supporting qemu-guest-agent versions older than 5.2 is deprecated
!!! note "Deprecation notice"
Support for `qemu-guest-agent` versions older than 5.2 is deprecated and will be removed in a future release.

https://squidfunk.github.io/mkdocs-material/reference/admonitions/#changing-the-title

> and will stop working in a future release.
Copy link
Contributor

@jcanocan jcanocan Feb 11, 2025

Choose a reason for hiding this comment

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

Suggested change
> and will stop working in a future release.
> and it will stop working in a future release.

Comment on lines +166 to +167
Copy link
Member

@0xFelix 0xFelix Feb 11, 2025

Choose a reason for hiding this comment

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

Suggested change
> **Deprecation Notice:** The implementation supporting qemu-guest-agent versions older than 5.2 is deprecated
> and will stop working in a future release.
> **Deprecation Notice:** Support for qemu-guest-agent versions older than 5.2 is deprecated
> and will be removed in a future release.


> **Important:** When using `qemuGuestAgent` propagation,
Copy link
Contributor

@jcanocan jcanocan Feb 11, 2025

Choose a reason for hiding this comment

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

Suggested change
> **Important:** When using `qemuGuestAgent` propagation,
> **Important:** When using `qemuGuestAgent` propagation method,

Copy link
Member

@aburdenthehand aburdenthehand Feb 14, 2025

Choose a reason for hiding this comment

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

Suggested change
> **Important:** When using `qemuGuestAgent` propagation,
!!! Important
When using `qemuGuestAgent` propagation method,

You'd need to replace the subsequent '>' characters and add the 4 spaces (as here) to keep it in the same admonition.
I think this also belongs above the 'requirements' heading in the opening text.

> the `/home/$USER/.ssh/authorized_keys` file is owned by the guest agent.
> Changes to the file not made by the guest agent will be lost.
>
> Note: More information about the motivation behind the access credentials API

> **Further Reading:** More information about the motivation behind the access credentials API
> can be found in the
> [pull request description](https://github.com/kubevirt/kubevirt/pull/4195)
> that introduced the API.
Comment on lines +173 to 176
Copy link
Member

@aburdenthehand aburdenthehand Feb 14, 2025

Choose a reason for hiding this comment

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

Suggested change
> **Further Reading:** More information about the motivation behind the access credentials API
> can be found in the
> [pull request description](https://github.com/kubevirt/kubevirt/pull/4195)
> that introduced the API.
For more information about the motivation behind the access credentials API,
see the [pull request description](https://github.com/kubevirt/kubevirt/pull/4195)
that introduced the API.

I would also move this above the requirements heading, and in to the opening text. (iiuc)


In the example below the `Secret` containing the SSH public key is
In the example below, the `Secret` containing the SSH public key is
Copy link
Member

@aburdenthehand aburdenthehand Feb 14, 2025

Choose a reason for hiding this comment

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

And then we can add an example heading here to distinguish it from the preceding section.

Suggested change
In the example below, the `Secret` containing the SSH public key is
#### Example: Dynamic SSH key injection in a Secret
In this example, the `Secret` containing the SSH public key is

attached to the virtual machine via the access credentials API with the
`qemuGuestAgent` propagation method. This allows updating the contents of
the `Secret` at any time, which will result in the changes getting applied
the `Secret` at any time, which will result in the changes being applied
to the running virtual machine immediately. The `Secret` may also contain
multiple SSH public keys.

Expand Down