Update documentation about dynamic SSH key injection #870

akrejcir · 2025-02-11T13:03:13Z

What this PR does / why we need it:

Added deprecation notice, that in a future release dynamic SSH key injection will stop working for older guest agents
Changed wording, so that there are not 4 Note:... blocks right next to each other.

Special notes for your reviewer:
This should be merged after the deprecation PR is merged: kubevirt/kubevirt#13881

Checklist

This checklist is not enforcing, but it's a reminder of items that could be relevant to every PR.
Approvers are expected to review this list.

Design: A design document was considered and is present (link) or not required
PR: The PR description is expressive enough and will help future contributors
Code: Write code that humans can understand and Keep it simple
Refactor: You have left the code cleaner than you found it (Boy Scout Rule)
Upgrade: Impact of this change on upgrade flows was considered and addressed if required
Testing: New code requires new unit tests. New features and bug fixes require at least on e2e test
Documentation: A user-guide update was considered and is present (link) or not required. You want a user-guide update if it's a user facing feature / API change.
Community: Announcement to kubevirt-dev was considered

Release note:

None

- Added deprecation notice, that in a future release dynamic SSH key injection will stop working for older guest agents - Changed wording, so that there are not 4 "Note:" blocks right next to each other. Signed-off-by: Andrej Krejcir <akrejcir@redhat.com>

akrejcir · 2025-02-11T13:03:31Z

/cc @0xFelix @jcanocan

dhiller

/approve

kubevirt-bot · 2025-02-11T13:18:06Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dhiller

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [dhiller]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

jcanocan · 2025-02-11T13:32:45Z

docs/user_workloads/accessing_virtual_machines.md

+> **Requirement:** 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
+> and will stop working in a future release.


Suggested change

> and will stop working in a future release.

> and it will stop working in a future release.

jcanocan · 2025-02-11T13:33:13Z

docs/user_workloads/accessing_virtual_machines.md

+> **Deprecation Notice:** The implementation supporting qemu-guest-agent versions older than 5.2 is deprecated
+> and will stop working in a future release.
+
+> **Important:** When using `qemuGuestAgent` propagation,


Suggested change

> **Important:** When using `qemuGuestAgent` propagation,

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

0xFelix · 2025-02-11T16:24:10Z

docs/user_workloads/accessing_virtual_machines.md

+> **Deprecation Notice:** The implementation supporting qemu-guest-agent versions older than 5.2 is deprecated
+> and will stop working in a future release.


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.

akrejcir · 2025-02-13T15:57:06Z

/hold

aburdenthehand

I think we can help to make this easier for the reader by breaking it up with headings, and then using the admonition markdown available through the Material theme.
I've tried to incorporate the other feedback as well.
Hopefully I understood the content and the suggestions make sense :)

aburdenthehand · 2025-02-14T17:58:37Z

docs/user_workloads/accessing_virtual_machines.md

->
-> 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.


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.

aburdenthehand · 2025-02-14T18:03:22Z

docs/user_workloads/accessing_virtual_machines.md

-> 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.
+
+> **Deprecation Notice:** The implementation supporting qemu-guest-agent versions older than 5.2 is deprecated


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

aburdenthehand · 2025-02-14T18:08:43Z

docs/user_workloads/accessing_virtual_machines.md

+> **Deprecation Notice:** The implementation supporting qemu-guest-agent versions older than 5.2 is deprecated
+> and will stop working in a future release.
+
+> **Important:** When using `qemuGuestAgent` propagation,


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.

aburdenthehand · 2025-02-14T18:10:27Z

docs/user_workloads/accessing_virtual_machines.md

+> **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.


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)

aburdenthehand · 2025-02-14T18:12:59Z

docs/user_workloads/accessing_virtual_machines.md

 > can be found in the
 > [pull request description](https://github.com/kubevirt/kubevirt/pull/4195)
 > that introduced the API.

-In the example below the `Secret` containing the SSH public key is
+In the example below, the `Secret` containing the SSH public key is


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

kubevirt-bot · 2025-05-15T18:29:48Z

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

akrejcir · 2025-06-05T13:32:14Z

/remove-lifecycle stale

kubevirt-bot requested a review from dhiller February 11, 2025 13:03

kubevirt-bot added the dco-signoff: yes Indicates the PR's author has DCO signed all their commits. label Feb 11, 2025

kubevirt-bot requested a review from jean-edouard February 11, 2025 13:03

kubevirt-bot added the size/S label Feb 11, 2025

kubevirt-bot requested review from 0xFelix and jcanocan February 11, 2025 13:03

dhiller reviewed Feb 11, 2025

View reviewed changes

kubevirt-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 11, 2025

jcanocan reviewed Feb 11, 2025

View reviewed changes

0xFelix reviewed Feb 11, 2025

View reviewed changes

kubevirt-bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 13, 2025

aburdenthehand reviewed Feb 14, 2025

View reviewed changes

kubevirt-bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 15, 2025

kubevirt-bot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 5, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update documentation about dynamic SSH key injection #870

Update documentation about dynamic SSH key injection #870

Uh oh!

akrejcir commented Feb 11, 2025

Uh oh!

akrejcir commented Feb 11, 2025

Uh oh!

dhiller left a comment

Uh oh!

kubevirt-bot commented Feb 11, 2025

Uh oh!

jcanocan Feb 11, 2025

Uh oh!

jcanocan Feb 11, 2025

Uh oh!

0xFelix Feb 11, 2025

Uh oh!

akrejcir commented Feb 13, 2025

Uh oh!

aburdenthehand left a comment

Uh oh!

aburdenthehand Feb 14, 2025

Uh oh!

aburdenthehand Feb 14, 2025

Uh oh!

aburdenthehand Feb 14, 2025

Uh oh!

aburdenthehand Feb 14, 2025

Uh oh!

aburdenthehand Feb 14, 2025

Uh oh!

kubevirt-bot commented May 15, 2025

Uh oh!

akrejcir commented Jun 5, 2025

Uh oh!

Uh oh!

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

	> Important: When using `qemuGuestAgent` propagation,
	> Important: When using `qemuGuestAgent` propagation method,

		> Deprecation Notice: The implementation supporting qemu-guest-agent versions older than 5.2 is deprecated
		> and will stop working in a future release.

	> 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
	!!! note "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,
	!!! Important
	When using `qemuGuestAgent` propagation method,

	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

Update documentation about dynamic SSH key injection #870

Are you sure you want to change the base?

Update documentation about dynamic SSH key injection #870

Uh oh!

Conversation

akrejcir commented Feb 11, 2025

Uh oh!

akrejcir commented Feb 11, 2025

Uh oh!

dhiller left a comment

Choose a reason for hiding this comment

Uh oh!

kubevirt-bot commented Feb 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

akrejcir commented Feb 13, 2025

Uh oh!

aburdenthehand left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kubevirt-bot commented May 15, 2025

Uh oh!

akrejcir commented Jun 5, 2025

Uh oh!

Uh oh!