Merge pull request #211711 from KimForss/main

prmerger-automator[bot] · web-flow · commit 726de6beefd0 · 2022-09-19T17:54:35.000Z
Updated a typo
diff --git a/articles/virtual-machines/workloads/sap/automation-configure-devops.md b/articles/virtual-machines/workloads/sap/automation-configure-devops.md
@@ -12,42 +12,43 @@ ms.service: virtual-machines-sap
 # Use SAP Deployment Automation Framework from Azure DevOps Services
 
 Using Azure DevOps will streamline the deployment process by providing pipelines that can be executed to perform both the infrastructure deployment and the configuration and SAP installation activities.
-You can use Azure Repos to store your configuration files and Azure Pipelines to deploy and configure the infrastructure and the SAP application. 
+You can use Azure Repos to store your configuration files and Azure Pipelines to deploy and configure the infrastructure and the SAP application.
 
 ## Sign up for Azure DevOps Services
 
-To use Azure DevOps Services, you'll need an Azure DevOps organization. An organization is used to connect groups of related projects. Use your work or school account to automatically connect your organization to your Azure Active Directory (Azure AD). To create an account, open [Azure DevOps](https://azure.microsoft.com/services/devops/) and either _sign-in_ or create a new account. 
+To use Azure DevOps Services, you'll need an Azure DevOps organization. An organization is used to connect groups of related projects. Use your work or school account to automatically connect your organization to your Azure Active Directory (Azure AD). To create an account, open [Azure DevOps](https://azure.microsoft.com/services/devops/) and either _sign-in_ or create a new account.
 
 ## Configure Azure DevOps Services for the SAP Deployment Automation Framework
 
 You can use the following script to do a basic installation of Azure Devops Services for the SAP Deployment Automation Framework.
 
-Login to Azure Cloud Shell
+Log in to Azure Cloud Shell
 ```bash
-    export ADO_ORGANIZATION=<yourOrganization>    
-    export ADO_PROJECT=SAP Deployment Automation
-    wget https://raw.githubusercontent.com/Azure/sap-automation/experimental/deploy/scripts/create_devops_artifacts.sh -O devops.sh
-    chmod +x ./devops.sh
-    ./devops.sh
-    rm ./devops.sh
+   export ADO_ORGANIZATION=https://dev.azure.com/<yourorganization>
+   export ADO_PROJECT=SAP Deployment Automation
+   wget https://raw.githubusercontent.com/Azure/sap-automation/main/deploy/scripts/create_devops_artifacts.sh -O devops.sh
+   chmod +x ./devops.sh
+   ./devops.sh
+   rm ./devops.sh
 
 ```
 
 Validate that the project has been created by navigating to the Azure DevOps portal and selecting the project. Ensure that the Repo is populated and that the pipelines have been created.
 
 You can finalize the Azure DevOps configuration by running the following scripts on your local workstation. Open a PowerShell Console and define the environment variables. Replace the bracketed values with the actual values.
 
-
+> [!IMPORTANT]
+> Run the following steps on your local workstation, also make sure that you have logged on to Azure using az login first.
 
 
 ```powershell
-$Env:ADO_ORGANIZATION="https://dev.azure.com/<yourorganization>" 
+   $Env:ADO_ORGANIZATION="https://dev.azure.com/<yourorganization>"
 
-$Env:ADO_PROJECT="<yourProject>"
-$Env:YourPrefix="<yourPrefix>"
+   $Env:ADO_PROJECT="<yourProject>"
+   $Env:YourPrefix="<yourPrefix>"
 
-$Env:ControlPlaneSubscriptionID="<YourControlPlaneSubscriptionID>"
-$Env:DevSubscriptionID="<YourDevSubscriptionID>"
+   $Env:ControlPlaneSubscriptionID="<YourControlPlaneSubscriptionID>"
+   $Env:DevSubscriptionID="<YourDevSubscriptionID>"
 
 ```
 > [!NOTE]
@@ -58,11 +59,11 @@ Once the variables are defined run the following script to create the service pr
 
 ```powershell
 
-Invoke-WebRequest -Uri https://raw.githubusercontent.com/Azure/sap-automation/experimental/deploy/scripts/update_devops_credentials.ps1 -OutFile .\configureDevOps.ps1 ; .\configureDevOps.ps1 
+Invoke-WebRequest -Uri https://raw.githubusercontent.com/Azure/sap-automation/main/deploy/scripts/update_devops_credentials.ps1 -OutFile .\configureDevOps.ps1 ; .\configureDevOps.ps1
 
 ```
 
-## Manual Configuration
+## Manual configuration of Azure DevOps Services for the SAP Deployment Automation Framework
 
 ### Create a new project
 
