fix(docs): document qemu-guest-agent behavior #670
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Modify example to start with disabled guest agent. Signed-off-by: Oto Petřík <oto.petrik@gmail.com>
bpg
approved these changes
Oct 31, 2023
There was a problem hiding this comment.
Awesome as usual, @otopetrik, thanks for clarifying all of this!
| @@ -23,7 +23,8 @@ resource "proxmox_virtual_environment_vm" "ubuntu_vm" { | |||
| vm_id = 4321 | |||
|
|
|||
| agent { | |||
| enabled = true | |||
| # read 'Qemu guest agent' section, change to true only when ready | |||
Comment on lines
+521
to
+524
| "Monitor" tab in Proxmox GUI can be used to send low-level commands to `qemu`. | ||
| See the [documentation](https://www.qemu.org/docs/master/system/monitor.html). | ||
| Commands `system_powerdown` and `quit` have proven useful in shutting down VMs | ||
| with `agent.enabled = true` and no agent running. |
bpg
changed the title
ghost
mentioned this pull request
|
@all-contributors please add @otopetrik for documentation |
|
I've put up a pull request to add @otopetrik! 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Modify example to start with disabled guest agent.
Contributor's Note
/docsfor any user-facing features or additions./examplefor any new or updated resources / data sources.make exampleto verify that the change works as expected.Proof of Work
#669 and #449 show that
agent.enabled = truebehavior is not obvious and should be documented. It should not be the default in the example, but users are still expected to change it to true once they understand the details and configure everything correctly.Community Note
Closes #669 | Relates #0000