Merge pull request #195700 from KimForss/main

v-ccolin · web-flow · commit 4a962953f571 · 2022-04-21T10:11:11.000+01:00
Naming tweaks
diff --git a/articles/virtual-machines/workloads/sap/automation-configure-devops.md b/articles/virtual-machines/workloads/sap/automation-configure-devops.md
@@ -14,7 +14,7 @@ ms.service: virtual-machines-sap
 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. Record the URL of the project.
+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. 
 
 ## Create a new project
 
@@ -25,17 +25,13 @@ Open (https://dev.azure.com) and create a new project by clicking on the _New Pr
 > [!NOTE]
 > If you are unable to see _New Project_ ensure that you have permissions to create new projects in the organization.
 
+Record the URL of the project.
 ### Import the repository
 
 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)
 
-> [!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. 
-
-:::image type="content" source="./media/automation-devops/automation-repo-permissions.png" alt-text="Picture showing repository permissions":::
-
 If you are unable to import a repository, you can create the 'sap-automation' repository and manually import the content from the SAP Deployment Automation Framework GitHub repository to it.
 
 ### Create the repository for manual import
@@ -49,7 +45,7 @@ Choose the repository type 'Git' and provide a name for the repository, for exam
 ### 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. 
-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)
+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":::
 
@@ -68,27 +64,15 @@ Open the local folder in Visual Studio code, you should see that there are chang
 Select the source control icon and provide a message about the change, for example: "Import from GitHub" and press Cntr-Enter to commit the changes. Next select the _Sync Changes_ button to synchronize the changes back to the repository.
 ### Create configuration root folder
 
-Using your local clone 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'.
+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'.
 
 Optionally you may copy the sample configuration files from the 'samples/WORKSPACES' folders to the WORKSPACES folder you just created, this will allow you to experiment with sample deployments.
 
 Push the changes to Azure DevOps repos by selecting the source control icon and providing a message about the change, for example: "Import of sample configurations" and press Cntr-Enter to commit the changes. Next select the _Sync Changes_ button to synchronize the changes back to the repository.
 
