|**Metadata**|**Description**  |
|--|--|
|Doc Title|  MVM v3: Deploy Timer function|
|Navigation|[WIKI Home Page](https://dev.azure.com/mvmprodeus2/MVM/_wiki/wikis/documentation/1/documents-home#)|
|Tracking| Document Number: VPE-5512-012|
|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|  Remove spurious CURRENT_CONFIG_VERSION declarations |
| 4| 11/26/2024| Gthomson|  Correct git commit comment in section 9.2.7 |
| 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|  Remove spurious CURRENT_CONFIG_VERSION declarations |
| 4| Gthomson|  Correct git commit comment in section 9.2.7 |
| 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|  Remove spurious CURRENT_CONFIG_VERSION declarations |
| 4| Gthomson|  Correct git commit comment in section 9.2.7 |
| 5| Gthomson|  Update default_vars.yml using sed |

# 4. MOP Impact Scope / General Information

## 4.1 Description

MVM uses Azure Durable Functions for timer functionality for outdial/pager notifications and future delivery of Voicemails.

This MOP describes the process to upgrade the timer function.

## 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.

## 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** |
|-|-|
| **DOWNLEVEL_PIPELINE_CONFIGURATION_NAME** | Name of the downlevel pipeline configuration file for the region without the .yml suffix (e.g. `vars_eus2_11400`). |
| **GIT_AUTOMATION_URL** | URL of the automation git repository.|
| **GIT_AUTOMATION_REPOSITORY** | Name of the automation Azure DevOps repository. |
| **GIT_CONFIGURATION_URL** | URL of the configuration git repository. |
| **GIT_CONFIGURATION_REPOSITORY** | Name of the configuration Azure DevOps 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. |
| **ORGANIZATION_NAME** | Name of the Azure DevOps organization. |
| **PROJECT** | Name of the Azure DevOps project. |
| **SUBSCRIPTION_ID** | Azure subscription identifier.  |
| **TIMER_VERSION** | The version of the timer function to create. (**This is specified in the release note**) |
| **UPLEVEL_CONFIG_VERSION** | Configuration version returned by `mvm-config-manager prepare-new-config` |
| **UPLEVEL_MVM_FILESHARE** | Name of the fileshare containing the MVM 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`). This will contain the new timer function information. |
| **UPLEVEL_TIMER_NAME** | Name of uplevel timer function to create. This must be unique across Azure, be between 3 and 24 characters long and consist only of lowercase letters and numbers. |
| **UPLEVEL_TIMER_RG** | Name of the Resource Group that contains **UPLEVEL_TIMER_NAME**. This should be a resource group that is dedicated to this Timer and ***NOT*** shared with other resources. |

## 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
***
**To avoid the loss of timing events, deletion of the downlevel Timer Function is carried out in a separate MOP.**
***

### 9.2.1 Set the default subscription to the MVM subscription

1. Set the default subscription by running the command:

   ```
   az account set --subscription "Azure subscription identifier for the MVM subscription."
   ```

### 9.2.2 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, used as the prefix for any git branch created in the MOPs_The version number of the uplevel release, e.g. 11.5.0+1_upgrade_timer
   ```

   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://Name of the Azure DevOps organization.@dev.azure.com/Name of the Azure DevOps organization./Name of the Azure DevOps project./_git/Name of the automation Azure DevOps repository.

      ```

   -  If using ssh to interact with the git repository
      ```
      GIT_AUTOMATION_URL=git@ssh.dev.azure.com:v3/Name of the Azure DevOps organization./Name of the Azure DevOps project./Name of the automation Azure DevOps 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.3 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/Name of the downlevel pipeline configuration file for the region without the .yml suffix (e.g. vars_eus2_11400)..yml \
      pipelines/configuration/Name of the uplevel pipeline configuration file for the region without the .yml suffix (e.g. vars_eus2_11500)..yml
   ```

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

   ```
   sed -i '/^  default_vars/c\  default_vars_file:  Name of the uplevel pipeline configuration file for the region without the .yml suffix (e.g. vars_eus2_11500)..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.4 Update the configuration to reflect the new timer function

1. The up-level timer function cannot use the same resources as the down-level timer, so we need to update the configuration parameters in the pipeline configuration file by running the following commands:

   ```
   sed -i '/^  timer_function_name/c\  timer_function_name:  Name of uplevel timer function to create. This must be unique across Azure, be between 3 and 24 characters long and consist only of lowercase letters and numbers.' pipelines/configuration/Name of the uplevel pipeline configuration file for the region without the .yml suffix (e.g. vars_eus2_11500)..yml
   ```

   ```
   sed -i '/^  timer_resource_group/c\  timer_resource_group:  Name of the Resource Group that contains UPLEVEL_TIMER_NAME. This should be a resource group that is dedicated to this Timer and NOT shared with other resources.' pipelines/configuration/Name of the uplevel pipeline configuration file for the region without the .yml suffix (e.g. vars_eus2_11500)..yml
   ```

   **Name of uplevel timer function to create. This must be unique across Azure, be between 3 and 24 characters long and consist only of lowercase letters and numbers.** needs to be unique across all of Azure.

   **Name of the Resource Group that contains UPLEVEL_TIMER_NAME. This should be a resource group that is dedicated to this Timer and NOT shared with other resources.** should be used only for the uplevel timer. You should not use the same resource group as for any other resources, including any down-level timer functions. This is because the backout / delete functions work by deleting the resource group and ALL of its contents.

   >All other parameters ***MUST*** remain unchanged.


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

   ```
   git commit -a -m "Update pipeline configuration file to reference new timer"
   ```

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

1. Tidy up by running the command:

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

   (We have finished with the local copy of the repository)


### <a id=createtimer></a> 9.2.5 Create the uplevel Timer function

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 `mvmtimer`

1. Select Run pipeline

1. In the resultant Run pipeline menu
   - Select `create` for the operation to perform
   - Set the Timer version to be `The version of the timer function to create. (This is specified in the release note)`
   - Set the release to `Name of the fileshare containing the MVM release (This is specified in the release note)`
   - Set the name of the config file to `Name of the uplevel pipeline configuration file for the region without the .yml suffix (e.g. vars_eus2_11500).`
   - 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.6 Verify timer functionality

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


### <a id=testpass></a>9.2.7 Timer function verification successful

Only run this section of the MOP if the new timer function is working correctly

We need to update the name of the timer function the configuration of the ESC SIs
that will be running the uplevel version of MVM. We make the configuration change here
but will not pick it up until we upgrade the ESCs in a later MOP

These commands are run from the CloudShell session created above

1. Set the following environment variables:

   ```
   BRANCH=Change ID, used as the prefix for any git branch created in the MOPs_The version number of the uplevel release, e.g. 11.5.0+1_use_updated_timer
   ```

   Export the correct form of the URL to access the git repository
   -  If using https to interact with the git repository
      ```
      GIT_CONFIGURATION_URL=https://Name of the Azure DevOps organization.@dev.azure.com/Name of the Azure DevOps organization./Name of the Azure DevOps project./_git/Name of the configuration Azure DevOps repository.
      ```

   -  If using ssh to interact with the git repository
      ```
      GIT_CONFIGURATION_URL=git@ssh.dev.azure.com:v3/Name of the Azure DevOps organization./Name of the Azure DevOps project./Name of the configuration Azure DevOps 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 configuration_repo
   cd configuration_repo
   ```

1. Clone the existing Azure DevOps Git repository with **<GIT_CONFIGURATION_URL>**. The repository can be cloned using either ssh or https. In both cases you will run the following command:
   ```
   git clone ${GIT_CONFIGURATION_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. Create a new config set with an appropriate description by running the command:

   ```
   mvm-config-manager prepare-new-config \
      --description "update timer version used by ESC"
   ```

   This will create create a new config version and commit (but not push) the code.

   On success this will return a message of the form

   `Created new config version <UPLEVEL_CONFIG_VERSION> ...`

   Record the value of **UPLEVEL_CONFIG_VERSION**; it will be required later in this procedure.
   Set it as an environment variable as well:
   ```
   UPLEVEL_CONFIG_VERSION=<UPLEVEL_CONFIG_VERSION>
   ```

1. Update the timer function used by the ESC by running the following command:
     ```
     sed -i '/^TIMER_FUNCTION_NAME=/c\TIMER_FUNCTION_NAME=Name of uplevel timer function to create. This must be unique across Azure, be between 3 and 24 characters long and consist only of lowercase letters and numbers.' config/${UPLEVEL_CONFIG_VERSION}/esc/esc.vars
     ```

1. Commit the changes by running the command:
   ```
   git commit -a -m "Update timer version used by ESC"
   ```

1. Apply the updated configuration to all non-running ESCs by running the command:
   ```
   mvm-config-manager apply-config \
      --config-version ${UPLEVEL_CONFIG_VERSION} \
      --si-type esc
   ```

   This will output a message confirming that the operation was successful, and the config version was applied to the SIs, e.g.

   ```
   Applied config version 11.5.0-rc.18.3-0 to SIs with type ESC.

   Upgraded SIs:
   e12z1
   e12z2
   e12z3
   ```

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

1. Tidy up by running the command:

   ```
   cd ~
   rm -rf configuration_repo

   ```

   (We have finished with the local copy of the repository)




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

To confirm that the Timer service is working correctly:

- Search in the Portal UI for a Function App named **Name of uplevel timer function to create. This must be unique across Azure, be between 3 and 24 characters long and consist only of lowercase letters and numbers.**.

### 9.3.1 Verify Runtime version

On the Overview page, check the property "Runtime version". If the "Runtime version" is
"Error", then follow the [**Backout Procedure**](#backout) to delete the uplevel timer function.
Once the uplevel timer function is destroyed, return to [**Create the uplevel timer function**](#createtimer)
to re-deploy a new uplevel timer function.

If the "Runtime version" is no longer "Error", then move on to verifying the Memory working set.

If the "Runtime version" is still "Error", then contact **Support** and follow the [**Backout Procedure**](#backout).

### 9.3.2 Verify Memory working set

From the Overview page select the metrics tab.

This will show a Metrics graph titled Memory working set. This graph should show the
Memory working set to be non-zero. If the memory working set is non-zero, return
to [**Timer function verification successful**](#testpass) to continue the
upgrade process.

If the Memory working set is zero, click Restart on the list of options at the top
of the Overview page. If the memory working set is now non-zero, return
to [**Timer function verification successful**](#testpass) to continue the
upgrade process.

If the memory working set is still zero, contact **Support**  and follow the
[**Backout Procedure**](#backout).

## 9.4 Backout Procedure

   The backout procedure is to delete the uplevel timer function

### 9.4.1 Delete the uplevel Timer function

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 `mvmtimer`

1. Select Run pipeline

1. In the resultant Run pipeline menu
   - Select `delete` for the operation to perform
   - Leave the timer version at its default value
   - Leave the release containing the timer script at its default value
   - Set the name of the config file to `Name of the uplevel pipeline configuration file for the region without the .yml suffix (e.g. vars_eus2_11500).`
   - 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

# 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)