# Changelog

## [Unreleased]
### Added

### Fixed

## [11.5.4]
### Added
- Add add SIMPL AKS version MOPs (part of ps)
- Added a MOP for deploying a NAT Gateway into a subnet as a fix for retirement of Azure default outbound access
- Added notice that for 11.5.4 the first SIMon SI upgrade should take place in a maintenace window in both LEA and main.

### Fixed
- Fix SIMPL cluster upgrade environment variables commands.
- Removed `media_account_replication` variable from upgrade docs for 11.5.3 -> 11.5.4.
- Add step to repair the permissions on the app registration after doing deployment pre-reqs.

## [11.5.3+4] - 2025-07-18

### Added
- Add add region MOPs (part of ps)
- Add a MOP for rotation of the retry queue storage account keys

### Fixed
- upgradeclitools.j2
  - correct the order of menu items in section 9.2.1 and 9.4
- Fix DOWNLEVEL_SIMPL_SERVICE_RG and UPLEVEL_SIMPL_SERVICE_RG naming format
- Document an issue with pods getting stuck in Init.
- Add another safe check_upgrade.txt output in the upgrade region prerequisites MOP.

## [11.5.3] - 2025-03-24

### Added
- Add DOWNLEVEL_SIMPL_VERSION as a variable for SMOP generation.
- Overview MOP is delivered as a j2 file, not md file and is rendered along with the other MOPs when running `render.py`

### Changed
- upgradetimer.j2
  - clarify steps in sections 9.2.4 and 9.2.7 to avoid user error
- upgradetoolingvm.j2
  - correct the order of menu items in section 9.2.8

## [11.5.2] - 2025-01-20

### Added
- R11.5.2 specific MOP for converting the Azure pipelines service connection to use Federated Credentials.
- R11.5.2 specific MOP for replacing the config validation service connection with a new Service Connection using Federated Credentials on a new Service Principal with reduced permissions.
- R11.5.2 specific MOP for removing the deployment service principal's client secret.

### Changed
- Remove spurious CLOUD_SHELL_LOCATION declaration from prereqs MOPs
- Remove spurious CURRENT_CONFIG_VERSION from upgrade timer MOP
- Correct git commit comment in upgrade timer MOP
- Format cloud shell location in section 5.2 in monospaced format (multiple MOPs)
- Missing backtick from mvmtoolcli pipeline name in upgrade tooling VM and upgrade CLI tool MOPs
- Use correct pipeline configuration file when deleting downlevel VMs in upgrade tooling VM and upgrade Self-hosted Agent VM MOPs
- Extract SIMPL RG name programatically in upgrade SIMPL MOP
- Use sed command to update pipeline configuration file in upgrade SIMPL MOP
- Use sed command to update default_vars.yml (multiple MOPs)

### Removed

## [11.5.1] - 2024-10-24

### Added
- Instructions added for running the update_api_versions.sh script

### Changed
- Update versioning to match MVM release
- Update all MOPs for R11.5.1 release
- Rename upgrade process from "main" to "upgrade_main"
- Fix up command syntax for managing CCM SI configuration during upgrade
- Fix list intentation for pager sequence rules when upgrading CMM SIs
- Move deployment-level variables to correct place in example configuration
- Add clarification on how to use CLOUD_SHELL_LOCATION

### Removed

## [1.0.4] - Operations feedback - 2024-09-30
### Added

### Changed
- r115leaupgradeadopipelineresources.j2, r115upgradeadopipelineresources.j2
- r115leaupgradedeploymentprereqs.j2, r115upgradedeploymentprereqs.j2
- r115leaupgraderegionalprereqs.j2, r115upgraderegionalprereqs.j2
- r115leaupgradeselfhostedagentvm.j2,r115upgradeselfhostedagentvm.j2
- r115leaupgradesimplcluster.j2, r115upgradesimplcluster.j2
- r115leaupgradetoolingvm.j2, r115upgradetoolingvm.j2
- r115upgradetimer.j2
  - make all commit messages explicit

