Elgato_dark/fleet

Fork 0

mirror of https://github.com/fleetdm/fleet synced 2026-05-04 13:59:01 +00:00

Luke Heath fae3dec60f

Set software as experimental in yaml docs (#21602 )

2024-08-27 14:09:07 -05:00

23 KiB

Raw Blame History

YAML files

Use Fleet's best practice GitOps workflow to manage your computers as code.

To learn how to set up a GitOps workflow see the Fleet GitOps repo.

File structure

default.yml- File where you define the queries, policies, controls, and agent options for all hosts. If you're using Fleet Premium, this file updates queries and policies that run on all hosts ("All teams"). Controls and agent options are defined for hosts on "No team."
teams/ - Folder where you define your teams in Fleet. These teams/team-name.yml files define the controls, queries, policies, and agent options for hosts assigned to the specified team. Teams are available in Fleet Premium.
lib/ - Folder where you define policies, queries, configuration profiles, scripts, and agent options. These files can be referenced in top level keys in the default.yml file and the files in the teams/ folder.
.github/workflows/workflow.yml - The GitHub workflow file where you can add environment variables.

The following files are responsible for running the GitHub action. Most users don't need to edit these files.

gitops.sh - The bash script that applies the latest configuration to Fleet. This script is used in the GitHub action file.
.github/gitops-action/action.yml - The GitHub action that runs gitops.sh. This action is used in the GitHub workflow file. It can also be used in other workflows.

Configuration options

The following are the required keys in the default.yml and any teams/team-name.yml files:

name: # Only teams/team-name.yml. To edit a team's name, change `name` but don't change the filename.
policies:
queries:
agent_options:
controls:
software:
org_settings: # Only default.yml
team_settings: # Only teams/team-name.yml

policies
queries
agent_options
controls
software
org_settings and team_settings

policies

Polcies can be specified inline in your default.yml file or teams/team-name.yml files. They can also be specified in separate files in your lib/ folder.

Options

For possible options, see the parameters for the Add policy API endpoint.

Example

Inline

default.yml or teams/team-name.yml

policies:
  - name: macOS - Enable FileVault
    description: This policy checks if FileVault (disk encryption) is enabled.
    resolution: As an IT admin, turn on disk encryption in Fleet.
    query: SELECT 1 FROM filevault_status WHERE status = 'FileVault is On.';
    platform: darwin
    critical: false
    calendar_event_enabled: false

Separate file

lib/policies-name.policies.yml

- name: macOS - Enable FileVault
  description: This policy checks if FileVault (disk encryption) is enabled.
  resolution: As an IT admin, turn on disk encryption in Fleet.
  query: SELECT 1 FROM filevault_status WHERE status = 'FileVault is On.';
  platform: darwin
  critical: false
  calendar_event_enabled: false
- name: macOS - Disable guest account
  description: This policy checks if the guest account is disabled.
  resolution: An an IT admin, deploy a macOS, login window profile with the DisableGuestAccount option set to true.
  query: SELECT 1 FROM managed_policies WHERE domain='com.apple.loginwindow' AND username = '' AND name='DisableGuestAccount' AND CAST(value AS INT) = 1;
  platform: darwin
  critical: false
  calendar_event_enabled: false

default.yml or teams/team-name.yml

policies:
  - path: ../lib/policies-name.policies.yml
# path is relative to default.yml or teams/team-name.yml

queries

Queries can be specified inline in your default.yml file or teams/team-name.yml files. They can also be specified in separate files in your lib/ folder.

Note that the team_id option isn't supported in GitOps.

Options

For possible options, see the parameters for the Create query API endpoint.

Example

Inline

default.yml or teams/team-name.yml

queries:
  - name: Collect failed login attempts
    description: Lists the users at least one failed login attempt and timestamp of failed login. Number of failed login attempts reset to zero after a user successfully logs in.
    query: SELECT users.username, account_policy_data.failed_login_count, account_policy_data.failed_login_timestamp FROM users INNER JOIN account_policy_data using (uid) WHERE account_policy_data.failed_login_count > 0;
    platform: darwin,linux,windows
    interval: 300
    observer_can_run: false
    automations_enabled: false

Separate file

lib/queries-name.queries.yml

- name: Collect failed login attempts
  description: Lists the users at least one failed login attempt and timestamp of failed login. Number of failed login attempts reset to zero after a user successfully logs in.
  query: SELECT users.username, account_policy_data.failed_login_count, account_policy_data.failed_login_timestamp FROM users INNER JOIN account_policy_data using (uid) WHERE account_policy_data.failed_login_count > 0;
  platform: darwin,linux,windows
  interval: 300
  observer_can_run: false
  automations_enabled: false
- name: Collect USB devices
  description: Collects the USB devices that are currently connected to macOS and Linux hosts.
  query: SELECT model, vendor FROM usb_devices;
  platform: darwin,linux
  interval: 300
  observer_can_run: true
  automations_enabled: false

default.yml or teams/team-name.yml

queries:
  - path: ../lib/queries-name.queries.yml
# path is relative to default.yml or teams/team-name.yml

agent_options

Agent options can be specified inline in your default.yml file or teams/team-name.yml files. They can also be specified in separate files in your lib/ folder.

See "Agent configuration" to find all possible options.

Example

Inline

default.yml or teams/team-name.yml

agent_options:
  config:
    decorators:
      load:
        - SELECT uuid AS host_uuid FROM system_info;
        - SELECT hostname AS hostname FROM system_info;
    options:
      disable_distributed: false
      distributed_interval: 10
      distributed_plugin: tls
      distributed_tls_max_attempts: 3
      logger_tls_endpoint: /api/osquery/log
      logger_tls_period: 10
      pack_delimiter: /

Separate file

lib/agent-options.yml

config:
  decorators:
    load:
      - SELECT uuid AS host_uuid FROM system_info;
      - SELECT hostname AS hostname FROM system_info;
  options:
    disable_distributed: false
    distributed_interval: 10
    distributed_plugin: tls
    distributed_tls_max_attempts: 3
    logger_tls_endpoint: /api/osquery/log
    logger_tls_period: 10
    pack_delimiter: /

default.yml or teams/team-name.yml

We want - for policies and queries because it’s an array. Agent Options we do not use - for path.

queries:
  path: ../lib/agent-options.yml
# path is relative to default.yml or teams/team-name.yml

controls

The controls section allows you to configure scripts and device management (MDM) features in Fleet.

scripts is a list of paths to macOS, Windows, or Linux scripts.
windows_enabled_and_configured specifies whether or not to turn on Windows MDM features (default: false). Can only be configured for all teams (default.yml).
enable_disk_encryption specifies whether or not to enforce disk encryption on macOS and Windows hosts (default: false).

Example

controls:
  scripts: 
    - path: ../lib/macos-script.sh 
    - path: ../lib/windows-script.ps1
    - path: ../lib/linux-script.sh
  windows_enabled_and_configured: true
  enable_disk_encryption: true # Available in Fleet Premium
  macos_updates: # Available in Fleet Premium
    deadline: "2023-06-13"
    minimum_version: 13.4.1
  windows_updates: # Available in Fleet Premium
    deadline_days: 5
    grace_period_days: 2
  macos_settings:
    custom_settings:
      - path: ../lib/macos-profile1.mobileconfig
        labels_exclude_any:
          - Label 1
      - path: ../lib/macos-profile2.json
        labels_include_all:
          - Label 2
  windows_settings:
    custom_settings
      - path: ../lib/windows-profile.xml
  macos_setup: # Available in Fleet Premium
    bootstrap_package: https://example.org/bootstrap_package.pkg
    enable_end_user_authentication: true
    macos_setup_assistant: ../lib/dep-profile.json
  macos_migration: # Available in Fleet Premium
    enable: true
    mode: voluntary
    webhook_url: https://example.org/webhook_handler
# paths are relative to default.yml or teams/team-name.yml

macos_updates

deadline specifies the deadline in the form of YYYY-MM-DD. The exact deadline time is at 04:00:00 (UTC-8) (default: "").
minimum_version specifies the minimum required macOS version (default: "").

windows_updates

deadline_days (default: null)
grace_period_days (default: null)

macos_settings and windows_settings

macos_settings.custom_settings is a list of paths to macOS configuration profiles (.mobileconfig) or declaration profiles (.json).
windows_settings.custom_settings is a list of paths to Windows configuration profiles (.xml).

Fleet supports adding GitHub environment variables in your configuration profiles. Use $ENV_VARIABLE format.

Use labels_include_all to only apply (scope) profiles to hosts that have all those labels or labels_exclude_any to apply profiles to hosts that don't have any of those labels.

macos_setup

The macos_setup section lets you control the end user migration workflow for macOS hosts that automatically enrolled to your old MDM solution.

bootstrap_package is the URL to a bootstap package. Fleet will download the bootstrap package (default: "").
enable_end_user_authentication specifies whether or not to require end user authentication when the user first sets up their macOS host.
macos_setup_assistant is a path to a custom automatic enrollment (DEP) profile (.json).

macos_migration

enable specifies whether or not to enable end user migration workflow (default: false)
mode specifies whether the end user initiates migration (voluntary) or they're nudged every 15-20 minutes to migrate (forced) (default: "").
webhook_url is the URL that Fleet sends a webhook to when the end user selects Start. Receive this webhook using your automation tool (ex. Tines) to unenroll your end users from your old MDM solution.

Can only be configure for all teams (default.yml).

software

Experimental feature. This feature is undergoing rapid improvement, which may result in breaking changes to the API or configuration surface. It is not recommended for use in automated workflows.

The software section allows you to configure packages and Apple App Store apps that you want to install on your hosts.

packages is a list of software packages (.pkg, .msi, .exe, or .deb) and software specific options.
app_store_apps is a list of Apple App Store apps.

Example

software:
  packages:
   - url: https://github.com/organinzation/repository/package-1.pkg
     install_script:
       path: /lib/crowdstrike-install.sh 
      pre_install_query: 
        path: /lib/check-crowdstrike-configuration-profile.queries.yml
      post_install_script:
        path: /lib/crowdstrike-post-install.sh 
      self_service: true
    - url: https://github.com/organinzation/repository/package-2.msi
  app_store_apps:
   - app_store_id: '1091189122'

packages

url specifies the URL at which the software is located. Fleet will download the software and upload it to S3 (default: "").
install_script.path specifies the command Fleet will run on hosts to install software. The default script is dependent on the software type (i.e. .pkg).
pre_install_query.path is the osquery query Fleet runs before installing the software. Software will be installed only if the query returns results (default: "").
post_install_script.path is the script Fleet will run on hosts after intalling software (default: "").
self_service specifies whether or not end users can install from Fleet Desktop > Self-service.

app_store_apps

app_store_id is the ID of the Apple App Store app. You can find this at the end of the app's App Store URL. For example, "Bear - Markdown Notes" URL is "https://apps.apple.com/us/app/bear-markdown-notes/id1016366447" and the app_store_id is 1016366447.

org_settings and team_settings

features

The features section of the configuration YAML lets you define what predefined queries are sent to the hosts and later on processed by Fleet for different functionalities.

additional_queries adds extra host details. This information will be updated at the same time as other host details and is returned by the API when host objects are returned (default: empty).
enable_host_users specifies whether or not Fleet collects user data from hosts (default: true).
enable_software_inventory specifies whether or not Fleet collects softwre inventory from hosts (default: true).

Example

org_settings:
  features:
    additional_queries:
      time: SELECT * FROM time
      macs: SELECT mac FROM interface_details
    enable_host_users: true
    enable_software_inventory: true

fleet_desktop

Direct end users to a custom URL when they select Transparency in the Fleet Desktop dropdown (default: https://fleetdm.com/transparency).

Can only be configured for all teams (org_settings).

Example

org_settings:
  fleet_desktop:
    transparency_url: "https://example.org/transparency"

host_expiry_settings

The host_expiry_settings section lets you define if and when hosts should be automatically deleted from Fleet if they have not checked in.

host_expiry_enabled (default: false)
host_expiry_window if a host has not communicated with Fleet in the specified number of days, it will be removed. Must be > 0 when host expiry is enabled (default: 0).

Example

org_settings:
  host_expiry_settings:
  	host_expiry_enabled: true
    host_expiry_window: 10

org_info

name is the name of your organization (default: "")
logo_url is a public URL of the logo for your organization (default: Fleet logo).
org_logo_url_light_background is a public URL of the logo for your organization that can be used with light backgrounds (default: Fleet logo).
contact_url is a URL that appears in error messages presented to end users (default: "https://fleetdm.com/company/contact")

Can only be configured for all teams (org_settings).

Example

org_settings:
  org_info:
    org_name: Fleet
    org_logo_url: https://example.com/logo.png
    org_logo_url_light_background: https://example.com/logo-light.png
    contact_url: https://fleetdm.com/company/contact

secrets

The secrets section defines the valid secrets that hosts can use to enroll to Fleet. Supply one of these secrets when generating the fleetd agent you'll use to enroll hosts. Learn more here.

Example

org_settings:
  secrets: 
  - $ENROLL_SECRET

server_settings

enable_analytics specifies whether or not to enable Fleet's usage statistics (default: true).
live_query_disabled disables the ability to run live queries (ad hoc queries executed via the UI or fleetctl) (default: false).
query_reports_disabled disables query reports and deletes existing repors (default: false).
query_report_cap sets the maximum number of results to store per query report before the report is clipped. If increasing this cap, we recommend enabling reports for one query at time and monitoring your infrastructure. (Default: 1000)
scripts_disabled blocks access to run scripts. Scripts may still be added in the UI and CLI (defaul: false).
server_url is the base URL of the Fleet instance (default: provided during Fleet setup)

Can only be configured for all teams (org_settings).

Example

org_settings:
server_settings:
  enable_analytics: true
  live_query_disabled: false
  query_reports_disabled: false
  scripts_disabled: false
  server_url: https://instance.fleet.com

sso_settings

The sso_settings section lets you define single sign-on (SSO) settings. Learn more about SSO in Fleet here.

enable_sso (default: false)
idp_name is the human-friendly name for the identity provider that will provide single sign-on authentication (default: "").
entity_id is the entity ID: a Uniform Resource Identifier (URI) that you use to identify Fleet when configuring the identity provider. It must exactly match the Entity ID field used in identity provider configuration (default: "").
metadata is the metadata (in XML format) provided by the identity provider. (default: "")
metadata_url is the URL that references the identity provider metadata. Only one of metadata or metadata_url is required (default: "").
enable_jit_provisioning specified whether or not to allow single sign-on login initiated by identity provider (default: false).
enable_sso_idp_login specifies whether or not to enables just-in-time user provisioning (default: false).

Can only be configured for all teams (org_settings).

Example

org_settings:
  sso_settings:
    enable_sso: true
    idp_name: SimpleSAML
    entity_id: https://example.com
    metadata: $SSO_METADATA
    enable_jit_provisioning: true # Available in Fleet Premium
    enable_sso_idp_login: true

integrations

The integrations section lets you define calendar events and ticket settings for failing policy and vulnerablity automations. Learn more about automations in Fleet here.

Example

org_settings:
  integrations:
    google_calendar:
      - api_key_json: $GOOGLE_CALENDAR_API_KEY_JSON
        domain: fleetdm.com
    jira:
      - url: https://example.atlassian.net
        username: user1
        api_token: $JIRA_API_TOKEN
        project_key: PJ1
    zendesk:
      - url: https://example.zendesk.com
        email: user1@example.com
        api_token: $ZENDESK_API_TOKEN
        group_id: 1234

For secrets, you can add GitHub environment variables

google_calendar

api_key_json is the contents of the JSON file downloaded when you create your Google Workspace service account API key (default: "").
domain is the primary domain used to identify your end user's work calendar (default: "").

jira

url is the URL of your Jira (default: "")
username is the username of your Jira account (default: "").
api_token is the Jira API token (default: "").
project_key is the project key location in your Jira project's URL. For example, in "jira.example.com/projects/EXMPL," "EXMPL" is the project key (default: "").

zendesk

url is the URL of your Zendesk (default: "")
username is the username of your Zendesk account (default: "").
api_token is the Zendesk API token (default: "").
group_idis found by selecting Admin > People > Groups in Zendesk. Find your group and select it. The group ID will appear in the search field.

webhook_settings

The webhook_settings section lets you define webhook settings for failing policy, vulnerability, and host status automations. Learn more about automations in Fleet here.

failing_policies_webhook

enable_failing_policies_webhook (default: false)
destination_url is the URL to POST to when the condition for the webhook triggers (default: "").
policy_ids is the list of policies that will trigger a webhook.
host_batch_size is the maximum number of hosts to batch in each webhook. A value of 0 means no batching (default: 0).

Example

org_settings:
  webhook_settings:
    failing_policies_webhook:
      enable_failing_policies_webhook: true
      destination_url: https://example.org/webhook_handler
      host_batch_size: 0
      policy_ids:
        - 1
        - 2
        - 3

host_status_webhook

enable_host_status_webhook (default: false)
destination_url is the URL to POST to when the condition for the webhook triggers (default: "").
days_count is the number of days that hosts need to be offline to count as part of the percentage (default: 0).
host_percentage is the percentage of hosts that need to be offline to trigger the webhook. (default: 0).

Example

org_settings:
  webhook_settings:
    host_status_webhook:
      enable_host_status_webhook: true
      destination_url: https://example.org/webhook_handler
      days_count: 7
      host_percentage: 25

vulnerabilities_webhook

enable_vulnerabilities_webhook (default: false)
destination_url is the URL to POST to when the condition for the webhook triggers (default: "").
days_count is the number of days that hosts need to be offline to count as part of the percentage (default: 0).
host_batch_size is the maximum number of hosts to batch in each webhook. A value of 0 means no batching (default: 0).

Example

org_settings:
  webhook_settings:
    vulnerabilities_webhook:
      enable_vulnerabilities_webhook: true
      destination_url: https://example.org/webhook_handler
      host_batch_size: 0

Can only be configured for all teams (org_settings).

mdm

The mdm section lets you enable MDM features in Fleet.

apple_bm_default_team - is name of the team that macOS hosts in Apple Business Manager automatically enroll to when they're first set up. If empty, hosts will enroll to "No team" (default: "").

Example

org_settings:
  mdm:
    apple_bm_default_team: "Workstations" # Available in Fleet Premium

Can only be configured for all teams (org_settings).

23 KiB Raw Blame History Unescape Escape

YAML files

File structure

Configuration options

policies

Options

Example

Inline

Separate file

queries

Options

Example

Inline

Separate file

agent_options

Example

Inline

Separate file

controls

Example

macos_updates

windows_updates

macos_settings and windows_settings

macos_setup

macos_migration

software

Example

packages

app_store_apps

org_settings and team_settings

features

Example

fleet_desktop

Example

host_expiry_settings

Example

org_info

Example

secrets

Example

server_settings

Example

sso_settings

Example

integrations

Example

google_calendar

jira

zendesk

webhook_settings

failing_policies_webhook

Example

host_status_webhook

Example

vulnerabilities_webhook

Example

mdm

Example

23 KiB

Raw Blame History