|**Metadata**|**Description**  |
|--|--|
|Doc Title|  MVM v3: Manage Tooling VM|
|Navigation|[WIKI Home Page](https://dev.azure.com/mvmprodeus2/MVM/_wiki/wikis/documentation/1/documents-home#)|
|Tracking| Document Number: VPE-5512-020|
|Author| Graeme Thomson (gt163y) |
| Agreement Number | 24252.S.005 |

***
**Notices**

Copyright © 2025 Metaswitch Networks.  All rights reserved.

This manual is Confidential Information of Metaswitch Networks subject to the confidentiality terms
of the Agreement 01019223 as amended between AT&T and Metaswitch Networks.

It is issued on the understanding that no part of the product code or documentation (including this manual)
will be copied or distributed without prior agreement in writing from Metaswitch Networks and Microsoft.

Metaswitch Networks and Microsoft reserve the right to, without notice, modify or revise all or part of
this document and/or change product features or specifications and shall not be responsible for any
loss, cost, or damage, including consequential damage, caused by reliance on these materials.

Metaswitch and the Metaswitch logo are trademarks of Metaswitch Networks. Other brands and
products referenced herein are the trademarks or registered trademarks of their respective holders.

Product(s) and features documented in this manual handle various forms of data relating to your
users. You must comply with all laws and regulations applicable to your deployment, management,
and use of said product(s), and you should take all appropriate technical and organizational
measures to ensure you are handling this data appropriately according to any local legal and
regulatory obligations.

You are responsible for determining whether said product(s) or feature(s) is/are appropriate for
storage and processing of information subject to any specific law or regulation and for using said
product(s) or feature(s) in a manner consistent with your own legal and regulatory obligations. You
are also responsible for responding to any request from a third party regarding your use of said
product(s), such as a request to take down content under the U.S. Digital Millennium Copyright Act
or other applicable laws.


Metaswitch Networks
399 Main Street
Los Altos
CA 94022
<http://www.metaswitch.com>


***
***Table of Contents***
[[_TOC_]]

# 1. Document History

| **Issue** | **Issue Date** | **Author(s)** | **Identification** **of** **Changes** |
|-|-|-|-|
| 1| 06/10/2024| Gthomson|  initial draft |
| 2| 09/30/2024| Gthomson|  updates based on Ops feedback |
| 3| 11/26/2024| Gthomson|  Missing backtick from mvmtoolcli pipeline name |
| 4| 11/26/2024| Gthomson|  Correct name of pipeline configuration file to use when deleting downlevel VMs |
| 5| 11/26/2024| Gthomson|  Update default_vars.yml using sed |

# 2. Versions

| **Version #** | **Editor** | **Comments** |
|-|-|-|
| 1| Gthomson|  initial draft |
| 2| Gthomson|  updates based on Ops feedback |
| 3| Gthomson|  Missing backtick from mvmtoolcli pipeline name |
| 4| Gthomson|  Correct name of pipeline configuration file to use when deleting downlevel VMs |
| 5| Gthomson|  Update default_vars.yml using sed |

# 3. Integrated Solution Approach v1 (ISA v1)

| **Version #** | **Editor** | **Comments** |
|-|-|-|
| 1| Gthomson|  initial draft |
| 2| Gthomson|  updates based on Ops feedback |
| 3| Gthomson|  Missing backtick from mvmtoolcli pipeline name |
| 4| Gthomson|  Correct name of pipeline configuration file to use when deleting downlevel VMs |
| 5| Gthomson|  Update default_vars.yml using sed |

# 4. MOP Impact Scope / General Information

## 4.1 Description

The tooling VMs are used to host the MVM CLI tools. The VMs are built from an AT&T provided
golden image.

The security scans that AT&T run can detect vulnerabilities in these VMs that are corrected
by upgrading to a newer version of the golden image.

This MOP describes the process to replace the existing tooling VMs with ones built on the new image

## 4.2 Site Specific Description

| **Originator** | **Date** | **Time** |
|-|-|-|
| **Deployment Location(s)** | |
| **Description** | This MOP applies to the MVM V3 on Azure deployment, Release R11.5.3 | |

## 4.3 Service Impact

Service impact is not expected during this procedure. New resources are created and
verified before the existing resources are destroyed.

## 4.4 Coordination

This MOP has no interactions outside of the MVM subscription.

# 5. Prerequisite/Dependencies/Entrance Criteria of MOP

This MOP is one of several that need to be run to execute the process to upgrade an
existing deployment to an 11.5.3 release/patch.

Please refer to the corresponding *R11.5.3 Release Upgrade Overview* document for
guidance on the order in which to run these MOPs

## 5.1 Required parameters

The following parameter values are required to run this MOP

| **Identifier** | **Description** |
|-|-|
| **CMSMIGRATE_VERSION** | The version of the cmsmigrate tool. (**This is specified in the accompanying release note**) |
| **DOWNLEVEL_PIPELINE_CONFIGURATION_NAME** | Name of the downlevel pipeline configuration file for the region without the .yml suffix (e.g. `vars_eus2_11400`). |
| **DOWNLEVEL_TOOL_FIRST_INDEX** | The index of the first tooling VM currently instantiated |
| **DOWNLEVEL_TOOL_GOLDEN_IMAGE** | Golden image used to instantiate the current tooling VMs |
| **DOWNLEVEL_TOOL_INSTANCE_COUNT** | Number of tooling VMs currently instantiated |
| **GIT_AUTOMATION_REPOSITORY** | Name of the automation Azure DevOps repository. |
| **GIT_AUTOMATION_URL** | URL of the automation git repository.|
| **GIT_PASSWORD** | Password used to access the Azure DevOps repositories if you are using https to manage the local copy of the access the repository. |
| **LEGACYMIGRATE_VERSION** | The version of the legacymigrate tool. (**This is specified in the accompanying release note**) |
| **MSCLI_VERSION** | The version of the mscli tool. (**This is specified in the accompanying release note**) |
| **MVMGENUMR_VERSION** | The version of the mvmgenumr tool. (**This is specified in the accompanying release note**) |
| **MVMMAILBOX_VERSION** | The version of the mvmmailbox tool. (**This is specified in the accompanying release note**) |
| **MVMSUBREPORT_VERSION** | The version of the mvmsubreport tool. (**This is specified in the accompanying release note**) |
| **ORGANIZATION_NAME** | Name of the Azure DevOps organization. |
| **PROJECT** | Name of the Azure DevOps project. |
| **UPLEVEL_MVM_FILESHARE** | Name of the fileshare containing the Uplevel Release  (**This is specified in the release note**) |
| **UPLEVEL_PIPELINE_CONFIGURATION_NAME** | Name of the pipeline configuration file for the region without the .yml suffix (e.g. `vars_eus2_11500`). |
| **UPLEVEL_TOOL_FIRST_INDEX** | The index of the first tooling VM to instantiate with the new golden image |
| **UPLEVEL_TOOL_GOLDEN_IMAGE** | Golden image used to instantiate the new tooling VMs |
| **UPLEVEL_TOOL_INSTANCE_COUNT** | Number of tooling VMs to instantiate |

## 5.2 Required files

No additional files are required to run this MOP.

# 6. Assumptions

The target audience for this procedure is the AT&T Engineer who will be performing the task. They will need to be familiar with Azure and have a working knowledge of the Azure CLI and Linux.

# 7. Material Requirements

## 7.1 Required Documents

## 7.2 Tools

| **Tool** | **Description** | **Quantity** |
|-|-|-|
| Laptop or Desktop PC | PC With at least 1G Memory and a network communications software application such as Procomm, Reflections or PuTTY | 1 |
| Azure connectivity PC | CloudShell Connectivity is required to the azure subscription. This can be accessed via [My Dashboard - Microsoft Azure](https://portal.azure.com/#cloudshell/) | |

# 8. Pre Maintenance Check, Precautions and Preparations

## 8.1 Precautions and Preparation

## 8.2 Precautions

> This procedure may cause a partial outage during implementation. Use executable script files to minimize down time and typing errors. Familiarize yourself with back-out procedures prior to starting the procedure.

| **Ask Yourself Principle** | **Yes** | **No** | **N/A** |
|-|-|-|-|
| 1. Do I have the proper ID and appropriate building access permissions for the environment I am about to enter? | | |
| 2. Do I know why I'm doing this work? | | |
| 3. Have I identified and notified everybody - customers and internal groups - who will be directly affected by this work? | | |
| 4. Can I prevent or control service interruption? | | |
| 5. Is this the right time to do this work? | | |
| 6. Am I trained and qualified to do this work? | | |
| 7. Are the work orders, MOPs, and supporting documentation current and error-free? | | |
| 8. Do I have everything I need to quickly and safely restore service if something goes wrong? | | |
| 9. Have I walked through the procedure? | | |
| 10. Have I made sure the procedure includes proper closure including obtaining clearance and release for the appropriate work center? | | |


| **E911 Ask Yourself** | **Yes** | **No** | **N/A** |
|-|-|-|-|
| 1. Does this work impact E911? | | |
| 2. Do I know how this work could impact 911/e911? | | |
| 3. Do I know what 911/e911 phase is required? | | |
| 4. Have I identified potential risks to 911/e911 and taken all measures to minimize? | | |
| 5. Does this work affect 15+ sites? | | |
| 6. Can I prevent or control service Interruptions to 911/e911? | | |
| 7. Is this the right time to do the work? | | |
| 8. Is the individual performing the work trained and qualified to do this work? | | |
| 9. Are MOPs and supporting documents current and error free? | | |
| 10. Does the MOP include a 911/e911 test plan? | | |
     

## 8.3 Pre-Maintenance Check Tools/System

Tier 2 needs to identify which tools they will use. This doesn't necessarily need to be included in the MOP but OPS needs to know which tools they will run.

(NEED TO USE STANDARD TOOLS) TIER 2


## 8.4 Pre-Maintenance Check Manual (Non-Automated Requirements)

These will be identify by the tier 3 MOP developer were required.

(MANDATORY CHECK REQUIRE FOR THE MOP) TIER 3


## 8.5 MOP Certification Environment

Examples:  PSL certified.  OR This MOP was paper certified by ATS engineers.

## 8.6 ATS Bulletin

**ATS Bulletin Check**
| **Step** | **Action** | **Results/Description** | **Timeline** |
|-|-|-|-|
| 1. | No Applicable bulletins | | |


## 8.7 Emergency Contacts

The following emergency contact numbers are to be used in the event provisioning support is required.

In the event a service interruption is encountered the AT&T Implementation Engineer will:
- Cease all work immediately.
- Notify the AT&T Voicemail TRC.
- Escalate to the next level of support.


| **Organization** | **Contact Name** | **Contact Number** |
|-|-|-|
| Voicemail TRC | SANRC | 877-662-7674, opt 3 |

# 9. Implementation

## 9.1 Preliminary Implementation
Pre-check tasks are completed the night of the cutover at least one hour prior to cutover activities.

1. Connect to the DevOps Portal
   1. Start a browser session to <https://dev.azure.com/>. This will be required to manage the pipelines
   1. Select the project associated with MVM v3
1. Connect to the Azure Portal
   1. Start a browser session to <https://portal.azure.com/>. This will be required to manage Azure resources
      and access the log analytics workspace (LAW)
   1. If prompted, complete the log in process
1. Connect to Azure Cloud Shell
   1. Start a CloudShell session by connecting a browser to <https://shell.azure.com/>
   1. If the menu at the top left indicates PowerShell select Bash from the menu and confirm at the prompt

      ![screenshot](images/powershell.jpg)
1. Upload any files and directories outlined in section 5.2 to your Cloud Shell account as they will be needed later


## 9.2 Implementation


### 9.2.1 Prepare the automation Git repository

This is the Git repository that holds the pipelines, Terraform scripts etc.

These commands are run from the CloudShell session created above

1. Set the following environment variables:

   ```
   BRANCH={{ CHANGE_ID | default('<CHANGE_ID>') }}_{{ UPLEVEL_MVM_VERSION | default('<UPLEVEL_MVM_VERSION>') }}_update_tooling_vm
   ```

   Export the correct form of the URL to access the git repository
   -  If using https to interact with the git repository
      ```
      GIT_AUTOMATION_URL=https://{{ ORGANIZATION_NAME | default('<ORGANIZATION_NAME>') }}@dev.azure.com/{{ ORGANIZATION_NAME | default('<ORGANIZATION_NAME>') }}/{{ PROJECT|default('<PROJECT>') }}/_git/{{ GIT_AUTOMATION_REPOSITORY | default('<GIT_AUTOMATION_REPOSITORY>') }}

      ```

   -  If using ssh to interact with the git repository
      ```
      GIT_AUTOMATION_URL=git@ssh.dev.azure.com:v3/{{ ORGANIZATION_NAME | default('<ORGANIZATION_NAME>') }}/{{ PROJECT|default('<PROJECT>') }}/{{ GIT_AUTOMATION_REPOSITORY | default('<GIT_AUTOMATION_REPOSITORY>') }}
      ```

1. Change to an appropriate working directory in Cloud shell. Your Git repository will live in a subdirectory off of this path.

   ```
   cd ~
   mkdir automation_repo
   cd automation_repo
   ```

1. Clone the existing Azure DevOps Git repository with **<GIT_AUTOMATION_URL>**. The repository can be cloned using either ssh or https. In both cases you will run the following command:
   ```
   git clone ${GIT_AUTOMATION_URL} .
   ```
   (note the trailing whitespace and period after the URL)

   -  If using HTTPS:
      - When prompted, input the password, **<GIT_PASSWORD>**, that you specified when the repository was first created
   - If using SSH:
      - You will not be prompted for a password.

   This will create a local copy of the repository in the current working directory.


1. Create a new working branch by running the command
   ```
   git checkout -b ${BRANCH}
   ```

   The branch currently only exists on your local server - it will be pushed to the DevOps repository in a later step

### 9.2.2 Create a new pipeline configuration file

> This is an optional step that is only required if the release note and/or upgrade overview document indicates that the pipeline configuration file needs to be changed as part of the upgrade process.
>
> This will be the case if the upgrade process does ***NOT*** include an update of the pipeline infrastructure. In that case the uplevel pipeline configuration file will already have been created as part of that MOP.

1. Copy the existing pipeline configuration file to a new configuration file by running the command:

   ```
   cp pipelines/configuration/{{ DOWNLEVEL_PIPELINE_CONFIGURATION_NAME | default('<DOWNLEVEL_PIPELINE_CONFIGURATION_NAME>') }}.yml \
      pipelines/configuration/{{ UPLEVEL_PIPELINE_CONFIGURATION_NAME | default('<UPLEVEL_PIPELINE_CONFIGURATION_NAME>') }}.yml
   ```

1. Update the secrets monitoring configuration file by running the command:

   ```
   sed -i '/^  default_vars/c\  default_vars_file:  {{ UPLEVEL_PIPELINE_CONFIGURATION_NAME | default('<UPLEVEL_PIPELINE_CONFIGURATION_NAME>') }}.yml' pipelines/configuration/default_vars.yml

   ```

1. Add the new file to the repository by running the command:

   ```
   git add -A
   ```

1. Commit the change to the local branch by running the command:

   ```
   git commit -a -m "create new pipeline file"
   ```

### 9.2.3 Update the VM related parameters
<---------------- PRE-RENDER START --------------->
https://dev.azure.com/mvmprodeus2/MVM/_git/documentation?path=/Labs-ANTS-DevOps/SMOPs/Keystone-Mops/recordlatestgoldenimage.md&_a=preview
<---------------- PRE-RENDER END --------------->
<---------------- PRE-RENDER START --------------->
https://dev.azure.com/mvmprodeus2/MVM/_git/documentation?path=/Labs-ANTS-DevOps/SMOPs/Keystone-Mops/recordlatestgoldenimage.md&_a=preview
<---------------- PRE-RENDER END --------------->

1. Edit the file `pipelines/configuration/{{ UPLEVEL_PIPELINE_CONFIGURATION_NAME | default('<UPLEVEL_PIPELINE_CONFIGURATION_NAME>') }}.yml` and make the following changes.

   - Record the value of `tooling_first_instance_index` in **DOWNLEVEL_TOOL_FIRST_INDEX**
   - Record the value of `tooling_instance_count` in **DOWNLEVEL_TOOL_INSTANCE_COUNT**
   - Record the value of `tooling_golden_image` in **DOWNLEVEL_TOOL_GOLDEN_IMAGE**
   - Set `tooling_first_instance_index` to the start of the new tooling VM range **<UPLEVEL_TOOL_FIRST_INDEX>**
   - (optional) update `tooling_instance_count` to **<UPLEVEL_TOOL_INSTANCE_COUNT>** if you want to create a different number of VMs
   - Set `tooling_golden_image` to `{{ UPLEVEL_TOOL_GOLDEN_IMAGE | default('<UPLEVEL_TOOL_GOLDEN_IMAGE>') }}`

     All other parameters should remain unchanged

   We are saving the current self-hosted VM settings for use later and updating the existing parameters to use the new values.

   > Note that the new range of self-hosted agent VMs (**<UPLEVEL_TOOL_FIRST_INDEX>** through **<UPLEVEL_TOOL_FIRST_INDEX>** + **<UPLEVEL_TOOL_INSTANCE_COUNT>**) must not overlap with the existing range of VMs (**DOWNLEVEL_TOOL_FIRST_INDEX** through (**DOWNLEVEL_TOOL_FIRST_INDEX** + **DOWNLEVEL_TOOL_INSTANCE_COUNT**)

1. Commit the change to the local branch by running the command

   ```
   git commit -a -m "update tooling VM parameters"
   ```

### 9.2.4 Commit the changes to the remote repository

1. Push the change to the DevOps repository by running the command:

   ```
   git push --set-upstream origin ${BRANCH}
   ```

1. Merge the change into the main branch via the 'pull request' mechanism.

### 9.2.5 Remove the local copy of the git repository as we have finished with it

1. Tidy up by running the command:

   ```
   cd ~
   rm -rf automation_repo
   ```

### 9.2.6 Create the up-level tooling VMs

These commands are run from the DevOps Portal created in section 9.1

1. Select pipelines from the Left hand menu

1. Select pipelines from the sub menu

1. Select "All" from the resultant page

1. Expand pipelines

1. Select the pipeline `mvmtoolvm`

1. Select Run pipeline

1. In the resultant Run pipeline menu
   - Check Deploying into an AT&T subscription (the default)
   - Set 'Release to install packages from' to `{{ UPLEVEL_MVM_FILESHARE | default('<UPLEVEL_MVM_FILESHARE>') }}`
   - Set the name of the config file to `{{ UPLEVEL_PIPELINE_CONFIGURATION_NAME | default('<UPLEVEL_PIPELINE_CONFIGURATION_NAME>') }}`
   - Select Run

     Selecting Run will cause an approval email to be sent to the reviewers list.
     The pipeline will stall until the reviewers have approved the request. Once
     approval has been given the pipeline will run.

     The progress of the pipeline can be followed by clicking on the jobs list.

     Once the pipeline has completed, success, or failure, is reported to screen

### 9.2.7 Extract tooling VM private IPs

Each of the tooling VMs has a private IP that is used to access it. This needs to be
natted through the MT transit subscription.

These commands are run from the DevOps Portal session

1. In the pipeline main results page:
   - Select the '1 published` link in the **related** column. This takes you to the artifacts page.
   - Expand `privateips`. This displays a single file, `privateip.txt`
   - Click on the file to download it
   - Save the file, it will be required below. The file contains a list of host and IP addresses in the form

     ```
     host: <VM Host name> Private IP: <private IP>
     e.g.
     host: gtr115tool-1 Private IP: 10.225.160.134
     ```

1. Add the IPs to the MT NAT
   ***This is an AT&T owned process***

### 9.2.8 Install the MVM CLI tools

These commands are run from the DevOps Portal created in section 9.1

1. Select pipelines from the Left hand menu

1. Select pipelines from the sub menu

1. Select "All" from the resultant page

1. Expand pipelines

1. Select the pipeline `mvmtoolcli`

1. Select Run pipeline

1. In the resultant Run pipeline menu
   - Set the name of the config file to `{{ UPLEVEL_PIPELINE_CONFIGURATION_NAME | default('<UPLEVEL_PIPELINE_CONFIGURATION_NAME>') }}`
   - Set 'Release containing the CLI scripts' to `{{ UPLEVEL_MVM_FILESHARE | default('<UPLEVEL_MVM_FILESHARE>') }}`
   - Select Run

     Selecting Run will cause an approval email to be sent to the reviewers list.
     The pipeline will stall until the reviewers have approved the request. Once
     approval has been given the pipeline will run.

     The progress of the pipeline can be followed by clicking on the jobs list.

     Once the pipeline has completed, success, or failure, is reported to screen


1. Follow the [**Test Plan**](#testplan) to verify the tooling VM functionality.

### <a id=testfail></a>9.2.9 New VM functionality test failure

Only run this section of the MOP if the new tooling VMs are NOT working correctly.
In this case we need to delete the **new, up-level VMs**

All of the commands in this section are run from the DevOps Portal session

1. Select pipelines from the Left hand menu

1. Select pipelines from the sub menu

1. Select "All" from the resultant page

1. Expand pipelines

1. Select the pipeline `mvmtooltidy`

1. Select Run pipeline

1. In the resultant Run pipeline menu
   - Set the name of the config file to `{{ UPLEVEL_PIPELINE_CONFIGURATION_NAME | default('<UPLEVEL_PIPELINE_CONFIGURATION_NAME>') }}`
   - Set the index of the first VM to tidy up to be `<UPLEVEL_TOOL_FIRST_INDEX>`
   - Set the number of VMs to delete to `<UPLEVEL_TOOL_INSTANCE_COUNT>`
   - Select Run

     Selecting Run will cause an approval email to be sent to the reviewers list.
     The pipeline will stall until the reviewers have approved the request. Once approval
     has been given the pipeline will run.

     The progress of the pipeline can be followed by clicking on the jobs list.

     Once the pipeline has completed, success, or failure, is reported to screen

1. Restore the original pipeline configuration file following the instructions in the backout procedures

   Proceed to [**Backout Procedure**](#backout)


### <a id=testpass></a>9.2.10 New VM functionality test success

Only run this section of the MOP if the new tooling VMs are working correctly.
In this case we need to delete the **existing, down-level VMs**

All of the commands in this section are run from the DevOps Portal session

1. Select pipelines from the Left hand menu

1. Select pipelines from the sub menu

1. Select "All" from the resultant page

1. Expand pipelines

1. Select the pipeline `mvmtooltidy`

1. Select Run pipeline

1. In the resultant Run pipeline menu
   - Use a self-hosted agent pool (the default)
   - Set the name of the config file to `{{ DOWNLEVEL_PIPELINE_CONFIGURATION_NAME | default('<DOWNLEVEL_PIPELINE_CONFIGURATION_NAME>') }}`
   - Set the index of the first VM to tidy up to be `<DOWNLEVEL_TOOL_FIRST_INDEX>`
   - Set the number of VMs to delete to `<DOWNLEVEL_TOOL_INSTANCE_COUNT>`
   - Select Run

     Selecting Run will cause an approval email to be sent to the reviewers list.
     The pipeline will stall until the reviewers have approved the request. Once
     approval has been given the pipeline will run.

     The progress of the pipeline can be followed by clicking on the jobs list.

     Once the pipeline has completed, success, or failure, is reported to screen

## <a id=testplan></a>9.3 Test Plan

The test plan validates that you can connect to the tooling VMs and once connected
can run the various CLI tools.

To verify connectivity, you need the following:
- NATed IP address in the MT subscription for each of the tooling VMs
- Private key for the admin user (if you want to verify admin access)
- A command line session (you **cannot** use CloudShell) that supports az commands.


### 9.3.1 Log into Azure

This provides the session we will use for all of the subsequent tests

1. Run the command `az login`

Follow the prompts and enter your Azure identity when asked

***
**Repeat the remaining sections for each of the new VMs**
***

### 9.3.2 Verify Administrator access
This section is optional

1. use PuTTY /ssh to directly connect to the VM supplying the administrator's name and private key.

   The connection attempt should succeed

   quit the VM by entering `exit`

### 9.3.3 Verify the CLI tools

1. Connect to the corresponding IP from your workstation by running the command
   ```
   az ssh vm --ip <MT NAT IP for the VM>
   ```

   Depending on your Azure account's MFA settings you might be required to log into Azure on each connect attempt

1. Verify mvmmailbox by running the command:
   ```
   mvmmailbox --version
   ```

   The command should succeed and return the version **<MVMMAILBOX_VERSION>**

1. Verify mscli by running the command:
   ```
   mscli --version
   ```

   The command should succeed and return the version **<MSCLI_VERSION>**

1. Verify mvmgenumr by running the command:
   ```
   mvmgenumr --version
   ```

   The command should succeed and return the version **<MVMGENUMR_VERSION>**

1. Verify mvmsubreport by running the command:
   ```
   mvmsubreport --version
   ```

   The command should succeed and return the version **<MVMSUBREPORT_VERSION>**

1. Verify cmsmigrate by running the command:
   ```
   cmsmigrate --version
   ```

   The command should succeed and return the version **<CMSMIGRATE_VERSION>**

1. Verify legacymigrate by running the command:
   ```
   legacymigrate --version
   ```

   The command should succeed and return the version **<LEGACYMIGRATE_VERSION>**


1. Configure the environment variables required by the tools
   ***This is an AT&T owned process***

1. Run the CLI test plan to verify that he tools are working correctly
   ***This is an AT&T owned process***


### 9.3.4 Proceed with the upgrade

1. Depending on the results of the testplan, return to [**New VM functionality test failure**](#testfail)
   or [**New VM functionality test success**](#testpass) to continue the upgrade process.

## <a id=backout></a>9.4 Backout Procedure

### 9.4.1 Revert the changes

These commands are run from the CloudShell session created above

1. Set the following environment variables:

   ```
   BRANCH={{ CHANGE_ID | default('<CHANGE_ID>') }}_{{ UPLEVEL_MVM_VERSION | default('<UPLEVEL_MVM_VERSION>') }}_revert_tooling_vm
   ```

   Export the correct form of the URL to access the git repository
   -  If using https to interact with the git repository
      ```
      GIT_AUTOMATION_URL=https://{{ ORGANIZATION_NAME | default('<ORGANIZATION_NAME>') }}@dev.azure.com/{{ ORGANIZATION_NAME | default('<ORGANIZATION_NAME>') }}/{{ PROJECT|default('<PROJECT>') }}/_git/{{ GIT_AUTOMATION_REPOSITORY | default('<GIT_AUTOMATION_REPOSITORY>') }}

      ```

   -  If using ssh to interact with the git repository
      ```
      GIT_AUTOMATION_URL=git@ssh.dev.azure.com:v3/{{ ORGANIZATION_NAME | default('<ORGANIZATION_NAME>') }}/{{ PROJECT|default('<PROJECT>') }}/{{ GIT_AUTOMATION_REPOSITORY | default('<GIT_AUTOMATION_REPOSITORY>') }}
      ```

1. Change to an appropriate working directory in Cloud shell. Your Git repository will live in a subdirectory off of this path.

   ```
   cd ~
   mkdir automation_repo
   cd automation_repo
   ```

1. Clone the existing Azure DevOps Git repository with **<GIT_AUTOMATION_URL>**. The repository can be cloned using either ssh or https. In both cases you will run the following command:
   ```
   git clone ${GIT_AUTOMATION_URL} .
   ```
   (note the trailing whitespace and period after the URL)

   -  If using HTTPS:
      - When prompted, input the password, **<GIT_PASSWORD>**, that you specified when the repository was first created
   - If using SSH:
      - You will not be prompted for a password.

   This will create a local copy of the repository in the current working directory.


1. Create a new working branch by running the command
   ```
   git checkout -b ${BRANCH}
   ```

   The branch currently only exists on your local server - it will be pushed to the DevOps repository in a later step

1. Edit the file `pipelines/configuration/{{ UPLEVEL_PIPELINE_CONFIGURATION_NAME | default('<UPLEVEL_PIPELINE_CONFIGURATION_NAME>') }}.yml` and make the following changes.

   - Set `tooling_first_instance_index` to **DOWNLEVEL_TOOL_FIRST_INDEX**
   - Set `tooling_instance_count` to **DOWNLEVEL_TOOL_INSTANCE_COUNT**
   - Set `tooling_golden_image` to **DOWNLEVEL_TOOL_GOLDEN_IMAGE**

     All other parameters should remain unchanged

1. Commit the change to the local branch by running the command

   ```
   git commit -a -m "Revert tooling VM changes"
   ```

### 9.4.2 Commit the changes to the remote repository

1. Push the change to the DevOps repository by running the command:

   ```
   git push --set-upstream origin ${BRANCH}
   ```

1. Merge the change into the main branch via the 'pull request' mechanism.

### 9.4.3 Remove the local copy of the git repository as we have finished with it

1. Tidy up by running the command:

   ```
   cd ~
   rm -rf automation_repo
   ```

# 10. Post checks

[System healthchecks]

# 11. Risk Assessment Score

1 - TBD

# 12. Execute MOP clean up if required

# 13. End of Document MOP

# 14. Service Assurance/Monitoring

# A. Appendix and Tables

# B. Approvers

# C. Peer Reviewers

# D. References for Other Documents

# E. Additional Appendices (If required)