- r115leadeletesas.j2, r115deletesas.j2
- r115leaupgradeadopipelineresources.j2, r115upgradeadopipelineresources.j2
- r115leaupgradeconfiguration.j2, r115upgradeconfiguration.j2
- r115leaupgradedeploymentprereqs.j2, r115upgradedeploymentprereqs.j2
- r115leaupgradeesc.j2, r115upgradeesc.j2
- r115leaupgraderegionalprereqs.j2, r115upgraderegionalprereqs.j2
- r115leaupgradesas.j2, r115upgradesas.j2
- r115leaupgradeselfhostedagentvm.j2, r115upgradeselfhostedagentvm.j2
- r115leaupgradesimon.j2, r115upgradesimon.j2
- r115leaupgradesimplcluster.j2, r115upgradesimplcluster.j2
- r115leaupgradetoolingvm.j2, r115upgradetoolingvm.j2
- r115upgradeccm.j2
- r115upgradecmm.j2
- r115upgradetimer.j2
  - modify format of branch name to include the release version

- r115leadeletesas.j2, r115deletesas.j2
- r115leaupgradeadopipelineresources.j2, r115upgradeadopipelineresources.j2
- r115leaupgradeclitools.j2, r115upgradeclitools.j2
- r115leaupgradeconfigmanager.j2, r115upgradeconfigmanager.j2
- r115leaupgradeconfiguration.j2, r115upgradeconfiguration.j2
- r115leaupgradedeploymentprereqs.j2, r115upgradedeploymentprereqs.j2
- r115leaupgradeesc.j2, r115upgradeesc.j2
- r115leaupgraderegionalprereqs.j2, r115upgraderegionalprereqs.j2
- r115leaupgradesas.j2, r115upgradesas.j2
- r115leaupgradeselfhostedagentvm.j2, r115upgradeselfhostedagentvm.j2
- r115leaupgradesimon.j2, r115upgradesimon.j2
- r115leaupgradesimplcluster.j2, r115upgradesimplcluster.j2
- r115leaupgradetoolingvm.j2, r115upgradetoolingvm.j2
- r115leauploadartifacts.j2, r115uploadartifacts.j2
- r115deletetimer.j2
- r115upgradeccm.j2
- r115upgradecmm.j2
- r115upgradetimer.j2
- r115uploadperimeta.j2
- r115uploadperimetaefixes.j2
  - Add level 3 section headers

- r115leaupgradeesc.j2, r115upgradeesc.j2
- r115leaupgradeselfhostedagentvm.j2, r115upgradeselfhostedagentvm.j2
- r115leaupgradesimon.j2, r115upgradesimon.j2
- r115leaupgradetoolingvm.j2, r115upgradetoolingvm.j2
- r115upgradetimer.j2
  - Add return links when jump to test plan


- vars_lea_example.yaml, vars_main_example.yaml
  - identify variables added / removed in each release
  - move perimeta variables to region section

- r115leaupgradeadopipelineresources.j2, r115upgradeadopipelineresources.j2
  - correct typo: Azure-devops => azure-devops
  - document expected error message as benign
  - use sed commands to update pipelines rather than vi

- r115leaupgradeselfhostedagentvm.j2, r115upgradeselfhostedagentvm.j2
  - Remove extraneous * around VM names
  - update example VM names 1

- r115leaupgradeconfiguration.j2, r115upgradeconfiguration.j2
  - correct minor typos around UPLEVEL_CONFIG_VERSION

- r115leaupgradesimplcluster.j2, r115upgradesimplcluster.j2
  - Clarify the need for step 9.2.8

- r115leaupgradesimon.j2, r115upgradesimon.j2
  - Clarifications to steps 9.2.4 & 9.2.5

- r115leaupgradesc.j2, r115upgradeesc.j2
  - Clarifications to steps 9.2.4 & 9.2.5

- r115leaupgradsas.j2, r115upgradesas.j2
  - Clarifications to steps 9.2.4 & 9.2.5

- r115upgradetimer.j2
  - Clarifications to seting of UPLEVEL_CONFIG_VERSION

### Removed

## [1.0.3] - R11.5.0+2 - 2024-09-16
### Added

### Changed
- r11501tor11502leaupgradeoverviewmop.j2
  - removed notary signer, perimeta image and perimeta efix list as this is now done as part of r115leaupgradeconfiguration.j2

