# Copyright (c) Microsoft Corporation. All rights reserved.
# Highly Confidential Material
#
# Example configuration file for the main deployment upgrade MOP
# This is a yaml format file. Each line takes the form
#   <parameter_name>: "<parameter_value>"
# e.g.
#   PROJECT: "myproject"
#
# Note that <parameter_name> is case sensitive
#
# Deployment wide variables
AZURE_TRAFFIC_MANAGER_RESOURCE_GROUP:    "The resource group that contains the MVM Azure Traffic Manager profiles"
CONFIG_MGR_VERSION:                      "Uplevel mvm-config-manager version, e.g. `1.7.6`"
DEPLOYMENT_GIT_CONFIGURATION_REPOSITORY: "Name of the configuration Azure DevOps repository in the deployment region"
DEPLOYMENT_ORGANIZATION_NAME:            "Name of the Azure DevOps organization in the deployment region"
DEPLOYMENT_PROJECT:                      "Name of the Azure DevOps project in the deployment region."
DOWNLEVEL_DEPLOYMENT_TFVARS_NAME:        "Name of the downlevel (current) version of the deployment pre-requisites configuration file without the tfvars suffix (e.g. main_eus2_11400)."
DOWNLEVEL_MVM_FILESHARE:                 "Name of the fileshare containing the downlevel (current) MVM release"
DOWNLEVEL_MVM_VERSION:                   "The version number of the downlevel release, e.g. 11.4.0+4"
DNS_ZONE:                                "Name of the global DNS zone"
MT_SUBSCRIPTION_ID:                      "Azure subscription identifier for the MT subscription."
MVM_AUTH_APPLICATION_URI:                "The application URI for this MVM deployment"
MVM_AUTH_CLIENT_ID:                      "The Application (client) ID of the registered Enterprise application for MVM"
SUBSCRIPTION_ID:                         "Azure subscription identifier for the MVM subscription."
TENANT_ID:                               "Azure tenant identifier"
TIMER_VERSION:                           "The version of the timer function to create. (This is specified in the release note)"
UPLEVEL_DEPLOYMENT_TFVARS_NAME:          "Name of the uplevel version of the deployment pre-requisites configuration file without the tfvars suffix (e.g. main_eus2_11500)."
UPLEVEL_MVM_FILESHARE:                   "Name of the fileshare containing the MVM release (This is specified in the release note)"
UPLEVEL_MVM_VERSION:                     "The version number of the uplevel release, e.g. 11.5.0+1"
UPLEVEL_SHA_GOLDEN_IMAGE:                "Golden image index used to instantiate the new self-hosted agent VMs"
UPLEVEL_SIMPL_UNIQUE_SUFFIX:             "A unique identifier to distinguish this SIMPL cluster from the existing SIMPL clusters. May only contain alphanumeric characters and dashes, e.g.11500"
UPLEVEL_SIMPL_VERSION:                   "Version of the uplevel SIMPL, e.g. 15.0.5. (This is specified in the release note)"
UPLEVEL_TOOL_GOLDEN_IMAGE:               "Golden image used to instantiate the new tooling VMs"

##### Deployment wide variables added in release 11.5.2  ####
SUBSCRIPTION_NAME:                       "Azure subscription name for the MVM subscription"
AGENT_KEY_VAULT_NAME:                    "Name of the Key Vault where secrets and certificates are stored for the entire deployment."

##### Deployment wide variables added in release 11.5.3  ####
DOWNLEVEL_SIMPL_VERSION:                 "Version of the downlevel SIMPL, e.g. 14.0.0. (This is specified in the release note)"

##### Deployment wide variables removed in release XXX #####


# Region specific variables
AGENT_POOL_NAME:                         "Name of the self-hosted agent pool."
AZURE_REGION:                            "This Azure region, e.g. `eastus2`."
CHANGE_ID:                               "Change ID, used as the prefix for any git branch created in the MOPs"
CLOUD_SHELL_LOCATION:                    "The location of the files that were copied to the Cloud Shell account."
DOWNLEVEL_CONFIG_VERSION:                "The name of the config set directory containing the downlevel SI configuration. Config sets are located in the `config` directory."
DOWNLEVEL_PIPELINE_CONFIGURATION_NAME:   "Name of the downlevel pipeline configuration file for the region without the .yml suffix (e.g. vars_eus2_11400)."
DOWNLEVEL_REGION_TFVARS_NAME:            "Name of the downlevel (current) version of the regional pre-requisites configuration file without the tfvars suffix (e.g. region_eus2_11400)."
GIT_AUTOMATION_BRANCH:                   "Name of the default branch of the MVM Azure automation repository. This is usually `main`."
GIT_AUTOMATION_REPOSITORY:               "Name of the automation Azure DevOps repository."
GIT_CONFIGURATION_REPOSITORY:            "Name of the configuration Azure DevOps repository."
KEY_VAULT_NAME:                          "Name of the Key Vault where secrets and certificates are stored for a single region."
KEY_VAULT_RG:                            "Name of the resource group that contains the key vault KEY_VAULT_NAME"
ORGANIZATION_NAME:                       "Name of the Azure DevOps organization."
PERIMETA_DCR:                            "Name of the Data Collection Rule resource (DCR) used by Perimeta VMs to record logs"
PERIMETA_EFIXES:                         "The list of efixes to install comma separated, specify as \"\" if no efixes. This is specified in the release note"
PERIMETA_VERSION:                        "The perimeta version, takes the form MSwVA-Perimeta-V5.4.10_SU56_P01-6GB_image. This is specified in the release note"
PROJECT:                                 "Name of the Azure DevOps project."
REGIONAL_PIPELINE_KEY_VAULT_NAME:        "Name of the regional pipeline key vault"
REGIONAL_PIPELINE_KEY_VAULT_RG:          "Name of the resource group that contains the key vault REGIONAL_PIPELINE_KEY_VAULT_NAME"
REGION_LAW:                              "Name of the Log Analytics Workspace (LAW) associated with the region"
REGION_SHORTNAME:                        "The short (4-characters maximum) DNS label for the region"
SELFHOST_DEPLOYMENT_NAME:                "Label to prefix all self-hosted agent resources"
SELFHOST_VM_RESOURCE_GROUP:              "Resource group used to host the self-hosted agent resources"
SIMPL_SERVICE_NAME:                      "An identifier for the SIMPL instance"
TRUSTED_CA_BUNDLE:                       "The full path to a .pem file on the tooling VM containing the Root CA certificate used to sign the DOMAIN_TLS_CERT, which must be trusted by users of MVM APIs. This file must contain a single CA certificate. Multiple CA certs are not supported."
UPLEVEL_PIPELINE_CONFIGURATION_NAME:     "Name of the uplevel pipeline configuration file for the region without the .yml suffix (e.g. vars_eus2_11500)."
UPLEVEL_REGION_TFVARS_NAME:              "Name of the uplevel version of the regional pre-requisites configuration file without the tfvars suffix (e.g. region_eus2_11500)."
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."
VNET_NAME:                               "Name of the mvm vnet"

##### Region specific variables added in release 11.5.2  ####  
SP_APP_NAME:                             "Name of the Microsoft Entra ID Application"
SP_APP_ID:                               "Identifier of the Azure Service Principal"
SC_NAME:                                 "Name of the ADO service connection used in MVM deployment pipelines - recorded as `mvm_service_connection` in the pipeline configuration variables file"

##### Region specific variables removed in release XXX #####