Skip to content

Commit a9d1966

Browse files
authored
Merge pull request #197478 from yelevin/yelevin/sap-edits
Cleanup connector and content docs
2 parents 40af296 + 141eee5 commit a9d1966

File tree

2 files changed

+33
-30
lines changed

2 files changed

+33
-30
lines changed

articles/sentinel/sap/deploy-data-connector-agent-container.md

Lines changed: 31 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -37,27 +37,27 @@ Deployment of the SAP continuous threat monitoring solution is divided into the
3737

3838
## Data connector agent deployment overview
3939

40-
For the Continuous Threat Monitoring solution for SAP to operate correctly, data must first be ingested from SAP system into Microsoft Sentinel. To accomplish this, you need to deploy the Continuous Threat Monitoring solution for SAP data connector agent.
40+
For the Continuous Threat Monitoring solution for SAP to operate correctly, you must first get your SAP data into Microsoft Sentinel. To accomplish this, you need to deploy the solution's SAP data connector agent.
4141

42-
The data connector agent runs as a container on a Linux virtual machine (VM). This VM can be hosted either in Azure, in a third-party cloud, or on-premises. The recommended way for you to install and configure this container is by using a *kickstart* script, however you can choose to deploy the container [manually](?tabs=deploy-manually)
42+
The data connector agent runs as a container on a Linux virtual machine (VM). This VM can be hosted either in Azure, in a third-party cloud, or on-premises. We recommend that you install and configure this container using a *kickstart* script; however, you can choose to [deploy the container manually](?tabs=deploy-manually#deploy-the-data-connector-agent-container).
4343

44-
The agent connects to your SAP system to pull logs and other data from it, then sends those logs to your Microsoft Sentinel. To do this, the agent has to authenticate to your SAP system - that's why you created a user and a role for the agent in your SAP system in the previous step.
44+
The agent connects to your SAP system to pull logs and other data from it, then sends those logs to your Microsoft Sentinel workspace. To do this, the agent has to authenticate to your SAP system - that's why you created a user and a role for the agent in your SAP system in the previous step.
4545

4646
Your SAP authentication infrastructure, and where you deploy your VM, will determine how and where your agent configuration information, including your SAP authentication secrets, is stored. These are the options, in descending order of preference:
4747

4848
- An Azure Key Vault, accessed through an Azure **system-assigned managed identity**
4949
- An Azure Key Vault, accessed through an Azure AD **registered-application service principal**
5050
- A plaintext **configuration file**
5151

52-
If your **SAP authentication** infrastructure is based on **SNC**, using **X.509 certificates**, your only option is to use a configuration file. Select the **Configuration file** tab below for the instructions to deploy your agent container.
52+
If your **SAP authentication** infrastructure is based on **SNC**, using **X.509 certificates**, your only option is to use a configuration file. Select the [**Configuration file** tab below](?tabs=config-file#deploy-the-data-connector-agent-container) for the instructions to deploy your agent container.
5353

54-
If not, then your SAP configuration and authentication secrets can and should be stored in an [**Azure Key Vault**](../../key-vault/general/authentication.md). How you access your key vault depends on where your VM is deployed:
54+
If you're not using SNC, then your SAP configuration and authentication secrets can and should be stored in an [**Azure Key Vault**](../../key-vault/general/authentication.md). How you access your key vault depends on where your VM is deployed:
5555

56-
- **A container on an Azure VM** can use an Azure [system-assigned managed identity](../../active-directory/managed-identities-azure-resources/overview.md) to seamlessly access Azure Key Vault. Select the **Managed identity** tab below for the instructions to deploy your agent container using managed identity.
56+
- **A container on an Azure VM** can use an Azure [system-assigned managed identity](../../active-directory/managed-identities-azure-resources/overview.md) to seamlessly access Azure Key Vault. Select the [**Managed identity** tab below](?tabs=managed-identity#deploy-the-data-connector-agent-container) for the instructions to deploy your agent container using managed identity.
5757

5858
In the event that a system-assigned managed identity can't be used, the container can also authenticate to Azure Key Vault using an [Azure AD registered-application service principal](../../active-directory/develop/app-objects-and-service-principals.md), or, as a last resort, a configuration file.
5959

60-
- **A container on an on-premises VM**, or **a VM in a third-party cloud environment**, can't use Azure managed identity, but can authenticate to Azure Key Vault using an [Azure AD registered-application service principal](../../active-directory/develop/app-objects-and-service-principals.md). Select the **Registered application** tab below for the instructions to deploy your agent container.
60+
- **A container on an on-premises VM**, or **a VM in a third-party cloud environment**, can't use Azure managed identity, but can authenticate to Azure Key Vault using an [Azure AD registered-application service principal](../../active-directory/develop/app-objects-and-service-principals.md). Select the [**Registered application** tab below](?tabs=registered-application#deploy-the-data-connector-agent-container) for the instructions to deploy your agent container.
6161

6262
If for some reason a registered-application service principal can't be used, you can use a configuration file, though this is not preferred.
6363

@@ -66,12 +66,13 @@ If not, then your SAP configuration and authentication secrets can and should be
6666
# [Managed identity](#tab/managed-identity)
6767

6868
1. Transfer the [SAP NetWeaver SDK](https://aka.ms/sap-sdk-download) to the machine on which you want to install the agent.
69-
1.
69+
7070
1. Run the following command to **Create a VM** in Azure (substitute actual names for the `<placeholders>`):
7171

7272
```azurecli
7373
az vm create --resource-group <resource group name> --name <VM Name> --image Canonical:0001-com-ubuntu-server-focal:20_04-lts-gen2:latest --admin-username <azureuser> --public-ip-address "" --size Standard_D2as_v5 --generate-ssh-keys --assign-identity
7474
```
75+
7576
For more information, see [Quickstart: Create a Linux virtual machine with the Azure CLI](../../virtual-machines/linux/quick-create-cli.md).
7677
7778
> [!IMPORTANT]
@@ -128,7 +129,7 @@ If not, then your SAP configuration and authentication secrets can and should be
128129
wget -O sapcon-sentinel-kickstart.sh https://raw.githubusercontent.com/Azure/Azure-Sentinel/master/Solutions/SAP/sapcon-sentinel-kickstart.sh && bash ./sapcon-sentinel-kickstart.sh
129130
```
130131
131-
The script updates the OS components, installs the Azure CLI and Docker software and other required utilities (jq, netcat, curl), and prompts you for configuration parameter values. You can supply additional parameters to the script to minimize the amount of prompts, or to customize the container deployment. For more information on available command line options, see [Kickstart script reference](reference-kickstart.md)
132+
The script updates the OS components, installs the Azure CLI and Docker software and other required utilities (jq, netcat, curl), and prompts you for configuration parameter values. You can supply additional parameters to the script to minimize the amount of prompts or to customize the container deployment. For more information on available command line options, see [Kickstart script reference](reference-kickstart.md).
132133
133134
1. **Follow the on-screen instructions** to enter your SAP and key vault details and complete the deployment. When the deployment is complete, a confirmation message is displayed:
134135
@@ -149,7 +150,7 @@ If not, then your SAP configuration and authentication secrets can and should be
149150
# [Registered application](#tab/registered-application)
150151
151152
1. Transfer the [SAP NetWeaver SDK](https://aka.ms/sap-sdk-download) to the machine on which you want to install the agent.
152-
1.
153+
153154
1. Run the following command to **create and register an application**:
154155
155156
```azurecli
@@ -175,7 +176,8 @@ If not, then your SAP configuration and authentication secrets can and should be
175176
az keyvault create \
176177
--name <KeyVaultName> \
177178
--resource-group <KeyVaultResourceGroupName>
178-
```
179+
```
180+
179181
1. Copy the name of the (newly created or existing) key vault and the name of its resource group. You'll need these for assigning the key vault access policy and running the deployment script in the coming steps.
180182
181183
1. Run the following command to **assign a key vault access policy** to the registered application ID that you copied above (substitute actual names or values for the `<placeholders>`):
@@ -205,7 +207,7 @@ If not, then your SAP configuration and authentication secrets can and should be
205207
./sapcon-sentinel-kickstart.sh --keymode kvsi --appid aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa --appsecret ssssssssssssssssssssssssssssssssss -tenantid bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb -kvaultname <key vault name>
206208
```
207209
208-
The script updates the OS components, installs the Azure CLI and Docker software and other required utilities (jq, netcat, curl), and prompts you for configuration parameter values. You can supply additional parameters to the script to minimize the amount of prompts, or to customize the container deployment. For more information on available command line options, see [Kickstart script reference](reference-kickstart.md)
210+
The script updates the OS components, installs the Azure CLI and Docker software and other required utilities (jq, netcat, curl), and prompts you for configuration parameter values. You can supply additional parameters to the script to minimize the amount of prompts or to customize the container deployment. For more information on available command line options, see [Kickstart script reference](reference-kickstart.md).
209211
210212
1. **Follow the on-screen instructions** to enter the requested details and complete the deployment. When the deployment is complete, a confirmation message is displayed:
211213
@@ -226,7 +228,7 @@ If not, then your SAP configuration and authentication secrets can and should be
226228
# [Configuration file](#tab/config-file)
227229
228230
1. Transfer the [SAP NetWeaver SDK](https://aka.ms/sap-sdk-download) to the machine on which you want to install the agent.
229-
1.
231+
230232
1. Run the following commands to **download the deployment Kickstart script** from the Microsoft Sentinel GitHub repository and **mark it executable**:
231233
232234
```bash
@@ -240,7 +242,7 @@ If not, then your SAP configuration and authentication secrets can and should be
240242
./sapcon-sentinel-kickstart.sh --keymode cfgf
241243
```
242244
243-
The script updates the OS components, installs the Azure CLI and Docker software and other required utilities (jq, netcat, curl), and prompts you for configuration parameter values. You can supply additional parameters to the script to minimize the amount of prompts, or to customize the container deployment. For more information on available command line options, see [Kickstart script reference](reference-kickstart.md)
245+
The script updates the OS components, installs the Azure CLI and Docker software and other required utilities (jq, netcat, curl), and prompts you for configuration parameter values. You can supply additional parameters to the script to minimize the amount of prompts or to customize the container deployment. For more information on available command line options, see [Kickstart script reference](reference-kickstart.md).
244246
245247
1. **Follow the on-screen instructions** to enter the requested details and complete the deployment. When the deployment is complete, a confirmation message is displayed:
246248
@@ -258,45 +260,46 @@ If not, then your SAP configuration and authentication secrets can and should be
258260
259261
To view a list of the available containers use the command: `docker ps -a`.
260262
261-
# [Manual Deployment](#tab/deploy-manually)
263+
# [Manual deployment](#tab/deploy-manually)
262264
263265
1. Transfer the [SAP NetWeaver SDK](https://aka.ms/sap-sdk-download) to the machine on which you want to install the agent.
264266
265-
1. Install [Docker](https://www.docker.com/) on the VM, following [recommended deployment steps](https://docs.docker.com/engine/install/) for the chosen operating system
267+
1. Install [Docker](https://www.docker.com/) on the VM, following the [recommended deployment steps](https://docs.docker.com/engine/install/) for the chosen operating system.
266268
267-
1. Use the following commands (replacing <*SID*> with the name of the SAP instance) to create a folder to store the container configuration and metadata, and to download a sample systemconfig.ini file into that folder.
269+
1. Use the following commands (replacing `<SID>` with the name of the SAP instance) to create a folder to store the container configuration and metadata, and to download a sample systemconfig.ini file into that folder.
268270
269-
````bash
271+
```bash
270272
sid=<SID>
271273
mkdir -p /opt/sapcon/$sid
272274
cd /opt/sapcon/$sid
273275
wget https://raw.githubusercontent.com/Azure/Azure-Sentinel/master/Solutions/SAP/template/systemconfig.ini
274276
275-
````
277+
```
276278

277279
1. Edit the systemconfig.ini file to [configure the relevant settings](reference-systemconfig.md).
278280

279-
1. Run the following commands (replacing <*SID*> with the name of the SAP instance) to retrieve the latest container image, create a new container, and configure it to start automatically.
281+
1. Run the following commands (replacing `<SID>` with the name of the SAP instance) to retrieve the latest container image, create a new container, and configure it to start automatically.
280282

281-
````bash
283+
```bash
282284
sid=<SID>
283285
docker pull mcr.microsoft.com/azure-sentinel/solutions/sapcon:latest
284286
docker create -d --restart unless-stopped -v /opt/sapcon/$sid/:/sapcon-app/sapcon/config/system --name sapcon-$sid sapcon
285-
````
287+
```
286288

287-
1. Run the following command (replacing <*SID*> with the name of the SAP instance and <*sdkfilename*> with full filename of the SAP NetWeaver SDK) to copy the SDK into the container.
289+
1. Run the following command to copy the SDK into the container. Replace `<SID>` with the name of the SAP instance and `<sdkfilename>` with full filename of the SAP NetWeaver SDK.
288290

289-
````bash
291+
```bash
290292
sdkfile=<sdkfilename>
291293
sid=<SID>
292294
docker cp $sdkfile sapcon-$sid:/sapcon-app/inst/
293-
````
295+
```
296+
297+
1. Run the following command (replacing `<SID>` with the name of the SAP instance) to start the container.
294298

295-
1. Run the following command (replacing <*SID*> with the name of the SAP instance) to start the container.
296-
````bash
299+
```bash
297300
sid=<SID>
298301
docker start sapcon-$sid
299-
````
302+
```
300303

301304
---
302305

articles/sentinel/sap/deploy-sap-security-content.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Track your SAP solution deployment journey through this series of articles:
3939

4040
Deploy the [SAP security content](sap-solution-security-content.md) from the Microsoft Sentinel **Content hub** and **Watchlists** areas.
4141

42-
The **Microsoft Sentinel - Continuous Threat Monitoring for SAP** solution enables the SAP data connector to be displayed in the Microsoft Sentinel **Data connectors** area. The solution also deploys the **SAP - System Applications and Products** workbook and SAP-related analytics rules.
42+
Deploying the **Microsoft Sentinel - Continuous Threat Monitoring for SAP** solution causes the SAP data connector to be displayed in the Microsoft Sentinel **Data connectors** area. The solution also deploys the **SAP - System Applications and Products** workbook and SAP-related analytics rules.
4343

4444
To deploy SAP solution security content, do the following:
4545

@@ -51,7 +51,7 @@ To deploy SAP solution security content, do the following:
5151

5252
:::image type="content" source="./media/deploy-sap-security-content/sap-solution.png" alt-text="Screenshot of the 'Microsoft Sentinel - Continuous Threat Monitoring for SAP' solution pane." lightbox="media/deploy-sap-security-content/sap-solution.png":::
5353

54-
1. To launch the solution deployment wizard, select **Create**, and then enter the details of the Azure subscription, resource group, and Log Analytics workspace (the one which is used by Microsoft Sentinel) where you want to deploy the solution.
54+
1. To launch the solution deployment wizard, select **Create**, and then enter the details of the Azure subscription, resource group, and Log Analytics workspace (the one used by Microsoft Sentinel) where you want to deploy the solution.
5555

5656
1. Select **Next** to cycle through the **Data Connectors**, **Analytics**, and **Workbooks** tabs, where you can learn about the components that will be deployed with this solution.
5757

0 commit comments

Comments
 (0)