- r11501tor11502upgradeoverviewmop.j2
  - removed notary signer, perimeta image and perimeta efix list as this is now done as part of r115upgradeconfiguration.j2

- r115leaupgradeconfiguration.j2
  - Explicitly set notary signer as part of fixed changes
  - Explicitly set perimeta image as part of fixed changes
  - Explicitly set perimeta efix list as part of fixed changes

- r115upgradeconfiguration.j2
  - Set DOWNLEVEL_MVM_VERSION prior to use
  - Explicitly set notary signer as part of fixed changes
  - Explicitly set perimeta image as part of fixed changes
  - Explicitly set perimeta efix list as part of fixed changes

- vars_lea_example.yaml and vars_main_example.yaml
  - Add PERIMETA_EFIXES to list of variables
  - Add PERIMETA_VERSION to list of variables

### Removed

## [1.0.2] - R11.5.0+2 - 2024-09-20
### Added
- r11501tor11502leaupgradeoverview.j2
- r11501tor11502upgradeoverview.j2

### Changed
- r115upgraderegionalprereqs.md
  - Add West US3 specific LRS/ZS changes
  - correct minor typos on update regional prereqs section


- r115upgradeconfiguration.j2 and r115leaupgradeconfiguration.j2
  - Make OBER related changes as inline changes rather than through an editor

### Removed
- r11414tor11500leaupgradeoverview.j2
- r11414tor11501leaupgradeoverviewmop.j2
- r11500tor11501leaupgradeoverviewmop.j2
- r11414tor11500upgradeoverview.j2
- r11414tor11501upgradeoverviewmop.j2
- r11500tor11501upgradeoverviewmop.j2

## [1.0.1] - R11.5.0+1 - 2024-08-16
### Added
- learegionencryption.md, mainregionencryption.md
  - New standalone MOPs to update regional encryption in flight CA Certificate

### Changed
- render.py
  - Make \-\-o outdir optional parameter when generating gmops (defaults to gmop.<template> as before)
  - Change template file suffix to .j2

- Example configuration files
  - Remove region_tags and capacity reservation parameters (as they are not required)
  - Add vnet_name
  - Add agent_pool_name
  - Add tenant_id
  - Add change_id

- r115leaupgradeconfigmanager.md, r115upgradeconfigmanager.md
  - populate configuration manager version with value from configuration file

- r115leaupgradeselfhostedagentvm.md, r115upgradeselfhostedagentvm.md
  - Agent pool name does not follow a standard naming convention so add a new parameter for it

- All MOPs
  - Substitute `subscription id` directly into the `az account` command
  - Change Date on branch name to be change_id

- r115leaupgradesimplcluster.md, r115upgradesimplcluster.md
  - Calculate SIMPL downlevel version rather than through a configuration parameter

- Upgrade overview documents
  - Explicitly document new terraform values for the new PSQL DB types in the overview document

- r115upgraderegionalprereqs.md, r115leaupgraderegionalprereqs.md
  - Document that changes to outputs section are benign
  - Document possibility of re-peering failure on regional pre-reqs upgrade and provide remedial action

- r115leaupgradesimon.md, r115upgradesimon.md
  - Change SIMON_SERVICE_NAME to UPLEVEL_SIMON_NAME

- r115leaupgradesas.md, r115upgradesas.md
  - Change SAS_SI_WEIGHT_IDENTIFIER to UPLEVEL_SAS_SI_WEIGHT_IDENTIFIER
  - Change SAS_SERVICE_NAME to UPLEVEL_SAS_NAME

### Fixed
- r115leaupgradeselfhostedagentvm.md, r115upgradeselfhostedagentvm.md
  - Missing export statement on Self hosted agent configuration command
  - SERVER_URL missing trailing quote
  - Correct bug in overview text VM functionality test. Wrong set of VMs are deleted.

- r115leaupgradetoolvm.md, r115upgradetoolvm.md
  - Correct bug in overview text VM functionality test. Wrong set of VMs are deleted.

- r115upgradetimer.md
  - Correct typo in timer function pipeline parameters

- r115leaupgradeesc.md, r115upgradeesc.md
  - Missing trailing quote from MSW_AZURE_CLIENT_ID

## [1.0.0] - 2024-08-05
### Added
- Initial release with core features.