-
Notifications
You must be signed in to change notification settings - Fork 10.4k
Add Fleet as a method to deploy Cloudflare WARP client #17606
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
1cc7180
Create fleet.mdx
dherder 807d146
Added deployment instructions...
dherder 41755dc
Merge branch 'cloudflare:production' into production
dherder f7f906d
Apply suggestions from code review
crwaters16 55665e3
PCX content review
ranbel a3aa00f
Merge branch 'cloudflare:production' into production
dherder cf82468
add UI install instructions
ranbel 65c880c
add example Linux script
ranbel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
109 changes: 109 additions & 0 deletions
109
...e/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| --- | ||
| pcx_content_type: how-to | ||
| title: Fleet | ||
| sidebar: | ||
| order: 1 | ||
| --- | ||
|
|
||
| This guide covers how to deploy the Cloudflare WARP client using [Fleet](https://fleetdm.com/) device management software. | ||
|
|
||
| ## macOS | ||
|
|
||
| ### 1. Create a custom MDM file | ||
|
|
||
| 1. [Download](/cloudflare-one/static/mdm/CloudflareWARP.mobileconfig) an example `.mobileconfig` file. | ||
| 2. Modify the file with your desired [deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/). | ||
|
|
||
| ### 2. Upload MDM file to Fleet | ||
|
|
||
| 1. In the Fleet admin console, go to **Controls**. | ||
| 2. From the **Teams** dropdown, select the team (group of hosts) that requires Cloudflare WARP. | ||
| 3. Select **OS settings** > **Custom settings**. | ||
| 4. Select **Add profile** and upload the custom `.mobileconfig`. | ||
| 5. Select the hosts which require Cloudflare WARP: | ||
| - **All hosts**: Deploys WARP to all hosts in the team. | ||
| - **Custom**: Deploys WARP to a subset of the hosts in the team. Use [labels](https://fleetdm.com/guides/managing-labels-in-fleet#basic-article) to define the hosts that should be included or excluded. | ||
| 6. Select **Add profile**. | ||
|
|
||
| The defined hosts will immediately receive the deployment profile, but WARP is not yet installed. | ||
|
|
||
| ### 3. Download WARP package for macOS | ||
|
|
||
| Visit the [Download page](/cloudflare-one/connections/connect-devices/warp/download-warp/#macos) to review system requirements and download the installer for your operating system. | ||
|
|
||
| ### 4. Upload WARP package to Fleet | ||
|
|
||
| To add the WARP client installer package for distribution to your hosts enrolled in Fleet: | ||
|
|
||
| 1. In the Fleet admin console, go to **Software**. | ||
| 2. From the **Teams** dropdown, select the team (group of hosts) that requires Cloudflare WARP. | ||
| 3. Select **Add Software** and upload the `.pkg` file that was previously downloaded. | ||
|
|
||
| ### 5. Install WARP with Fleet | ||
|
|
||
| To deploy the uploaded `.pkg` file to your hosts, refer to the [Fleet documentation](https://fleetdm.com/guides/deploy-software-packages). | ||
|
|
||
| ### 6. Uninstall WARP with Fleet | ||
|
|
||
| To uninstall the Fleet-deployed WARP client: | ||
|
|
||
| 1. In the Fleet admin console, select the host that requires the WARP client to be uninstalled. | ||
| 2. Go to **Software** and search for `Cloudflare`. | ||
| 3. In **Actions**, select **Uninstall**. | ||
|
|
||
| ## Windows | ||
|
|
||
| ### 1. Download WARP package for Windows | ||
|
|
||
| Visit the [Download page](/cloudflare-one/connections/connect-devices/warp/download-warp/#windows) to review system requirements and download the installer for your operating system. | ||
|
|
||
| ### 2. Upload WARP package to Fleet | ||
|
|
||
| To add the WARP client installer package for distribution to your hosts enrolled in Fleet: | ||
|
|
||
| 1. In the Fleet admin console, go to **Software**. | ||
| 2. From the **Teams** dropdown, select the team (group of hosts) that requires Cloudflare WARP. | ||
| 3. Select **Add Software** and upload the `.msi` file that was previously downloaded. | ||
| 4. (Optional) To allow users to install WARP from Fleet Desktop, select **Self-service**. | ||
| 5. Select **Advanced options**. | ||
| 6. In **Install script**, replace the default script with the following: | ||
|
|
||
| ```bash | ||
| $logFile = "${env:TEMP}/fleet-install-software.log" | ||
|
|
||
| try { | ||
|
|
||
| $installProcess = Start-Process msiexec.exe ` | ||
| -ArgumentList "/quiet /norestart ORGANIZATION=your-team-name SUPPORT_URL=https://example.com /lv ${logFile} /i `"${env:INSTALLER_PATH}`"" ` | ||
| -PassThru -Verb RunAs -Wait | ||
|
|
||
| Get-Content $logFile -Tail 500 | ||
|
|
||
| Exit $installProcess.ExitCode | ||
|
|
||
| } catch { | ||
| Write-Host "Error: $_" | ||
| Exit 1 | ||
| } | ||
| ``` | ||
|
|
||
| Refer to [deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/) for a description of each argument. | ||
|
|
||
| ### 3. Install WARP with Fleet | ||
|
|
||
ranbel marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| To deploy the uploaded `.msi` file to your hosts, refer to the [Fleet documentation](https://fleetdm.com/guides/deploy-software-packages). | ||
|
|
||
| ### 4. Uninstall WARP with Fleet | ||
|
|
||
| To uninstall the Fleet-deployed WARP client: | ||
|
|
||
| 1. In the Fleet admin console, select the host that requires the WARP client to be uninstalled. | ||
| 2. Go to **Software** and search for `Cloudflare`. | ||
| 3. In **Actions**, select **Uninstall**. | ||
|
|
||
| ## Linux | ||
|
|
||
| Fleet allows you to [execute custom scripts](https://fleetdm.com/guides/scripts) on Linux hosts. Your script should: | ||
ranbel marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 1. Place an [`mdm.xml` file](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/#linux) in `/var/lib/cloudflare-warp/`. | ||
| 2. Run the [WARP installation commands](https://pkg.cloudflareclient.com/) for your specific Linux platform. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.