Sam/migration waves

_data/sidebars/main_sidebar.yml

@@ -104,10 +104,13 @@ entries:
       - title: Plan
         output: web
         folderitems:
-          - title: Getting Apps and Resources within your Move Group
+          - title: Migration Waves
+            output: web
+            url: /migration-waves.html
+          - title: Getting Apps and Resources within your Migration Wave
             output: web
             url: /get-all-move-groups.html
-          - title: Exporting Servers from Move Groups
+          - title: Exporting Servers from Migration Waves
             output: web
             url: /exporting-servers-to-csv.html
           - title: Integrating with Jira

pages/api/get_several.md

@@ -1,9 +1,9 @@
 ---
 toc: false
-title: Getting Apps and Resources within your Move Group
-keywords: databases, server, apps, movegroups
+title: Getting Apps and Resources within your Migration Wave
+keywords: databases, server, apps, migration, wave
 last_updated: Feb 22, 2018
-summary: "Get all your Move Groups and their associated Applications, Databases and Servers."
+summary: "Get all your Migration Waves and their associated Applications, Database Instances and Servers."
 sidebar: main_sidebar
 redirect_from: getallmovegroups.html
 permalink: get-all-move-groups.html
@@ -16,10 +16,10 @@ Once you have authenticated with the Tidal API, utilising each endpoint is super
 For any additional details regarding the endpoint, checkout the Tidal API documentation.
 (https://[your subdomain].tidal.cloud/docs/)
 
-## Getting all the Move Groups:
+## Getting all the Migration Waves:
 #### GET api/v1/move_groups {#getallmg}
 
-Returns a collection of all the move groups and its applications, database instances, and servers.
+Returns a collection of all the migration waves and its applications, database instances, and servers.
 
 ### Example Request
 
@@ -36,7 +36,7 @@ curl -X GET \
 ```
 ### Example Response
 
-You can access your Applications, Database Instances and Serves within all the move groups.
+You can access your Applications, Database Instances and Serves within all the migration waves.
 
 ```
 [
@@ -46,7 +46,7 @@ You can access your Applications, Database Instances and Serves within all the m
     "notes": "Here is a sample note. It **is** markdown friendly!",
     "created_at": "2018-02-22T05:13:25.591Z",
     "updated_at": "2018-02-22T05:13:25.591Z",
-    "name": "Move Group - Oct 25",
+    "name": "Migration Wave - Oct 25",
     "servers": [
         {
             "id": 23156,
@@ -129,7 +129,7 @@ You can access your Applications, Database Instances and Serves within all the m
         "notes": "Here is a sample note. It **is** markdown friendly!",
         "created_at": "2018-02-22T05:13:26.356Z",
         "updated_at": "2018-02-22T05:13:26.356Z",
-        "name": "Move Group - Nov 25",
+        "name": "Migration Wave - Nov 25",
         "servers": [
             {
                 "id": 23238,
@@ -193,19 +193,19 @@ You can access your Applications, Database Instances and Serves within all the m
 ]
 
 ```
-## Getting a *specific* Move Group:
+## Getting a *specific* Migration Wave:
 
 #### GET api/v1/move_groups/[id]
 
-Returns the selected move group and its applications, database instances, and servers.
+Returns the selected migration wave and its applications, database instances, and servers.
 
 ### Example Request
 
 You will need:
 
 1. Your subdomain -> Refer: [Get Subdomain](https://get.tidal.cloud/workspaces) & type in your email in the prompt bar. Afterwards, you will receive an email with all of your workspaces.
 2. Your access token -> Refer: [Authentication Guide](index.html).
-3. Your Move Group ID -> Refer to the [above request](#getallmg) to get your move group id.
+3. Your Migration Wave ID -> Refer to the [above request](#getallmg) to get your migration wave id.
 
 ```
 curl -X GET \
@@ -216,7 +216,7 @@ curl -X GET \
 
 ### Example Response
 
-You can access your Applications, Database Instances and Serves within the selected move group.
+You can access your Applications, Database Instances and Serves within the selected migration wave.
 
 ```
 
@@ -226,7 +226,7 @@ You can access your Applications, Database Instances and Serves within the selec
     "notes": "Here is a sample note. It **is** markdown friendly!",
     "created_at": "2018-02-22T05:13:25.591Z",
     "updated_at": "2018-02-22T05:13:25.591Z",
-    "name": "Move Group - Oct 25",
+    "name": "Migration Wave - Oct 25",
     "servers": [
         {
             "id": 23156,

pages/user guides/exporting_move_groups_to_csv.md

@@ -1,9 +1,9 @@
 ---
 toc: false
-title: Exporting servers from a Move Group to CSV
-keywords: move_groups, servers, csv, rivermeadow, export
+title: Exporting servers from a Migration Wave to CSV
+keywords:  servers, csv, rivermeadow, export, migration, wave
 last_updated: April 17, 2019
-summary: "Exporting servers from a move group to a format that can be used by RiverMeadow."
+summary: "Exporting servers from a migration wave to a format that can be used by RiverMeadow."
 sidebar: main_sidebar
 folder: userguides
 permalink: exporting-servers-to-csv.html
@@ -18,7 +18,7 @@ This guides assumes you have access to a Linux like environment, you will need:
 -   Posix compliant shell
 -   [Curl](https://curl.haxx.se/download.html)
 -   [jq](https://stedolan.github.io/jq/)
--   [A copy of the move group script](https://github.com/tidalmigrations/gists/blob/master/move_group_to_csv.sh)
+-   [A copy of the migration wave script](https://github.com/tidalmigrations/gists/blob/master/migration_wave_to_csv.sh)
 
 
 # Steps
@@ -38,21 +38,21 @@ Once you have gathered this information, you'll need set it as an environment va
     export subdomain="<your subdomain>"
 ```
 
-## 2. Gather Move Group ID
+## 2. Find Migration Wave ID
 
-To find the ID of the move group that you'd like to export, log in to the Tidal Accelerator Platform and from the `Projects` view, select the project that your move group is associated with. In the `Project` view, go to `Migration Waves` tab. You should see a list of move groups that are associated with the selected project. Click on the name of the move group you're interested in. Here, you'll be able to find the ID of the move group at the end of the URL, as shown below:
+To find the ID of the migration wave that you'd like to export, log in to the Tidal Accelerator Platform and from the `Projects` view, select the project that your migration wave is associated with. In the `Project` view, go to `Migration Waves` tab. You should see a list of migration waves that are associated with the selected project. Click on the name of the migration wave you're interested in. Here, you'll be able to find the ID of the migration wave at the end of the URL, as shown below:
 
-{% include image.html file="move_group_id.png" caption="An image highlighting how to find a move group id." %}
+{% include image.html file="migration_wave_id.png" caption="An image highlighting how to find a migration wave id." %}
 
-Once you have this number, like you did in step 1, export the `move_group_id` as an environment variable.
+Once you have this number, like you did in step 1, export the `migration_wave_id` as an environment variable.
 
-    export  move_group_id="<your move group id>"
+    export  migration_wave_id="<your migration wave id>"
 
 
 ## 3. Run the script
 
-You're ready to run the script and export this information to a CSV. Now that you have gathered the required information and saved it in `move_group_to_csv.sh`, you will need to run script and pipe the output to a CSV file:
+You're ready to run the script and export this information to a CSV. Now that you have gathered the required information and saved it in `migration_wave_to_csv.sh`, you will need to run script and pipe the output to a CSV file:
 
-    ./move_group_to_csv.sh > move_group.csv
+    ./migration_wave_to_csv.sh > migration_wave.csv
 
-Now the data you need for your server migration is in the file move_group.csv and can be imported into RiverMeadow.
+Now the data you need for your server migration is in the file migration_wave.csv and can be imported into RiverMeadow.

pages/user guides/migration_waves.md

@@ -0,0 +1,79 @@
+---
+toc: false
+title: Migration Waves
+keywords: migration, migrate, cloud, group, move, plan, execute
+last_updated: April, 2025
+summary: "Organize your cloud migration into strategic waves of related resources for phased deployment"
+sidebar: main_sidebar
+folder: userguides
+permalink: migration-waves.html
+---
+
+Migration waves help you organize and execute your cloud migration in manageable, logical groups of related resources. By grouping applications, servers, and database instances that should move together, you can ensure dependencies are maintained and risks are reduced. These strategic waves allow you to break down large migration projects into smaller, coordinated moves that can be planned and executed efficiently.
+
+## Prerequisites
+
+Migration waves exist in projects, and function as a way to break a large project down into logical chunks. In order to proceed, you should first create a project in your workspace. For guidance on how to create a project, see [creating a project](assessment-projects.html#creating-a-project).
+
+## Creating migration waves
+
+To create a migration wave, first navigate to the project where you'd like to create this wave. 
+
+On the project page, you should see a tab called "Migration Waves".
+
+{% include image.html file="migration-waves-1.png" %}
+<br/>
+
+In this tab, you will see all existing waves of this project. To create a new wave, click "Create Wave". 
+
+{% include image.html file="migration-waves-2.png" %}
+<br/>
+
+Enter a name and - optionally - a time frame for the migration wave. 
+
+{% include image.html file="migration-waves-3.png" %}
+<br/>
+
+After the migration wave is created, it should appear in the table. You are now ready to assign some resources to this wave.
+
+## Assigning Resources to a Migration Wave
+
+From the "Migration Waves" project tab, click the name of the wave you'd like to assign resources to. You will see an overview of the migration wave, as well as tabs for applications, servers and database instances.
+
+The process for assigning resources to a wave is the same across all resource types. For this guide, we will assign some applications to the migration wave.
+
+Click on the "Apps" tab of your migration wave. You should see a table with the button "Add Applications".
+
+{% include image.html file="migration-waves-4.png" %}
+<br/>
+
+After clicking this button, you will be taking to a staging view. Here you can select which applications you'd like to assign to the wave. You can search your applications by name or tag, then make your selection by using the checkboxes in the application table. Once you've made your selection, click "Stage".
+
+{% include image.html file="migration-waves-5.png" %}
+<br/>
+
+The purpose of a migration wave is to allow you to define groups of resources which make logical sense to migrate together. for example - if you choose to migrate a given application, it makes sense to also include that application's servers and database instances in the same migration wave.
+
+That's why, in our migration planner, we've made it easy to discover related resources to the currently staged and previously committed records. The planner can be divided into three sections:
+
+1. Changes that are going to be made both with the currently staged items and the selected related resources. We display the total change to the migration wave by resource type and environment.
+
+    {% include image.html file="migration-waves-6.png" %}
+    <br/>
+
+2. A table displaying the parent resources which you initially selected. Here you'll also find a toggle which allows resources to be committed to multiple migration waves. By default, it is not possible to stage resources which are already in other migration waves. This is because in most cases, having a record spread across multiple migration waves is unnecessary and confusing. However, there are cases when a record needs to be staged across multiple waves, so we give you the escape hatch through this button.
+
+    {% include image.html file="migration-waves-7.png" %}
+    <br/>
+
+3. Along the bottom of the page, you'll find a table where you can toggle across each primary record type and see all the dependant resources of the currently staged and previously committed records. This table will also explain why the resource was suggested, as seen in the "Dependent On" column.
+
+    {% include image.html file="migration-waves-8.png" %}
+    <br/>
+
+Once you have selected any dependant resources that you'd like to add to the migration wave, select "Confirm and Apply". You will be shown a confirmation message outlining the resources which you're about to add to the migration wave. If you are satisfied, click "OK". 
+
+{% include image.html file="migration-waves-9.png" %}
+<br/>
+
+You will now find that your selected resources have been added to the migration wave.