Skip to content

Commit

Permalink
Adding DMT command reference content to 5.3 (#968)
Browse files Browse the repository at this point in the history
  • Loading branch information
Serdaro authored Jan 24, 2024
1 parent 2ad651b commit 926ca25
Show file tree
Hide file tree
Showing 2 changed files with 93 additions and 0 deletions.
92 changes: 92 additions & 0 deletions docs/modules/migrate/pages/dmt-command-reference.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
= DMT Command Reference

The DMT commands allow you to manage your migration.

The DMT commands have the following format:

[source,bash]
----
dmt [command] [flags]
----

== Commands

* <<dmt start, dmt start>>
* <<dmt status, dmt status>>
* <<dmt cancel, dmt cancel>>
* <<dmt estimate, dmt estimate>>

== dmt start

Starts a new migration with the specified configuration.

Usage:

[source,bash]
----
dmt start [dmt-config-path] [flags]
----

Parameters:

[cols="1m,1a,2a,1a"]
|===
|Parameter|Required|Description|Default

|`--output-dir`, `-o`
|Optional
|Output directory for the migration report.
|Current working directory

|`--yes`
|Optional
|If set, the migration starts immediately, without any confirmation.
|`false`

|===

== dmt status

Displays the status of the currently running migration.

Usage:

[source,bash]
----
dmt status [flags]
----

Parameters:

[cols="1m,1a,2a,1a"]
|===
|Parameter|Required|Description|Default

|`--output-dir`, `-o`
|Optional
|Output directory for the migration report.
|Current working directory

|===

== dmt cancel

Cancels the migration.

Usage:

[source,bash]
----
dmt cancel
----

== dmt estimate

Estimates the duration of the migration using the specified configuration.

Usage:

[source,bash]
----
dmt estimate [dmt-config-path]
----
1 change: 1 addition & 0 deletions docs/modules/migrate/partials/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
** xref:deploy:versioning-compatibility.adoc[Versioning and Compatibility]
** xref:migrate:data-migration-tool.adoc[]
*** xref:migrate:dmt-command-reference.adoc[]
** xref:migrate:migration-tool-imdg.adoc[]
** xref:migrate:upgrading-from-jet.adoc[]
** xref:migrate:upgrading-from-imdg-4.adoc[]
Expand Down

0 comments on commit 926ca25

Please sign in to comment.