Fleet desktop v1 announcement (#6723)

* remove reference to fleet desktop being in beta

* update how to generate a new Fleet Desktop installer

* document --disable-update and --desktop-channel flags

* new file for Fleet Desktop

* fleet desktop custom transparency link explanation

* docs for installing and upgrading Fleet Desktop

* fleet desktop out of beta announcement blog

* images

* copy edits

* convert headers to sentence case

* incorporate copy changes

* Updated images and meta tags

- I updated the images, and renamed to match our image naming conventions
- I added the article meta tags

* Update Fleet-desktop.md

* Specify Fleet Desktop document order

* Update to fleet-desktop-says-hello-world.md

- I added a screencast showing how to remediate a failing policy with Fleet Desktop
- I added inline styles so that the video fills the container width and renders correctly on mobile.
- I re-jigged "self remediation" and "Scope transparency" as H3 tags.

* address some typos and style changes

* update meta tag

* remove single quotes

* Update publishing date fleet-desktop-says-hello-world

Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
Co-authored-by: Andrew Baker <89049099+DrewBakerfdm@users.noreply.github.com>
This commit is contained in:
Mo Zhu
2022-08-02 12:19:57 -05:00
committed by GitHub
co-authored by Mike Thomas Andrew Baker
parent 52583e240a
commit e2399efbc5
6 changed files with 89 additions and 15 deletions
@@ -0,0 +1,45 @@
# Fleet Desktop says “Hello, world!”
![Fleet Desktop v1 preview](../website/assets/images/articles/fleet-desktop-says-hello-world-cover-1600x900@2x.jpg)
We are thrilled to announce that Fleet Desktop is out of Beta! Over the past few months, weve dogfooded Fleet Desktop internally and validated its usability and scalability. It is now ready for production deployment across your host fleet.
## What is Fleet Desktop?
Fleet Desktop is a menubar icon available on macOS, Windows, and Linux. At its core, Fleet Desktop gives your end users visibility into the security posture of their machine. This unlocks two key benefits:
### Self remediation
When Fleet finds a host is out of compliance with one or more policies configured in Fleet, Fleet Desktop will display the red error icon and list the number of failing policies, as seen in the screenshot above.
When users click on “My device,” they will be shown which policies are failing and steps for resolving the policy failures.
By exposing this information, your end users are informed and empowered to self-remediate security issues without requiring time and attention from your IT or security team.
<div class="video-container" style="position: relative; width: 100%; padding-bottom: 56.25%; margin-top: 24px; margin-bottom: 40px;">
<iframe class="video" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border: 0;" src="https://www.youtube.com/embed/hik4YnCLU58" allowfullscreen></iframe>
</div>
### Scope transparency
A frequent question from end users is a half-joking half-concerned, “so you can see everything I do, right?” With our scope transparency feature, we clear up that ambiguity and tension between end users and IT teams.
When a Fleet Desktop user clicks “Transparency,” they will be taken to [https://fleetdm.com/transparency](https://fleetdm.com/transparency).
This page explains what Fleet and osquery can and cannot see on their computers. We also link to an article on dos and donts for a work computer.
Fleet Premium users can point this link to an internal resource to customize the content for their organizations situation.
## Deploying Fleet Desktop
To install Fleet Desktop on your end users machines, you will need to generate a new osquery installer and run it on end users machines. Learn more [here](https://fleetdm.com/docs/using-fleet/adding-hosts#fleet-desktop).
Once installed, Fleet Desktops versioning is thereafter managed by our agent manager, Orbit.
## Wrapping up
Over the past few months, weve been dogfooding Fleet Desktop internally. We think your end users will appreciate the information about the security posture of their device and feel empowered
to self-remediate any outstanding security issues. Your IT and security team will appreciate the results.
<meta name="category" value="announcements">
<meta name="authorGitHubUsername" value="zhumo">
<meta name="authorFullName" value="Mo Zhu">
<meta name="publishedOn" value="2022-08-02">
<meta name="articleTitle" value="Fleet Desktop says “Hello, world!”">
<meta name="articleImageUrl" value="../website/assets/images/articles/fleet-desktop-says-hello-world-cover-1600x900@2x.jpg">
+5 -3
View File
@@ -1,8 +1,10 @@
# Self-managed agent updates
Fleet's [Orbit osquery updater](https://github.com/fleetdm/fleet/tree/main/orbit) by default utilizes the public Fleet update repository.
[Orbit](https://github.com/fleetdm/fleet/tree/main/orbit) will periodically check the public Fleet update repository and update itself, Fleet Desktop, and/or osquery
if it detects a later version.
For users who would like to self-manage an update server, this capability is available with a Fleet Premium subscription.
To override this behavior, users can set a channel for each component or disable updates altogether. Visit [Adding Hosts](https://fleetdm.com/docs/using-fleet/adding-hosts#fleet-desktop) to learn more.
Alternatively, users with a Fleet Premium subscription can self-manage an update server.
## Securing updates
@@ -158,4 +160,4 @@ fleetctl updates rotate targets
After the key(s) have been rotated, publish the repository in the same fashion as any other update.
<meta name="pageOrderInSection" value="400">
<meta name="pageOrderInSection" value="400">
+13 -12
View File
@@ -38,29 +38,28 @@ The above command should be run on a macOS device as notarizing and signing of m
Also, remember to replace both `AC_USERNAME` and `AC_PASSWORD` environment variables with your Apple ID and a valid [app-specific](https://support.apple.com/en-ca/HT204397) password, respectively.
### Fleet Desktop
### Including Fleet Desktop
> Fleet Desktop requires a Fleet version of 4.12.0 and above. To check your Fleet version, select
> the avatar on the right side of the top bar and select **My account**. Your Fleet version is
> displayed below the **Get API token** button.
How to install Fleet Desktop on your hosts:
Hosts without Fleet Desktop currently installed require a new installer to be generated and run on the target host.
How to generate an installer that includes Fleet Desktop in the Fleet UI:
1. On the top bar in the Fleet UI, select **Hosts > Add hosts**.
2. Select the **Include Fleet Desktop** checkbox.
3. Select the clipboard icon to copy the `fleetctl package` command.
4. In your terminal application, paste and run the copied command.
When you install the generated osquery installer on a host, Fleet Desktop will be installed on this
host and the Fleet icon will appear on the host's menu bar.
Alternatively, you can generate an installer that includes Fleet Desktop in `fleetctl package` by appending the `--fleet-desktop` flag.
Read more about the Self-service and Scope transparency features included with Fleet Desktop in [the
4.15.0 release article](https://fleetdm.com/releases/fleet-4.15.0).
> Fleet Desktop is supported on macOS, Windows, and Linux. Check out the supported Linux distributions
> and versions [here
> on GitHub](https://github.com/fleetdm/fleet/issues/5684#issuecomment-1123906753).
Fleet Desktop is supported on macOS, Windows, and Linux. Check out the supported Linux distributions
and versions [here
on GitHub](https://github.com/fleetdm/fleet/issues/5684#issuecomment-1123906753).
Fleet Desktop is currently in beta. Check out the remaining work to bring Fleet Desktop out of beta [here on GitHub](https://github.com/fleetdm/fleet/issues/5684).
Once installed on the target host, Fleet Desktop will be managed by Orbit. To learn more about Orbit updates, see [here](https://fleetdm.com/docs/deploying/fleetctl-agent-updates).
To prevent this auto-update behavior, you can turn off auto-updates via the `--disable-updates` flag or you can set a specific channel using the `--desktop-channel` flag.
### Adding multiple hosts
@@ -94,7 +93,7 @@ The following command-line flags allow you to configure an osquery installer fur
|Flag | Options|
|------|--------|
| --type | **Required** - Type of package to build.<br> Options: `pkg`(macOS),`msi`(Windows), `deb`(Debian based Linux), `rpm`(RHEL, CentOS, etc.)|
|--fleet-desktop | Include Fleet Desktop. Fleet Desktop is currently in beta. |
|--fleet-desktop | Include Fleet Desktop. |
|--enroll-secret | Enroll secret for authenticating to Fleet server |
|--fleet-url | URL (`host:port`) of Fleet server |
|--fleet-certificate | Path to server certificate bundle |
@@ -104,8 +103,10 @@ The following command-line flags allow you to configure an osquery installer fur
| --service | Install osquery with a persistence service (launchd, systemd, etc.) (default: `true`) |
|--sign-identity | Identity to use for macOS codesigning |
| --notarize | Whether to notarize macOS packages (default: `false`) |
| --disable-updates | Disable auto updates on the generated package (default: false) |
|--osqueryd-channel | Update channel of osqueryd to use (default: `stable`) |
|--orbit-channel | Update channel of Orbit to use (default: `stable`) |
|--desktop-channel | Update channel of desktop to use (default: `stable`) |
|--update-url | URL for update server (default: `https://tuf.fleetctl.com`) |
|--update-roots | Root key JSON metadata for update server (from fleetctl updates roots) |
| --debug | Enable debug logging (default: `false`) |
+26
View File
@@ -0,0 +1,26 @@
# Fleet Desktop
- [Installing Fleet Desktop](#installing-fleet-desktop)
- [Upgrading Fleet Desktop](#upgrading-fleet-desktop)
- [Custom Transparency Link](#custom-transparency-link)
Fleet Desktop is a menubar icon available on macOS, Windows, and Linux.
At its core, Fleet Desktop gives your end users visibility into the security posture of their machine. This unlocks two key benefits:
* Self-remediation: end users can see which policies they are failing and resolution steps, reducing the need for IT and security teams to intervene
* Scope Transparency: end users can see what the Fleet agent can do on their machines, eliminating ambiguity between end users and their IT and security teams
## Installing Fleet Desktop
For information on how to install Fleet Desktop, visit: [Adding Hosts](https://fleetdm.com/docs/using-fleet/adding-hosts#fleet-desktop).
## Upgrading Fleet Desktop
Once installed, Fleet Desktop will be automatically updated via Orbit. To learn more, visit: [Self-managed agent updates](https://fleetdm.com/docs/deploying/fleetctl-agent-updates#self-managed-agent-updates).
## Custom transparency link
For organizations with complex security postures, they can direct end users to a resource of their choice to serve custom content.
> The custom transparency link is only available for users with Fleet Premium
To turn on the custom transparency link, in the Fleet GUI, click on your profile in the top right, select "Settings."
In the settings page, under "Organization Settings" select "Fleet Desktop." Use the "Custom transparency URL" text input to specify the custom URL.
<meta name="pageOrderInSection" value="450">
Binary file not shown.

After

Width:  |  Height:  |  Size: 235 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 396 KiB