-## Set up the Azure Pipelines
-
-To remove the Azure resources, you need an Azure Resource Manager service connection. For more information see [Manage service connections](/azure/devops/pipelines/library/service-endpoints?view=azure-devops&preserve-view=true)
-
-To create the service connection, go to Project settings and navigate to the Service connections setting in the Pipelines section.
-
-:::image type="content" source="./media/automation-devops/automation-create-service-connection.png" alt-text="Picture showing how to create a Service connection":::
-
-Choose _Azure Resource Manager_ as the service connection type and _Service principal (manual)_ as the authentication method. Enter the target subscription, typically the control plane subscription, and provide the service principal details (verify that they're valid using the _Verify_ button). For more information on how to create a service principal, see [Creating a Service Principal](automation-deploy-control-plane.md#prepare-the-deployment-credentials).
-
-Enter a Service connection name, for instance 'Connection to MGMT subscription' and ensure that the _Grant access permission to all pipelines_ checkbox is checked. Select _Verify and save_ to save the service connection.
-
 ## Create Azure Pipelines
 
-Azure Pipelines are implemented as YAML files and they're stored in the 'deploy/pipelines' folder in the GitHub repo. 
+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 Pipeline YAML File. Specify the pipeline with the following settings:
@@ -200,7 +184,7 @@ The pipelines use a custom task to perform cleanup activities post deployment. T
 
 ## Variable definitions
 
-The deployment pipelines are configured to use a set of predefined parameter values. I Azure DevOps the variables are defined using variable groups.
+The deployment pipelines are configured to use a set of predefined parameter values. In Azure DevOps the variables are defined using variable groups.
 
 ### Common variables
 
@@ -230,14 +214,14 @@ As each environment may have different deployment credentials you'll need to cre
 
 Create a new variable group 'SDAF-MGMT' for the control plane environment using the Library page in the Pipelines section. Add the following variables:
 
-| Variable              | Value                                          | Notes                                                    |
-| --------------------- | ---------------------------------------------- | -------------------------------------------------------- |
-| Agent                 | Either 'Azure Pipelines' or the name of the agent pool containing the deployer, for instance 'MGMT-WEEU-POOL' Note, this pool will be created in a later step. |
-| ARM_CLIENT_ID         | Enter the Service principal application id.          |                                                          |
-| ARM_CLIENT_SECRET     | Enter the Service principal password.                   | Change variable type to secret by clicking the lock icon |
-| ARM_SUBSCRIPTION_ID   | Enter the target subscription id.                       |                                                          |
-| ARM_TENANT_ID         | Enter the Tenant id for the service principal.              |                                                          |
-| AZURE_CONNECTION_NAME | Previously created connection name             |                                                          |
+| Variable              | Value                                           | Notes                                                    |
+| --------------------- | ----------------------------------------------- | -------------------------------------------------------- |
+| Agent                 | 'Azure Pipelines' or the name of the agent pool | Note, this pool will be created in a later step.         |
+| ARM_CLIENT_ID         | Enter the Service principal application id.     |                                                          |
+| ARM_CLIENT_SECRET     | Enter the Service principal password.           | Change variable type to secret by clicking the lock icon |
+| ARM_SUBSCRIPTION_ID   | Enter the target subscription id.               |                                                          |
+| ARM_TENANT_ID         | Enter the Tenant id for the service principal.  |                                                          |
+| AZURE_CONNECTION_NAME | Previously created connection name              |                                                          |
 | sap_fqdn              | SAP Fully Qualified Domain Name, for example sap.contoso.net | Only needed if Private DNS isn't used.                                           |
 
 Save the variables.
@@ -247,6 +231,24 @@ Save the variables.
 >
 > You can use the clone functionality to create the next environment variable group.
 
+## Create a service connection
+
+To remove the Azure resources, you need an Azure Resource Manager service connection. For more information, see [Manage service connections](/azure/devops/pipelines/library/service-endpoints?view=azure-devops&preserve-view=true)
+
+To create the service connection, go to Project settings and navigate to the Service connections setting in the Pipelines section.
+
+:::image type="content" source="./media/automation-devops/automation-create-service-connection.png" alt-text="Picture showing how to create a Service connection":::
+
+Choose _Azure Resource Manager_ as the service connection type and _Service principal (manual)_ as the authentication method. Enter the target subscription, typically the control plane subscription, and provide the service principal details. Validate the credentials using the _Verify_ button. For more information on how to create a service principal, see [Creating a Service Principal](automation-deploy-control-plane.md#prepare-the-deployment-credentials).
+
+Enter a Service connection name, for instance 'Connection to MGMT subscription' and ensure that the _Grant access permission to all pipelines_ checkbox is checked. Select _Verify and save_ to save the service connection.
+
+## 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. 
+
+:::image type="content" source="./media/automation-devops/automation-repo-permissions.png" alt-text="Picture showing repository permissions":::
 
 ## Register the Deployer as a self-hosted agent for Azure DevOps
 
@@ -268,11 +270,51 @@ You must use the Deployer as a [self-hosted agent for Azure DevOps](/azure/devop
 
    :::image type="content" source="./media/automation-devops/automation-new-pat.png" alt-text="Diagram showing the attributes of the Personal Access Token (PAT).":::
 
+## Deploy the Control Plane
+
+Newly created pipelines might not be visible in the default view. Select on recent tab and go back to All tab to view the new pipelines.
+
+Select the _Control plane deployment_ pipeline, provide the configuration names for the deployer and the SAP library and choose "Run" to deploy the control plane. 
+
+Wait for the deployment to finish.
+
 ## Configure the Azure DevOps Services self-hosted agent
 
-1. Connect to the Deployer using the steps described here [Using Visual Studio Code](automation-tools-configuration.md#configuring-visual-studio-code)
+Connect to the deployer by following these steps:
+
+1. Sign in to the [Azure portal](https://portal.azure.com).
+
+1. Navigate to the resource group containing the deployer virtual machine.
+
+1. Connect to the virtual machine using Azure Bastion.
+
+1. The default username is *azureadm*
+
+1. Choose *SSH Private Key from Azure Key Vault* 
+
+1. Select the subscription containing the control plane.
+
+1. Select the deployer key vault.
+
+1. From the list of secrets choose the secret ending with *-sshkey*.
 
-1. Open a Terminal window and run:
+1. Connect to the virtual machine.
+
+Run the following script to configure the deployer.
+
+```bash
+mkdir -p ~/Azure_SAP_Automated_Deployment
+
+cd ~/Azure_SAP_Automated_Deployment
+
+git clone https://github.com/Azure/sap-automation.git
+
+cd sap-automation/deploy/scripts
+
+./configure_deployer.sh
+```
+
+Reboot the deployer and reconnect and run the following script to set up the Azure DevOps agent.
 
 ```bash
 cd ~/Azure_SAP_Automated_Deployment/
@@ -285,12 +327,6 @@ Accept the license and when prompted for server URL, enter the URL you captured
 When prompted enter the application pool name, you created in the previous step. Accept the default agent name and the default work folder name.
 The agent will now be configured and started.
 
-## Run Azure Pipelines
-
-Newly created pipelines might not be visible in the default view. Select on recent tab and go back to All tab to view the new pipelines.
-
-Select the _Control plane deployment_ pipeline and choose "Run" to deploy the control plane.
-
 ## Next step
 
 > [!div class="nextstepaction"]
diff --git a/articles/virtual-machines/workloads/sap/automation-configure-sap-parameters.md b/articles/virtual-machines/workloads/sap/automation-configure-sap-parameters.md
@@ -56,7 +56,7 @@ The table below contains the parameters stored in the sap-parameters.yaml file,
 > | `NFS_provider`               | Defines what NFS backend to use, the options are 'AFS' for Azure Files NFS or 'ANF' for Azure NetApp files, 'NONE' for NFS from the SCS server or 'NFS' for an external NFS solution.  | Optional |
 > | `sap_mnt`                    | The NFS path for sap_mnt                                                                                         | Required   |
 > | `sap_trans`                  | The NFS path for sap_trans                                                                                       | Required   |
-> | `usr_sap_install_mountpoint' | The NFS path for usr/sap/install                                                                                 | Required   |
+> | `usr_sap_install_mountpoint` | The NFS path for usr/sap/install                                                                                 | Required   |
 
 ### Miscellaneous
 
diff --git a/articles/virtual-machines/workloads/sap/automation-naming-module.md b/articles/virtual-machines/workloads/sap/automation-naming-module.md
