deepblue/windows-itpro-docs
1
0
Fork 0
mirror of https://github.com/MicrosoftDocs/windows-itpro-docs.git synced 2025-05-15 06:47:21 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Update linux-install-with-puppet.md

Browse Source 
@mjcaparas 

Edit complete! Again, we're using "install" and "deploy" interchangeably. In most cases, I think "install" is more accurate and seems to be what's used in the code, but "deploy" has a slightly different meaning and might be more accurate in some instances, so it would be good to get crisper with the usage. 

TOC titles don't need to map verbatim to H1 headings, but if you stick with the TOC version, use "Puppet-based installation" (or Puppet-based deployment if switching to that language throughout).

On line 172: do you mean "2 if the device is not yet onboarded"?

Thanks!
Kelly
This commit is contained in:
Kelly Baker 2020-02-22 20:15:16 -08:00 committed by GitHub
parent 0197775aca
commit a3b27a212e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
windows/security/threat-protection/microsoft-defender-atp/linux-install-with-puppet.md
View File

@ -1,7 +1,7 @@
--- ---
title: Installing Microsoft Defender ATP for Linux with Puppet title: Install Microsoft Defender ATP for Linux with Puppet
ms.reviewer: ms.reviewer:
description: Describes how to install Microsoft Defender ATP for Linux, using Puppet. description: Describes how to install Microsoft Defender ATP for Linux using Puppet.
keywords: microsoft, defender, atp, linux, installation, deploy, uninstallation, puppet, ansible, linux, redhat, ubuntu, debian, sles, suse, centos keywords: microsoft, defender, atp, linux, installation, deploy, uninstallation, puppet, ansible, linux, redhat, ubuntu, debian, sles, suse, centos
search.product: eADQiWindows 10XVcnh search.product: eADQiWindows 10XVcnh
search.appverid: met150 search.appverid: met150
@ -18,16 +18,16 @@ ms.collection: M365-security-compliance
ms.topic: conceptual ms.topic: conceptual
--- ---
# Puppet based deployment # Install Microsoft Defender ATP for Linux with Puppet
**Applies to:** **Applies to:**
- [Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP) for Linux](microsoft-defender-atp-linux.md) - [Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP) for Linux](microsoft-defender-atp-linux.md)
This topic describes how to deploy Microsoft Defender ATP for Linux through Puppet. A successful deployment requires the completion of all of the following steps: This topic describes how to install Microsoft Defender ATP for Linux using Puppet. A successful installation requires the completion of all of the following tasks:
- [Download onboarding packages](#download-onboarding-package) - [Download the onboarding package](#download-the-onboarding-package)
- [Create Puppet manifest](#create-puppet-manifest) - [Create Puppet manifest](#create-a-puppet-manifest)
- [Deployment](#deployment) - [Deployment](#deployment)
- [Check onboarding status](#check-onboarding-status) - [Check onboarding status](#check-onboarding-status)
@ -35,15 +35,15 @@ This topic describes how to deploy Microsoft Defender ATP for Linux through Pupp
Before you get started, please see [the main Microsoft Defender ATP for Linux page](microsoft-defender-atp-linux.md) for a description of prerequisites and system requirements for the current software version. Before you get started, please see [the main Microsoft Defender ATP for Linux page](microsoft-defender-atp-linux.md) for a description of prerequisites and system requirements for the current software version.
In addition, for Puppet deployment, you need to be familiar with Puppet administration tasks, have Puppet configured, and know how to deploy packages. Puppet has many ways to complete the same task. These instructions assume availability of supported Puppet modules such as *apt* to help deploy the package. Your organization might use a different workflow. Please refer to the [Puppet documentation](https://puppet.com/docs) for details. In addition, for Puppet deployment, you need to be familiar with Puppet administration tasks, have Puppet configured, and know how to deploy packages. Puppet has many ways to complete the same task. These instructions assume availability of supported Puppet modules, such as *apt* to help deploy the package. Your organization might use a different workflow. Please refer to the [Puppet documentation](https://puppet.com/docs) for details.
## Download onboarding package ## Download the onboarding package
Download the onboarding package from Microsoft Defender Security Center: Download the onboarding package from Microsoft Defender Security Center:
1. In Microsoft Defender Security Center, go to **Settings > Machine Management > Onboarding**. 1. In Microsoft Defender Security Center, go to **Settings > Machine Management > Onboarding**.
2. In the first drop down, select **Linux Server** as the operating system. In the second drop down, select **Your preferred Linux configuration management tool** as the deployment method. 2. In the first drop-down menu, select **Linux Server** as the operating system. In the second drop-down menu, select **Your preferred Linux configuration management tool** as the deployment method.
3. Click on **Download onboarding package**. Save the file as WindowsDefenderATPOnboardingPackage.zip. 3. Select **Download onboarding package**. Save the file as WindowsDefenderATPOnboardingPackage.zip.
![Microsoft Defender Security Center screenshot](images/atp-portal-onboarding-linux-2.png) ![Microsoft Defender Security Center screenshot](images/atp-portal-onboarding-linux-2.png)
@ -58,11 +58,11 @@ Download the onboarding package from Microsoft Defender Security Center:
inflating: mdatp_onboard.json inflating: mdatp_onboard.json
``` ```
## Create Puppet manifest ## Create a Puppet manifest
You need to create a Puppet manifest for deploying Microsoft Defender ATP for Linux to devices managed by a Puppet server. This example makes use of *apt* module available from puppetlabs and assumes that apt module has been installed on your Puppet server. You need to create a Puppet manifest for deploying Microsoft Defender ATP for Linux to devices managed by a Puppet server. This example makes use of the *apt* module available from puppetlabs, and assumes that the apt module has been installed on your Puppet server.
Create a folders *install_mdatp/files* and *install_mdatp/manifests* under the modules folder of your Puppet installation. This typically is located in */etc/puppetlabs/code/environments/production/modules* on your Puppet server. Copy the mdatp_onboard.json file created in above step to *install_mdatp/files* folder. Create a *init.pp* file which contains the deployment instructions. Create the folders *install_mdatp/files* and *install_mdatp/manifests* under the modules folder of your Puppet installation. This is typically located in */etc/puppetlabs/code/environments/production/modules* on your Puppet server. Copy the mdatp_onboard.json file created above to the *install_mdatp/files* folder. Create an *init.pp* file that contains the deployment instructions:
```bash ```bash
$ pwd $ pwd
@ -78,7 +78,7 @@ install_mdatp
### Contents of `install_mdatp/manifests/init.pp` ### Contents of `install_mdatp/manifests/init.pp`
Microsoft Defender ATP for Linux can be deployed from one of the following channels (denoted below as *[channel]*): *insider-fast* or *prod*. Each of these channels corresponds to a Linux software repository. Microsoft Defender ATP for Linux can be installed from one of the following channels (denoted below as *[channel]*): *insider-fast* or *prod*. Each of these channels corresponds to a Linux software repository.
The choice of the channel determines the type and frequency of updates that are offered to your device. Devices in *insider-fast* can try out new features before devices in *prod*. The choice of the channel determines the type and frequency of updates that are offered to your device. Devices in *insider-fast* can try out new features before devices in *prod*.
@ -86,7 +86,7 @@ In order to preview new features and provide early feedback, it is recommended t
Note your distribution and version and identify the closest entry for it under `https://packages.microsoft.com/config/`. Note your distribution and version and identify the closest entry for it under `https://packages.microsoft.com/config/`.
In the below commands, replace *[distro]* and *[version]* with the information identified in the previous step. In the below commands, replace *[distro]* and *[version]* with the information you've identified:
> [!NOTE] > [!NOTE]
> In case of Oracle EL and CentOS 8, replace *[distro]* with “rhel”. > In case of Oracle EL and CentOS 8, replace *[distro]* with “rhel”.
@ -130,7 +130,7 @@ class install_mdatp {
## Deployment ## Deployment
Include the above manifest in your site.pp file. Include the above manifest in your site.pp file:
```bash ```bash
$ cat /etc/puppetlabs/code/environments/production/manifests/site.pp $ cat /etc/puppetlabs/code/environments/production/manifests/site.pp
@ -141,7 +141,7 @@ node "default" {
Enrolled agent devices periodically poll the Puppet Server, and install new configuration profiles and policies as soon as they are detected. Enrolled agent devices periodically poll the Puppet Server, and install new configuration profiles and policies as soon as they are detected.
## Monitoring Puppet deployment ## Monitor Puppet deployment
On the agent machine, you can also check the onboarding status by running: On the agent machine, you can also check the onboarding status by running:
@ -155,7 +155,7 @@ orgId : "[your organization identifier]"
- **licensed**: This confirms that the device is tied to your organization. - **licensed**: This confirms that the device is tied to your organization.
- **orgId**: your Microsoft Defender ATP organization identifier. - **orgId**: This is your Microsoft Defender ATP organization identifier.
## Check onboarding status ## Check onboarding status
@ -169,16 +169,16 @@ The above command prints `1` if the product is onboarded and functioning as expe
If the product is not healthy, the exit code (which can be checked through `echo $?`) indicates the problem: If the product is not healthy, the exit code (which can be checked through `echo $?`) indicates the problem:
- 1 if the device is not yet onboarded - 1 if the device is not yet onboarded.
- 3 if the connection to the daemon cannot be established - 3 if the connection to the daemon cannot be established.
## Logging installation issues ## Log installation issues
See [Logging installation issues](linux-resources.md#logging-installation-issues) for more information on how to find the automatically generated log that is created by the installer when an error occurs. See [Logging installation issues](linux-resources.md#logging-installation-issues) for more information on how to find the automatically generated log that is created by the installer when an error occurs.
## Uninstallation ## Uninstallation
Create a module *remove_mdatp* similar to *install_mdatp* with following contents in *init.pp* file Create a module *remove_mdatp* similar to *install_mdatp* with the following contents in *init.pp* file:
```bash ```bash
class remove_mdatp { class remove_mdatp {