From 7b682165b36b9fcff49c73bae3ccc65cbd9a9882 Mon Sep 17 00:00:00 2001 From: Hayato Kiwata <44946173+haytok@users.noreply.github.com> Date: Wed, 22 May 2024 02:45:44 +0900 Subject: [PATCH] docs: Add docs for finch vm settings command (#938) In my previous pull request, we added the functionality to change the number of CPUs and memory size allocated to VMs. - https://github.com/runfinch/finch/pull/887 However, at that time, we did not add documentations for the finch vm settings command. Therefore, in this fix, we will add documentations for the finch vm settings command. Issue #, if available: N/A *Description of changes:* Details are described in this commit message. *Testing done:* N/A - [x] I've reviewed the guidance in CONTRIBUTING.md #### License Acceptance By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. Signed-off-by: Hayato Kiwata --- docs/cmd/finch_vm_settings.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 docs/cmd/finch_vm_settings.md diff --git a/docs/cmd/finch_vm_settings.md b/docs/cmd/finch_vm_settings.md new file mode 100644 index 000000000..5746e8c8b --- /dev/null +++ b/docs/cmd/finch_vm_settings.md @@ -0,0 +1,15 @@ +# finch vm settings + +Configure the virtual machine instance + +```text + finch vm settings [flags] +``` + +## Options + +```text + --cpus int the amount of vCPU to dedicate to the virtual machine (restart the vm when applying this change.) + -h, --help help for settings + --memory string the amount of memory to dedicate to the virtual machine (restart the vm when applying this change.) +```