Add vm live migration monitoring doc #857
Conversation
brandboat
requested review from
ihcsim and
w13915984028
and removed request for
akashraj4261
| @@ -74,6 +74,16 @@ Live migration will be aborted if it exceeds the completion timeout of 800s per | |||
|
|
|||
| Live migration will also be aborted when copying memory doesn't make any progress in 150s. | |||
|
|
|||
| ## Monitoring | |||
There was a problem hiding this comment.
An alternative solution is to add a new section like "vm-migration-metrics" aside from https://docs.harvesterhci.io/v1.4/monitoring/harvester-monitoring#vm-detail-metrics with a few pictures; and link to it from live-migration.md. thanks.
There was a problem hiding this comment.
Not a bad idea to have this in the monitoring page. However, I do want it to be more visible because live migration is a critical use case. How about:
- Move this content to a new section named "Live Migration Status And Metrics" in the "Monitoring" page
- Add a href from this section to the monitoring page
Re: screenshots/pictures, we discussed during team meeting to avoid them as they eventually become outdated and misleading. It's better to just described the navigation and action steps in bullet forms. cc @jillian-maroket
There was a problem hiding this comment.
Agree. Here is the suggested text for this section:
For information about viewing real-time metrics, see [Live Migration Status and Metrics](%LINK%).
There was a problem hiding this comment.
screenshots/pictures, we discussed during team meeting to avoid them as they eventually become outdated and misleading. It's better to just described the navigation and action steps in bullet forms.
The picture is I suggested @brandboat to add, it is quite straightforward: when a user looks to the section, there is no actual output of the observibility, what user can do is to spin up a cluster with at lest 2-nodes to test and see what's the output. A picture will save a lot of time for them.
As translated by ChatGPT: A picture is worth a thousand words.
as they eventually become outdated and misleading
Sorry I can't join the team meeting and I did not get the point.
Harvester document has a list of branches and the document is updated continuously, when some information is changed/outdated, update the doc accordingly. I did not see it as a reason that we should not put pictures here.
thanks.
There was a problem hiding this comment.
Is there anything unclear in this PR that requires screenshots? Is the navigation or page layout very different from the rest of the UI that require screenshots to help the reader to achieve their goals?
What I heard during the team meeting was that the screenshots are a maintenance burden for others.
Looking at Rancher, K3s, LH and Kubernetes monitoring documentation, the only pictorial illustration is one architecture diagram in one of the LH monitoring sub-pages. Generally, diagrams are used either for architecture documentation to explain complex concepts or "getting started" documentation for beginners, not for task-based documentation.
|
docs/vm/live-migration.md
Outdated
| @@ -74,6 +74,18 @@ Live migration will be aborted if it exceeds the completion timeout of 800s per | |||
|
|
|||
| Live migration will also be aborted when copying memory doesn't make any progress in 150s. | |||
|
|
|||
| ## Monitoring | |||
|
|
|||
| Live migration is a critical use case for ensuring workload uptime. Harvester exposes critical data and metrics to provide insights into the progress of the live migration operation via the [rancher-monitoring](../monitoring/harvester-monitoring.md) add-on. With the add-on enabled, real time metrics can be observed in the virtual machine "Migration" page. | |||
There was a problem hiding this comment.
| Live migration is a critical use case for ensuring workload uptime. Harvester exposes critical data and metrics to provide insights into the progress of the live migration operation via the [rancher-monitoring](../monitoring/harvester-monitoring.md) add-on. With the add-on enabled, real time metrics can be observed in the virtual machine "Migration" page. | |
| ## Live Migration Status and Metrics | |
| Live migration is a critical feature for ensuring workload uptime. The Harvester UI displays key data and metrics regarding the progress of the live migration operation via the [rancher-monitoring](../monitoring/harvester-monitoring.md) add-on. When the add-on is enabled, you can view real-time metrics on the **Migration** tab of the virtual machine details screen. |
There was a problem hiding this comment.
I added a heading assuming that this will be moved to the "Monitoring" page.
There was a problem hiding this comment.
I modified the suggestion and updated the rancher-monitoring link to ../advanced/addons.md, since the original one pointed back to the same page.
docs/vm/live-migration.md
Outdated
| To view the live migration status and metrics in the Harvester UI: | ||
|
|
||
| 1. Enable the **rancher-monitoring** add-on. | ||
| 1. Go to the **Virtual Machine** page. | ||
| 1. Go to the **Migration** page. |
There was a problem hiding this comment.
| To view the live migration status and metrics in the Harvester UI: | |
| 1. Enable the **rancher-monitoring** add-on. | |
| 1. Go to the **Virtual Machine** page. | |
| 1. Go to the **Migration** page. | |
| 1. Enable the **rancher-monitoring** add-on. | |
| 1. Go to **Virtual Machines**. | |
| 1. Locate the virtual machine in the list, and then click the name to view its details. | |
| 1. Go to the **Migration** tab. |
| @@ -74,6 +74,16 @@ Live migration will be aborted if it exceeds the completion timeout of 800s per | |||
|
|
|||
| Live migration will also be aborted when copying memory doesn't make any progress in 150s. | |||
|
|
|||
| ## Monitoring | |||
There was a problem hiding this comment.
Agree. Here is the suggested text for this section:
For information about viewing real-time metrics, see [Live Migration Status and Metrics](%LINK%).
Signed-off-by: Cooper Tseng <[email protected]>
see #855 (comment) and #855 (comment)