Skip to content

Commit 4308fcf

Browse files
Merge pull request #314832 from Xelu86/sdaftoolconf
[Update] Configure external tools to use with SAP Deployment Automation Framework
2 parents 3c74bed + 3ae305b commit 4308fcf

1 file changed

Lines changed: 25 additions & 20 deletions

File tree

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
11
---
22
title: Configure external tools for SAP Deployment Automation Framework
3-
description: Learn how to configure external tools for using SAP Deployment Automation Framework.
3+
description: Learn how to configure Visual Studio Code to connect to the deployer virtual machine for SAP Deployment Automation Framework.
44
author: kimforss
55
ms.author: kimforss
6-
ms.reviewer: kimforss
7-
ms.date: 10/19/2022
8-
ms.topic: concept-article
6+
ms.date: 04/16/2026
7+
ms.topic: how-to
98
ms.service: sap-on-azure
109
ms.subservice: sap-automation
1110
ms.custom: sfi-image-nochange
1211
# Customer intent: As a developer configuring deployment tools for SAP, I want to set up Visual Studio Code with the necessary SSH credentials, so that I can efficiently connect to the deployer virtual machine and automate deployment tasks.
1312
---
1413

15-
# Configure external tools to use with SAP Deployment Automation Framework
14+
# Configure external tools for SAP Deployment Automation Framework
1615

17-
This article describes how to configure external tools to use SAP Deployment Automation Framework.
16+
This article describes how to configure Visual Studio Code to connect to the deployer virtual machine (VM) for SAP Deployment Automation Framework.
17+
18+
## Prerequisites
19+
20+
- A deployed SAP Deployment Automation Framework control plane, including a deployer VM. For more information, see [Deploy the control plane](deploy-control-plane.md).
21+
- [Visual Studio Code](https://code.visualstudio.com/) installed on your local machine.
22+
- Access to the deployer key vault in the Azure portal.
1823

1924
## Configure Visual Studio Code
2025

@@ -36,46 +41,46 @@ Follow these steps to configure Visual Studio Code.
3641

3742
1. Create a new file in Visual Studio Code and copy in the secret value.
3843

39-
1. Save the file where you keep SSH keys. For example, use `C:\\Users\\<your-username>\\.ssh\weeu_deployer.ssh`. Make sure that you save the file without an extension.
44+
1. Save the file where you keep SSH keys. For example, use `C:\Users\<your-username>\.ssh\weeu_deployer.ssh`. When you save the file, make sure the file type is set to **All Files** so the `.ssh` extension is preserved and no other extension like `.txt` is appended.
4045

41-
After you've downloaded the SSH key for the deployer, you can use it to connect to the deployer virtual machine.
46+
After you download the SSH key for the deployer, you can use it to connect to the deployer VM.
4247

4348
### Get the public IP of the deployer
4449

4550
1. Sign in to the [Azure portal](https://portal.azure.com).
4651

47-
1. Find the resource group for the deployer. The name starts with `MGMT-[REGION_CODE]-DEP00` unless you've deployed the control plane by using a custom naming convention. The contents of the deployer resource group should look like the following image.
52+
1. Find the resource group for the deployer. The name starts with `MGMT-[REGION_CODE]-DEP00` unless you deployed the control plane by using a custom naming convention. The contents of the deployer resource group should look like the following image.
4853

49-
:::image type="content" source="media/tutorial/deployer-resource-group.png" alt-text="Screenshot that shows deployer resources":::
54+
:::image type="content" source="media/tutorial/deployer-resource-group.png" alt-text="Screenshot that shows deployer resources in the Azure portal.":::
5055

5156
1. Find the public IP for the deployer. The name should end with `-pip`. Filter by **type**, if necessary.
5257

5358
1. Copy the IP address.
5459

5560
### Install the Remote Development extension
5661

57-
1. Open the **Extensions** window by selecting **View** > **Extensions** or by selecting Ctrl+Shift+X.
62+
1. Open the **Extensions** window by selecting **View** > **Extensions** or by pressing **Ctrl + Shift + X**.
5863

5964
1. Ensure that the **Remote Development** extension is installed.
6065

6166
### Connect to the deployer
6267

63-
1. Open the command palette by selecting **View** > **Command Palette** or by selecting Ctrl+Shift+P. Enter **Connect to host**. You can also select the icon in the lower-left corner of Visual Studio Code and select **Connect to host**.
68+
1. Open the command palette by selecting **View** > **Command Palette** or by pressing **Ctrl + Shift + P**. Enter **Connect to host**. You can also select the icon in the lower-left corner of Visual Studio Code and select **Connect to host**.
6469

6570
1. Select **Add New SSH Host**.
6671

67-
```bash
68-
ssh -i `C:\\Users\\<your-username>\\weeu_deployer.ssh` azureadm@<IP_Address>
69-
```
72+
```bash
73+
ssh -i "C:\Users\<your-username>\.ssh\weeu_deployer.ssh" azureadm@<IP_Address>
74+
```
7075

71-
> [!NOTE]
72-
> Change <IP_Address> to reflect the deployer IP.
76+
> [!NOTE]
77+
> Replace `<IP_Address>` with the deployer IP address.
7378
7479
1. Select **Connect**. Select **Linux** when you're prompted for the target operating system, and accept the remaining dialogs (such as key and trust).
7580

7681
1. When connected, select **Open Folder** and open the `/Azure_SAP_Automated_Deployment` folder.
7782

78-
## Next step
83+
## Related content
7984

80-
> [!div class="nextstepaction"]
81-
> [Configure the SAP workload zone](deploy-workload-zone.md)
85+
- [Configure the SAP workload zone](deploy-workload-zone.md)
86+
- [Deploy the control plane](deploy-control-plane.md)

0 commit comments

Comments
 (0)