@@ -76,7 +77,7 @@ Open (https://dev.azure.com) and create a new project by clicking on the _New Pr
 Record the URL of the project.
 ### Import the repository
 
-Start by importing the SAP Deployment Automation Framework GitHub repository into Azure Repos. 
+Start by importing the SAP Deployment Automation Framework GitHub repository into Azure Repos.
 
 Navigate to the Repositories section and choose Import a repository, import the 'https://github.com/Azure/sap-automation.git' repository into Azure DevOps. For more info, see [Import a repository](/azure/devops/repos/git/import-git-repository?view=azure-devops&preserve-view=true)
 
@@ -85,14 +86,14 @@ If you're unable to import a repository, you can create the 'sap-automation' rep
 ### Create the repository for manual import
 
 > [!NOTE]
-> Only do this step if you are unable to import the repository directly. 
+> Only do this step if you are unable to import the repository directly.
 
-Create the 'sap-automation' repository by navigating to the 'Repositories' section in 'Project Settings' and clicking the _Create_ button. 
+Create the 'sap-automation' repository by navigating to the 'Repositories' section in 'Project Settings' and clicking the _Create_ button.
 
 Choose the repository type 'Git' and provide a name for the repository, for example 'sap-automation'.
 ### Cloning the repository
 
-In order to provide a more comprehensive editing capability of the content, you can clone the repository to a local folder and edit the contents locally. 
+In order to provide a more comprehensive editing capability of the content, you can clone the repository to a local folder and edit the contents locally.
 Clone the repository to a local folder by clicking the  _Clone_ button in the Files view in the Repos section of the portal. For more info, see [Cloning a repository](/azure/devops/repos/git/clone?view=azure-devops#clone-an-azure-repos-git-repo&preserve-view=true)
 
 :::image type="content" source="./media/automation-devops/automation-repo-clone.png" alt-text="Picture showing how to clone the repository":::
@@ -101,7 +102,7 @@ Clone the repository to a local folder by clicking the  _Clone_ button in the Fi
 
 You can also download the content from the SAP Deployment Automation Framework repository manually and add it to your local clone of the Azure DevOps repository.
 
-Navigate to 'https://github.com/Azure/SAP-automation' repository and download the repository content as a ZIP file by clicking the _Code_ button and choosing _Download ZIP_. 
+Navigate to 'https://github.com/Azure/SAP-automation' repository and download the repository content as a ZIP file by clicking the _Code_ button and choosing _Download ZIP_.
 
 Copy the content from the zip file to the root folder of your local clone.
 
@@ -117,7 +118,7 @@ Select the source control icon and provide a message about the change, for examp
    > In order to ensure that your configuration files are not overwritten by changes in the SAP Deployment Automation Framework, store them in a separate folder hierarchy.
 
 
-Create a top level folder called 'WORKSPACES', this folder will be the root folder for all the SAP deployment configuration files. Create the following folders in the 'WORKSPACES' folder: 'DEPLOYER', 'LIBRARY', 'LANDSCAPE' and 'SYSTEM'. These will contain the configuration files for the different components of the SAP Deployment Automation Framework. 
+Create a top level folder called 'WORKSPACES', this folder will be the root folder for all the SAP deployment configuration files. Create the following folders in the 'WORKSPACES' folder: 'DEPLOYER', 'LIBRARY', 'LANDSCAPE' and 'SYSTEM'. These will contain the configuration files for the different components of the SAP Deployment Automation Framework.
 
 Optionally you may copy the sample configuration files from the 'samples/WORKSPACES' folders to the WORKSPACES folder you created, this will allow you to experiment with sample deployments.
 
@@ -130,13 +131,13 @@ The automation framework optionally provisions a web app as a part of the contro
 # [Linux](#tab/linux)
 Replace MGMT with your environment as necessary.
 ```bash
-echo '[{"resourceAppId":"00000003-0000-0000-c000-000000000000","resourceAccess":[{"id":"e1fe6dd8-ba31-4d61-89e7-88639da4683d","type":"Scope"}]}]' >> manifest.json 
+echo '[{"resourceAppId":"00000003-0000-0000-c000-000000000000","resourceAccess":[{"id":"e1fe6dd8-ba31-4d61-89e7-88639da4683d","type":"Scope"}]}]' >> manifest.json
 
 TF_VAR_app_registration_app_id=$(az ad app create --display-name MGMT-webapp-registration --enable-id-token-issuance true --sign-in-audience AzureADMyOrg --required-resource-access @manifest.json --query "appId" | tr -d '"')
 
 echo $TF_VAR_app_registration_app_id
 
-az ad app credential reset --id $TF_VAR_app_registration_app_id --append --query "password" 
+az ad app credential reset --id $TF_VAR_app_registration_app_id --append --query "password"
 
 rm manifest.json
 ```
@@ -149,7 +150,7 @@ $TF_VAR_app_registration_app_id=(az ad app create --display-name MGMT-webapp-reg
 
 echo $TF_VAR_app_registration_app_id
 
-az ad app credential reset --id $TF_VAR_app_registration_app_id --append --query "password" 
+az ad app credential reset --id $TF_VAR_app_registration_app_id --append --query "password"
 
 del manifest.json
 ```
@@ -160,7 +161,7 @@ Save the app registration ID and password values for later use.
 
 ## Create Azure Pipelines
 
-Azure Pipelines are implemented as YAML files and they're stored in the 'deploy/pipelines' folder in the repository. 
+Azure Pipelines are implemented as YAML files and they're stored in the 'deploy/pipelines' folder in the repository.
 ## Control plane deployment pipeline
 
 Create the control plane deployment pipeline by choosing _New Pipeline_ from the Pipelines section, select 'Azure Repos Git' as the source for your code. Configure your Pipeline to use an existing Azure Pipelines YAML File. Specify the pipeline with the following settings:
@@ -295,7 +296,7 @@ The pipelines use a custom task to run Ansible. The custom task can be installed
 The pipelines use a custom task to perform cleanup activities post deployment. The custom task can be installed from [Post Build Cleanup](https://marketplace.visualstudio.com/items?itemName=mspremier.PostBuildCleanup). Install it to your Azure DevOps organization before running the pipelines.
 
 
-## Preparations for self-hosted agent    
+## Preparations for self-hosted agent
 
 
 1. Create an Agent Pool by navigating to the Organizational Settings and selecting _Agent Pools_ from the Pipelines section. Click the _Add Pool_ button and choose Self-hosted as the pool type. Name the pool to align with the workload zone environment, for example `DEV-WEEU-POOL`. Ensure _Grant access permission to all pipelines_ is selected and create the pool using the _Create_ button.
@@ -348,7 +349,7 @@ az pipelines variable-group create --name SDAF-General --variables ANSIBLE_HOST_
 
 ### Environment specific variables
 
-As each environment may have different deployment credentials you'll need to create a variable group per environment, for example 'SDAF-MGMT','SDAF-DEV', 'SDAF-QA'. 
+As each environment may have different deployment credentials you'll need to create a variable group per environment, for example 'SDAF-MGMT','SDAF-DEV', 'SDAF-QA'.
 
 Create a new variable group 'SDAF-MGMT' for the control plane environment using the Library page in the Pipelines section. Add the following variables:
 
@@ -394,7 +395,7 @@ Enter a Service connection name, for instance 'Connection to MGMT subscription'
 ## Permissions
 
 > [!NOTE]
-> Most of the pipelines will add files to the Azure Repos and therefore require pull permissions. Assign "Contribute" permissions to the 'Build Service' using the Security tab of the source code repository in the Repositories section in Project settings. 
+> Most of the pipelines will add files to the Azure Repos and therefore require pull permissions. Assign "Contribute" permissions to the 'Build Service' using the Security tab of the source code repository in the Repositories section in Project settings.
 
 :::image type="content" source="./media/automation-devops/automation-repo-permissions.png" alt-text="Picture showing repository permissions":::
 
@@ -407,7 +408,7 @@ Select the _Control plane deployment_ pipeline, provide the configuration names
 
 ### Configure the Azure DevOps Services self-hosted agent manually
 
-> [!NOTE] 
+> [!NOTE]
 >This is only needed if the Azure DevOps Services agent is not automatically configured. Please check that the agent pool is empty before proceeding.
 
 
@@ -421,7 +422,7 @@ Connect to the deployer by following these steps:
 
 1. The default username is *azureadm*
 
-1. Choose *SSH Private Key from Azure Key Vault* 
+1. Choose *SSH Private Key from Azure Key Vault*
 
 1. Select the subscription containing the control plane.
 
@@ -461,7 +462,7 @@ The agent will now be configured and started.
 
 ## Deploy the Control Plane Web Application
 
-Checking the "deploy the web app infrastructure" parameter when running the Control plane deployment pipeline will provision the infrastructure necessary for hosting the web app. The "Deploy web app" pipeline will publish the application's software to that infrastructure. 
+Checking the "deploy the web app infrastructure" parameter when running the Control plane deployment pipeline will provision the infrastructure necessary for hosting the web app. The "Deploy web app" pipeline will publish the application's software to that infrastructure.
 
 Wait for the deployment to finish. Once the deployment is complete, navigate to the Extensions tab and follow the instructions to finalize the configuration and update the 'reply-url' values for the app registration.
 
