Skip to content

Commit c581250

Browse files
authored
Merge pull request #296537 from paulth1/integrate-sap-cal
[AQ] edit pass: Integrate sap cal
2 parents 1f35091 + 1d799eb commit c581250

File tree

1 file changed

+66
-88
lines changed

1 file changed

+66
-88
lines changed
Lines changed: 66 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Integrating SAP Cloud Appliance Library with SAP Deployment Automation Framework
2+
title: Integrate SAP Cloud Appliance Library with SAP Deployment Automation Framework
33
description: Learn how to integrate SAP Cloud Appliance Library with SAP Deployment Automation Framework.
44
author: nnoaman
55
ms.author: nadeennoaman
@@ -9,145 +9,123 @@ ms.topic: how-to
99
ms.service: sap-on-azure
1010
ms.subservice: sap-automation
1111
---
12-
# Learn how to integrate SAP Cloud Appliance Library with the SAP Deployment Automation Framework
12+
# Integrate SAP Cloud Appliance Library with SAP Deployment Automation Framework
1313

14-
The integration between SAP Deployment Automation Framework (SDAF) and [SAP Cloud Appliance Library (CAL)](https://cal.sap.com/catalog#/solutions) offers a seamless experience for customers deploying infrastructure using SDAF's guided deployment, which can be done through Azure Pipelines or using the provided shell scripts.
14+
The integration between SAP Deployment Automation Framework (SDAF) and [SAP Cloud Appliance Library (CAL)](https://cal.sap.com/catalog#/solutions) offers a seamless experience for customers who want to deploy infrastructure by using SDAF's guided deployment. You can use Azure Pipelines or the provided shell scripts for deployment.
1515

16-
## Introduction to SAP Cloud Appliance Library (CAL)
16+
## Introduction to SAP Cloud Appliance Library
1717

18-
[SAP Cloud Appliance Library (CAL)](https://cal.sap.com/) is a cloud-based solution that simplifies the deployment and management of preconfigured SAP solutions on cloud platforms like Microsoft Azure. SAP CAL works by offering a catalog of preconfigured SAP software solutions (for example, S/4 HANA, SAP Business Suite), enabling customers to deploy these solutions on their cloud of choice without needing to manually install or configure software.
18+
[SAP Cloud Appliance Library](https://cal.sap.com/) is a cloud-based solution that simplifies the deployment and management of preconfigured SAP solutions on cloud platforms like Azure. SAP CAL offers a catalog of preconfigured SAP software solutions (for example, S/4 HANA and SAP Business Suite). You can deploy these solutions on your cloud of choice without needing to manually install or configure software.
1919

20-
## Overview of SAP Deployment Automation Framework (SDAF) and SAP Cloud Appliance Library (CAL) Integration
20+
## Overview of SDAF and SAP CAL integration
2121

22-
Following the infrastructure setup, customers can install SAP software using the [SAP CAL API for installation](https://api.sap.com/api/Workloads/overview) directly from Azure DevOps.
22+
After the infrastructure setup, you can install SAP software by using the [SAP CAL API for installation](https://api.sap.com/api/Workloads/overview) directly from Azure DevOps.
2323

2424
The benefits of this integration include:
2525

26-
- Access to the latest S/4 HANA installation, ensuring customers have the most up-to-date SAP software.
26+
- Access to the latest S/4 HANA installation to ensure that you have the most up-to-date SAP software.
27+
- The fastest installation experience with Azure and SAP CAL integration to streamline the deployment process.
28+
- Elimination of the need to maintain a bill of materials file for the SAP installation, which simplifies the management and setup process.
2729

28-
- The fastest installation experience with Azure and SAP Cloud Appliance Library (CAL) integration, streamlining the deployment process.
29-
30-
- Elimination of the need to maintain a Bill of Materials (BOM) file for Ansible, simplifying the management and setup process.
31-
32-
This integration brings together the best of Azure's infrastructure capabilities and SAP's software deployment solutions, providing a comprehensive and efficient approach to deploying SAP systems on Azure.
30+
This integration brings together the best of Azure infrastructure capabilities and SAP software deployment solutions. You gain a comprehensive and efficient approach to deploy SAP systems on Azure.
3331

3432
## Prerequisites
3533

36-
- Select one of the supported regions by SAP CAL \[West Europe, East US, and East US 2\] for the deployment.
37-
38-
- An [S-User](https://help.sap.com/docs/help/3e7fe88850cf4ee39d151949a990d8ca/6a92e3ffb3ee43e59c1e394566b4c085.html) is required.
39-
40-
- Set up Azure DevOps for the deployment framework, [Azure DevOps for SAP Deployment Automation Framework](configure-devops.md).
41-
42-
- Use Managed Identities for SDAF deployment.
43-
44-
- Set parameter "enable_rbac_authorization_for_keyvault = true" in the Landscape tfvars file.
45-
46-
- Set parameter "enable_sap_cal = true" in the System tfvars file.
47-
48-
## Register an application with Azure AD and create a service principal
49-
50-
1. Sign in to Azure portal.
34+
- Select one of the regions supported by SAP CAL (West Europe, East US, and East US 2) for the deployment.
35+
- Use an [S-User role](https://help.sap.com/docs/help/3e7fe88850cf4ee39d151949a990d8ca/6a92e3ffb3ee43e59c1e394566b4c085.html). This role is required.
36+
- Set up Azure DevOps for the deployment framework. For more information, see [Use SAP Deployment Automation Framework from Azure DevOps Services](configure-devops.md).
37+
- Use managed identities for the SDAF deployment.
38+
- Set the parameter `enable_rbac_authorization_for_keyvault = true` in the Landscape `tfvars` file.
39+
- Set the parameter `enable_sap_cal = true` in the System `tfvars` file.
5140

52-
2. Register an application with Azure AD with supported account types "Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant)"
41+
## Register an application with Microsoft Entra and create a service principal
5342

54-
3. Assign roles to the application (Contributor and User Access Administrator) for the desired subscription.
43+
1. Sign in to the [Azure portal](https://portal.azure.com).
5544

56-
4. Set up authentication with application certificate (recommended) or secret.
45+
1. Register an application with Microsoft Entra with supported account types by using **Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant)**.
5746

58-
- [About Azure Key Vault certificates](/azure/key-vault/certificates/about-certificates).
47+
1. Assign roles to the application (Contributor and User Access administrator) for the subscription that you want.
5948

60-
- [Certificate creation methods](/azure/key-vault/certificates/create-certificate).
49+
1. Set up authentication with an application certificate or a secret. We recommend that you use a certificate. For more information:
6150

62-
- Create a certificate in Key Vault using [Portal](/azure/key-vault/certificates/quick-create-portal), [Azure CLI](/azure/key-vault/certificates/quick-create-cli), [Azure PowerShell](/azure/key-vault/certificates/quick-create-powershell).
51+
- Read about [Azure Key Vault certificates](/azure/key-vault/certificates/about-certificates).
52+
- Learn about [certificate creation methods](/azure/key-vault/certificates/create-certificate).
53+
- Create a certificate in Key Vault by using the [Azure portal](/azure/key-vault/certificates/quick-create-portal), the [Azure CLI](/azure/key-vault/certificates/quick-create-cli), or [Azure PowerShell](/azure/key-vault/certificates/quick-create-powershell).
54+
- See the article [Azure authentication with service principal](/azure/developer/java/sdk/identity-service-principal-auth).
6355

64-
- [Azure authentication with service principal](/azure/developer/java/sdk/identity-service-principal-auth)
56+
1. Collect the following information for the next step: Subscription ID, Microsoft Entra tenant ID, application (client) ID, and client secret or certificate.
6557

66-
5. Collect the following information for the next step - Subscription ID, Microsoft Entra Tenant ID, Application (Client) ID, and Client Secret or Certificate.
58+
1. Go to **Authentication**, and under **Supported account types**, select **Any Microsoft Entra ID tenant - Multitenant**.
6759

68-
6. Navigate to "Authentication" and select "Any Microsoft Entra ID tenant--multitenant" in Supported account types.
60+
## Create an account in SAP CAL and enable API access
6961

70-
## Create account in SAP CAL and enable API access
62+
1. Go to the [CAL portal](https://cal.sap.com/catalog#/solutions) and sign in by using the S-User role.
7163

72-
1. Go to [CAL portal](https://cal.sap.com/catalog#/solutions) and log on using S-User.
64+
1. [Create the CAL account](https://help.sap.com/docs/SAP_CLOUD_APPLIANCE_LIBRARY/43df7ec18b5241f7bf9a8c9de5ba3361/042bb15ad2324c3c9b7974dbde389640.html) with the cloud provider as **Microsoft Azure** and the authorization type as **Authorization with Application**.
7365

74-
2. [Create CAL account](https://help.sap.com/docs/SAP_CLOUD_APPLIANCE_LIBRARY/43df7ec18b5241f7bf9a8c9de5ba3361/042bb15ad2324c3c9b7974dbde389640.html) with cloud provider as \"Microsoft Azure\" and Authorization Type as \"Authorization with Application\".
66+
1. Enter the subscription ID, the Microsoft Entra tenant ID, the application (client) ID, and the certificate or client secret to create the CAL account.
7567

76-
3. Provide Subscription ID, Microsoft Entra Tenant ID, Application (Client) ID, and Certificate or Client Secret to create the CAL account.
68+
:::image type="content" source="./media/sap-cal-integration/sap-cal-account.png" alt-text="Screenshot that shows how to create an SAP CAL account." lightbox="./media/sap-cal-integration/sap-cal-account.png":::
7769

78-
:::image type="content" source="./media/sap-cal-integration/sap-cal-account.png" alt-text="Screenshot that shows how to create an SAP CAL account." lightbox="./media/sap-cal-integration/sap-cal-account.png":::
70+
1. After the CAL account is created, edit the account to enable API access. For more information, see [Activating API Access](https://help.sap.com/docs/SAP_CLOUD_APPLIANCE_LIBRARY/43df7ec18b5241f7bf9a8c9de5ba3361/7c4da18a888d4dfe8fc594d0e18072a8.html?q=API%20enable).
7971

80-
4. Once the CAL account is created, edit the account to enable API access. [Learn More](https://help.sap.com/docs/SAP_CLOUD_APPLIANCE_LIBRARY/43df7ec18b5241f7bf9a8c9de5ba3361/7c4da18a888d4dfe8fc594d0e18072a8.html?q=API%20enable).
72+
> [!NOTE]
73+
> You must activate the product from which you want to deploy a workload for the SAP Cloud Appliance Library account that will use this API. Then accept the Terms and Conditions for this product. For more information, see [Activating Solutions](https://help.sap.com/docs/SAP_CLOUD_APPLIANCE_LIBRARY/43df7ec18b5241f7bf9a8c9de5ba3361/90627702612e45709e696a258af51c76.html?q=API%20enable).
8174
82-
> [!NOTE]
83-
> You have to activate the product from which you want to deploy a workload for the SAP Cloud Appliance Library account that will use this API and accept the Terms and Conditions for this product. For more information, see [Activating Solutions](https://help.sap.com/docs/SAP_CLOUD_APPLIANCE_LIBRARY/43df7ec18b5241f7bf9a8c9de5ba3361/90627702612e45709e696a258af51c76.html?q=API%20enable).
75+
:::image type="content" source="./media/sap-cal-integration/sap-cal-enable-api-access.png" alt-text="Screenshot that shows how to enable SAP CAL API access." lightbox="./media/sap-cal-integration/sap-cal-enable-api-access.png":::
8476

85-
:::image type="content" source="./media/sap-cal-integration/sap-cal-enable-api-access.png" alt-text="Screenshot that shows how to enable SAP CAL API Access." lightbox="./media/sap-cal-integration/sap-cal-enable-api-access.png":::
77+
1. After API access is enabled for the account, wait for a moment until the key vault is created. Then collect the key vault name for the next step.
8678

87-
5. Once API access is enabled for the account, wait for a moment until the Key Vault is created, then collect the Key Vault name for the next step.
88-
89-
:::image type="content" source="./media/sap-cal-integration/sap-cal-key-vault-name.png" alt-text="Screenshot that shows how to copy SAP CAL Azure Key Vault Name." lightbox="./media/sap-cal-integration/sap-cal-key-vault-name.png":::
79+
:::image type="content" source="./media/sap-cal-integration/sap-cal-key-vault-name.png" alt-text="Screenshot that shows how to copy the SAP CAL Azure Key Vault name." lightbox="./media/sap-cal-integration/sap-cal-key-vault-name.png":::
9080

9181
> [!IMPORTANT]
92-
> This created Key Vault stores the generated CAL end points and client secret used for obtaining OAuth tokens.
82+
> This key vault stores the generated CAL endpoints and client secret that are used to obtain OAuth tokens.
9383
9484
## Step-by-step guide
9585

96-
Here's a step-by-step guide for installing SAP S/4 HANA with SAP CAL Installation API integrated into SDAF:
97-
98-
1. Deploy Infrastructure from SDAF:
99-
100-
- Detailed instructions for Infrastructure creation for an SAP system with SDAF using Managed Identity (MSI) are [here](/azure/sap/automation/configure-devops?tabs=linux)
101-
102-
- Set parameter "enable_rbac_authorization_for_keyvault = true" in the Landscape tfvars file.
86+
Here's a step-by-step guide for installing SAP S/4 HANA with the SAP CAL Installation API integrated into SDAF:
10387

104-
- Assign Key Vault Administrator role to the application for SDAF Workload Zone Key Vault.
105-
106-
- You should add SAP BTP outbound IP addresses for Europe (Rot) region in SDAF Workload Zone Key Vault. [Can be found here:] (https://help.sap.com/docs/btp/sap-btp-neo-environment/regions-and-hosts-available-for-neo-environment).
88+
1. Deploy infrastructure from SDAF:
10789

108-
- Set parameter "enable_sap_cal = true" in the System tfvars file.
90+
- See the instructions for infrastructure creation for an SAP system with SDAF by using managed identity in [Use SAP Deployment Automation Framework from Azure DevOps Services](/azure/sap/automation/configure-devops?tabs=linux).
91+
- Set the parameter `enable_rbac_authorization_for_keyvault = true` in the Landscape `tfvars` file.
92+
- Assign the Key Vault administrator role to the application for the SDAF workload zone key vault.
93+
- Add the SAP BTP outbound IP addresses for the Europe (Rot) region in the SDAF workload zone key vault. For more information, see [Regions and Hosts Available for the Neo Environment](https://help.sap.com/docs/btp/sap-btp-neo-environment/regions-and-hosts-available-for-neo-environment).
94+
- Set the parameter `enable_sap_cal = true` in the System `tfvars` file.
10995

110-
2. After the system deployment, update sap-parameters.yaml file with the CAL Key Vault.
96+
1. After the system deployment, update the *sap-parameters.yaml* file with the CAL key vault.
11197

112-
:::image type="content" source="./media/sap-cal-integration/sap-cal-parameters.png" alt-text="Screenshot that shows sap-parameters.yaml file." lightbox="./media/sap-cal-integration/sap-cal-parameters.png":::
98+
:::image type="content" source="./media/sap-cal-integration/sap-cal-parameters.png" alt-text="Screenshot that shows the sap-parameters.yaml file." lightbox="./media/sap-cal-integration/sap-cal-parameters.png":::
11399

100+
1. Run the **SAP installation using SAP-CAL** pipeline:
114101

115-
3. Run "SAP installation using SAP-CAL" pipeline:
102+
1. After you add the CAL key vault in `sap_parameters`, select the SAP CAL product name from the dropdown menu.
116103

117-
1. After adding the CAL Key Vault in sap_parameters, select the SAP CAL Product Name from the drop-down menu
104+
1. Select **Run** to begin the installation process.
118105

119-
1. Press 'Run' to begin the installation process.
120-
121-
:::image type="content" source="./media/sap-cal-integration/sap-cal-run-pipeline.png" alt-text="Screenshot that shows how to run Azure DevOps SAP installation using SAP-CAL Pipeline." lightbox="./media/sap-cal-integration/sap-cal-run-pipeline.png":::
106+
:::image type="content" source="./media/sap-cal-integration/sap-cal-run-pipeline.png" alt-text="Screenshot that shows how to run the Azure DevOps SAP installation by using the SAP-CAL pipeline." lightbox="./media/sap-cal-integration/sap-cal-run-pipeline.png":::
122107

123108
## Track the installation
124109

125-
You can go to the [CAL portal](https://cal.sap.com/catalog#/appliances) to track installation and get detailed information about steps and errors if any.
126-
110+
To track the installation and get detailed information about steps and any errors, go to the [CAL portal](https://cal.sap.com/catalog#/appliances).
127111

128-
## SAP Cloud Appliance Library (CAL) API Documentation
112+
## SAP Cloud Appliance Library API documentation
129113

130-
The CAL installation API documentation is available [here](https://api.sap.com/api/Workloads/path/createSystemExt)
114+
The CAL installation API documentation is available on the [SAP Business Accelerator Hub](https://api.sap.com/api/Workloads/path/createSystemExt).
131115

132-
## Workflow for SDAF - CAL API integration
116+
## Workflow for SDAF: CAL API integration
133117

134-
The workflow/process diagram for the installation of S/4 HANA with CAL API is available [here](https://caldocs.hana.ondemand.com/caldocs/help/External_to_CAL_infrastructure.pdf).
118+
The workflow/process diagram for the installation of S/4 HANA with the CAL API is available in the article on [software provisioning of S/4 HANA](https://caldocs.hana.ondemand.com/caldocs/help/External_to_CAL_infrastructure.pdf).
135119

136120
## Support
137121

138-
- For any questions about the integration experience of SAL CAL and
139-
SDAF, reach out to '<[email protected]>'.
140-
141-
- For help on issues with the installation, you can create a support
142-
request with SAP CAL on [Report An Issue Dashboard - SAP for
143-
Me](https://me.sap.com/createIssue/0).
144-
145-
- Please raise the request for the component: 'BC-VCM-PSD' in
146-
order for the request to reach the SAP CAL team.
122+
- For questions about the integration experience of SAP CAL and SDAF, contact <[email protected]>.
123+
- For help on issues with installation, create a support request with SAP CAL on [Report an Issue Dashboard - SAP for Me](https://me.sap.com/createIssue/0).
124+
125+
Raise the request for the component `BC-VCM-PSD` so that the request reaches the SAP CAL team.
147126

148-
## Next steps
127+
## Related content
149128

150-
> [!div class="nextstepaction"]
151-
> - [Get started with the deployment automation framework](get-started.md)
152-
> - [Plan for the automation framework](plan-deployment.md)
153-
> - [Configure Azure DevOps for the automation framework](configure-devops.md)
129+
- [Get started with SAP Deployment Automation Framework](get-started.md)
130+
- [Plan your deployment of the SAP automation framework](plan-deployment.md)
131+
- [Configure Azure DevOps for the automation framework](configure-devops.md)

0 commit comments

Comments
 (0)