mirror of https://github.com/empayre/fleet.git synced 2024-11-06 17:05:18 +00:00

MDM docs: Custom macOS settings (#11713 )

Changes address the feedback below:

> Disk encryption docs should say that you shouldn’t use custom settings
to enforce disk encryption (prevent user from trying to do filevault via
imazing)

I decided not to call this out in the docs because this is handled by
the product. The UI (and CLI) show this error if the user tries to use
custom settings to enforce disk encryption:
![Screenshot 2023-05-16 at 9 48 59
AM](https://github.com/fleetdm/fleet/assets/47070608/d5f5de9b-f3c2-4b4f-b8a0-30fbf5292b9e)

> Custom settings docs says randomly that it only works for macOS.
Should be obvious. No need to state?

I removed sentence about Fleet only supporting macOS

2023-05-17 11:34:19 -07:00

4.1 KiB

Raw Blame History

Custom macOS settings

In Fleet you can enforce custom settings on your macOS hosts using configuration profiles.

Enforce custom settings

To enforce custom settings, we will do the following steps:

Create a configuration profile with iMazing Profile editor
Upload the profiles to Fleet
Confirm the setting is enforced

Step 1: create a configuration profile

How to create a configuration profile with iMazing Profile Creator:

Download and install iMazing Profile Creator.
Open iMazing Profile Creator and select macOS in the top bar.
Find and choose the settings you'd like to enforce on your macOS hosts. Fleet recommends limiting the scope of the settings a single profile: only include settings from one tab in iMazing Profile Creator (ex. Restrictions tab). To enforce more settings, you can create and add additional profiles.
In iMazing Profile Creator, select the General tab. Enter a descriptive name in the Name field. When you add this profile to Fleet, Fleet will display this name in the Fleet UI.
In your top menu bar select File > Save As... and save your configuration profile. Make sure the file is saved as .mobileconfig.

Step 2: upload configuration profile to Fleet

In Fleet, you can upload configuration profiles using the Fleet UI or fleetctl command-line tool.

The Fleet UI method is a good start if you're just getting familiar with Fleet.

The fleetctl CLI method enables managing configuration profiles in a Git repository. This way you can enforce code review and benefit from Git's change history.

Fleet UI:

In the Fleet UI, head to the Controls > macOS settings > Custom settings page.
Choose which team you want to add the configuration profile to by selecting the desired team in the teams dropdown in the upper left corner. Teams are available in Fleet Premium.
Select Upload and choose your configuration profile. After your configuration profile is uploaded to Fleet, Fleet will apply the profile to all macOS hosts in the selected team. Thereafter, the profile will be applied to new macOS hosts that enroll to that team.

fleetctl CLI:

Choose which team you want to add the configuration profile to.

In this example, we'll add a configuration profile to the "Workstations (canary)" team so that the setting only gets enforced on hosts assigned to this team.

Create a workstations-canary-config.yaml file:

apiVersion: v1
kind: team
spec:
  team:
    name: Workstations (canary)
    mdm:
      macos_settings:
        custom_settings:
          - /path/to/configuration_profile.mobileconfig
    ...

Learn more about team configurations options here.

To enforce settings on hosts that aren't assigned to a team ("No team"), we'll need to create an fleet-config.yaml file:

apiVersion: v1
kind: config
spec:
  mdm:
    macos_settings:
      custom_settings:
        - /path/to/configuration_profile.mobileconfig
  ...

Learn more about configuration options for hosts that aren't assigned to a team here.

Add an mdm.macos_settings.custom_settings key to your YAML document. This key accepts an array of paths to your configuration profiles.
Run the fleetctl apply -f workstations-canary-config.yml command to upload the configuration profiles to Fleet. Note that this will override any configuration profiles added using the Fleet UI method.

Step 3: confirm the setting is enforced

In the Fleet UI, head to the Controls > macOS settings tab.
In the top box, with "Latest," "Pending," and "Failing" statuses, click each status to view a list hosts:

Latest: hosts that applied the latest settings.
Pending: hosts that will apply the latest settings when the hosts come online.
Failing: hosts that are failing to apply the latest settings.

In the list of hosts, click on an individual host and click the macOS settings item to see the status for a specific setting.

4.1 KiB Raw Blame History