Skip to content
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.

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

MTV-1433: Minor changes to migration from CLI section #589

Merged
merged 1 commit into from
Feb 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 13 additions & 14 deletions documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ include::modules/openstack-prerequisites.adoc[leveloffset=+2]
* Token authentication
* Application credential authentication

You can use these methods to migrate virtual machines with {osp} source providers using the CLI the same way you migrate other virtual machines, except for how you prepare the `Secret` manifest.
You can use these methods to migrate virtual machines with {osp} source providers using the command-line interface (CLI) the same way you migrate other virtual machines, except for how you prepare the `Secret` manifest.

:!mtv:
:context: ostack
Expand All @@ -91,7 +91,7 @@ include::modules/compatibility-guidelines.adoc[leveloffset=+2]
[id="installing-the-operator_{context}"]
== Installing and configuring the {operator-name}

You can install the {operator-name} by using the {ocp} web console or the command line interface (CLI).
You can install the {operator-name} by using the {ocp} web console or the command-line interface (CLI).

In {project-first} version 2.4 and later, the {operator-name} includes the {project-short} plugin for the {ocp} web console.

Expand Down Expand Up @@ -243,21 +243,18 @@ You can migrate virtual machines to {virt} from the command line.
You must ensure that all xref:prerequisites_{context}[prerequisites] are met.
====

include::modules/snip_plan-limits.adoc[]

:mtv!:
:context: cli
include::modules/non-admin-permissions-for-ui.adoc[leveloffset=+2]
include::modules/snip_vmware-permissions.adoc[]
:cli!:
:context: mtv

include::modules/retrieving-vmware-moref.adoc[leveloffset=+2]


[id="migrating-virtual-machines_{context}"]
=== Migrating virtual machines

You migrate virtual machines (VMs) from the command line (CLI) by creating {project-short} custom resources (CRs). The CRs and the migration procedure vary by source provider.
You migrate virtual machines (VMs) using the command-line interface (CLI) by creating {project-short} custom resources (CRs). The CRs and the migration procedure vary by source provider.

[IMPORTANT]
====
Expand All @@ -272,34 +269,36 @@ To migrate to or from an {ocp-short} cluster that is different from the one the
:mtv!:
:context: vmware
:vmware:

include::modules/new-migrating-virtual-machines-cli.adoc[leveloffset=+3]
// Do we want this snippet here?
include::modules/snip_vmware-permissions.adoc[]
include::modules/retrieving-vmware-moref.adoc[leveloffset=+4]
include::modules/canceling-migration-cli.adoc[leveloffset=+4]
:vmware!:
:context: rhv
:rhv:
include::modules/new-migrating-virtual-machines-cli.adoc[leveloffset=+3]
include::modules/canceling-migration-cli.adoc[leveloffset=+4]
:rhv!:
:context: ostack
:ostack:
include::modules/new-migrating-virtual-machines-cli.adoc[leveloffset=+3]
include::modules/canceling-migration-cli.adoc[leveloffset=+4]
:ostack!:
:context: ova
:ova:
//include::modules/new-migrating-virtual-machines-cli.adoc[leveloffset=+3]
//:ova!:
//:context: ostack
//:ostack:
include::modules/new-migrating-virtual-machines-cli.adoc[leveloffset=+3]
include::modules/canceling-migration-cli.adoc[leveloffset=+4]
:ova!:
:context: cnv
:cnv:
include::modules/new-migrating-virtual-machines-cli.adoc[leveloffset=+3]
include::modules/canceling-migration-cli.adoc[leveloffset=+4]
:cnv!:
:context: mtv
:mtv:

include::modules/canceling-migration-cli.adoc[leveloffset=+2]

[id="advanced-migration-options_{context}"]
== Advanced migration options

Expand Down Expand Up @@ -331,7 +330,7 @@ include::modules/upgrading-mtv-ui.adoc[leveloffset=+1]
[id="uninstalling-mtv_{context}"]
== Uninstalling {the-lc} {project-full}

You can uninstall {the-lc} {project-first} by using the {ocp} web console or the command line interface (CLI).
You can uninstall {the-lc} {project-first} by using the {ocp} web console or the command-line interface (CLI).

include::modules/uninstalling-mtv-ui.adoc[leveloffset=+2]
include::modules/uninstalling-mtv-cli.adoc[leveloffset=+2]
Expand Down
4 changes: 2 additions & 2 deletions documentation/modules/accessing-logs-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

:_content-type: PROCEDURE
[id="accessing-logs-cli_{context}"]
= Accessing logs and custom resource information from the command line interface
= Accessing logs and custom resource information from the command line

You can access logs and information about custom resources (CRs) from the command line interface by using the `must-gather` tool. You must attach a `must-gather` data file to all customer cases.
You can access logs and information about custom resources (CRs) from the command line by using the `must-gather` tool. You must attach a `must-gather` data file to all customer cases.

You can gather data for a specific namespace, a completed, failed, or canceled migration plan, or a migrated virtual machine (VM) by using the filtering options.

Expand Down
2 changes: 1 addition & 1 deletion documentation/modules/accessing-logs-ui.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[id="accessing-logs-ui_{context}"]
= Downloading logs and custom resource information from the web console

You can download logs and information about custom resources (CRs) for a completed, failed, or canceled migration plan or for migrated virtual machines (VMs) by using the {ocp} web console.
You can download logs and information about custom resources (CRs) for a completed, failed, or canceled migration plan or for migrated virtual machines (VMs) from the {ocp} web console.

.Procedure

Expand Down
9 changes: 5 additions & 4 deletions documentation/modules/canceling-migration-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

:_content-type: PROCEDURE
[id="canceling-migration-cli_{context}"]
= Canceling a migration
= Canceling a migration from the command-line interface

You can cancel an entire migration or individual virtual machines (VMs) while a migration is in progress from the command line interface (CLI).
You can use the command-line interface (CLI) to cancel either an entire migration or the migration of specific virtual machines (VMs) while a migration is in progress.

.Canceling an entire migration

Expand All @@ -18,10 +18,11 @@ $ {oc} delete migration <migration> -n <namespace> <1>
----
<1> Specify the name of the `Migration` CR.

.Canceling the migration of individual VMs
.Canceling the migration of specific VMs

. Add the individual VMs to the `spec.cancel` block of the `Migration` manifest:
. Add the specific VMs to the `spec.cancel` block of the `Migration` manifest:
+
.Example YAML for canceling the migrations of two VMs
[source,yaml,subs="attributes+"]
----
$ cat << EOF | {oc} apply -f -
Expand Down
2 changes: 1 addition & 1 deletion documentation/modules/collected-logs-cr-info.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[id="collected-logs-cr-info_{context}"]
= Collected logs and custom resource information

You can download logs and custom resource (CR) `yaml` files for the following targets by using the {ocp} web console or the command line interface (CLI):
You can download logs and custom resource (CR) `yaml` files for the following targets by using the {ocp} web console or the command-line interface (CLI):

* Migration plan: Web console or CLI.
* Virtual machine: Web console or CLI.
Expand Down
4 changes: 2 additions & 2 deletions documentation/modules/installing-mtv-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ ifdef::web[]
You can install the {operator-name} by using the {ocp} web console.
endif::[]
ifdef::cli[]
= Installing the {operator-name} from the command line interface
= Installing the {operator-name} by using the command-line interface

You can install the {operator-name} from the command line interface (CLI).
You can install the {operator-name} by using the command-line interface (CLI).
endif::[]

.Prerequisites
Expand Down
Loading