Skip to content

Commit

Permalink
Docs v4.59.0 (#23693)
Browse files Browse the repository at this point in the history
  • Loading branch information
@rachaelshaw
rachaelshaw authored Nov 12, 2024
1 parent c4c1b65 commit f5598e0
Show file tree
Hide file tree
Showing 5 changed files with 401 additions and 17 deletions.
8 changes: 2 additions & 6 deletions articles/role-based-access.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ GitOps is an API-only and write-only role that can be used on CI/CD pipelines.
| Edit [MDM settings](https://fleetdm.com/docs/using-fleet/mdm-macos-settings) | | | | ✅ | ✅ |
| Edit [MDM settings for teams](https://fleetdm.com/docs/using-fleet/mdm-macos-settings) | | | | ✅ | ✅ |
| View all [MDM settings](https://fleetdm.com/docs/using-fleet/mdm-macos-settings) | | | | ✅ | ✅ |
| Edit setup experience (end user authentication, bootstrap package, Setup Assistant)\* | | | ✅ | ✅ | ✅ |
| Edit [macOS setup experience]([https://fleetdm.com/docs/](https://fleetdm.com/guides/macos-setup-experience#basic-article))\* | | | ✅ | ✅ | ✅ |
| Edit end user license agreement (EULA)\* | | | | ✅ | |
| Run scripts on hosts | | | ✅ | ✅ | |
| View saved scripts\* | ✅ | ✅ | ✅ | ✅ | |
Expand Down Expand Up @@ -163,11 +163,7 @@ Users with access to multiple teams can be assigned different roles for each tea
| Execute MDM commands on macOS and Windows hosts* | | | ✅ | ✅ | |
| View results of MDM commands executed on macOS and Windows hosts* | ✅ | ✅ | ✅ | ✅ | |
| Edit [team MDM settings](https://fleetdm.com/docs/using-fleet/mdm-macos-settings) | | | | ✅ | ✅ |
| View/download MDM macOS setup assistant | | | ✅ | ✅ | |
| Edit/upload MDM macOS setup assistant | | | ✅ | ✅ | ✅ |
| View metadata of MDM macOS bootstrap packages | | | ✅ | ✅ | |
| Edit/upload MDM macOS bootstrap packages | | | ✅ | ✅ | ✅ |
| Enable/disable MDM macOS setup end user authentication | | | ✅ | ✅ | ✅ |
| Edit [macOS setup experience]([https://fleetdm.com/docs/](https://fleetdm.com/guides/macos-setup-experience#basic-article))\* | | | ✅ | ✅ | ✅ |
| Run scripts on hosts | | | ✅ | ✅ | |
| View saved scripts | ✅ | ✅ | ✅ | ✅ | |
| Edit/upload saved scripts | | | ✅ | ✅ | |
Expand Down
31 changes: 27 additions & 4 deletions docs/Configuration/yaml-files.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ policies:
package_path: "../lib/linux-firefox.deb.package.yml"
```

`default.yml`, `teams/team-name.yml`, or `teams/no-team.yml`
`default.yml` (for policies that neither install software nor run scripts), `teams/team-name.yml`, or `teams/no-team.yml`

```yaml
policies:
Expand Down Expand Up @@ -241,6 +241,10 @@ controls:
bootstrap_package: https://example.org/bootstrap_package.pkg
enable_end_user_authentication: true
macos_setup_assistant: ../lib/dep-profile.json
script: ../lib/macos-setup-script.sh
software:
- app_store_id: '1091189122'
- package_path: ../lib/software/adobe-acrobat.software.yml
macos_migration: # Available in Fleet Premium
enable: true
mode: voluntary
Expand Down Expand Up @@ -284,6 +288,8 @@ The `macos_setup` section lets you control the out-of-the-box macOS [setup exper
- `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 (ADE) profile (.json).
- `script` is the path to a custom setup script to run after the host is first set up.
- `software` is a list of references to either a `package_path` matching a package in the `software` section below or an `app_store_id` to install when the host is first set up.

### macos_migration

Expand All @@ -293,7 +299,7 @@ The `macos_migration` section lets you control the [end user migration workflow]
- `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`).
Can only be configured for all teams (`default.yml`).

## software

Expand Down Expand Up @@ -432,8 +438,9 @@ org_settings:
- `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 (default: `false`).
- `server_url` is the base URL of the Fleet instance (default: provided during Fleet setup)
- `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. If this URL changes and Apple (macOS, iOS, iPadOS) hosts already have MDM turned on, the end users will have to turn MDM off and back on to use MDM features. (default: provided during Fleet setup)


Can only be configured for all teams (`org_settings`).

Expand Down Expand Up @@ -669,6 +676,22 @@ Once the IdP settings are configured, you can use the [`controls.macos_setup.ena

Can only be configured for all teams (`org_settings`).

##### apple_server_url

Update this URL if you're self-hosting Fleet and you want your hosts to talk to this URL for MDM features. (If not configured, hosts will use the base URL of the Fleet instance.)

If this URL changes and hosts already have MDM turned on, the end users will have to turn MDM off and back on to use MDM features.

##### Example

```yaml
org_settings:
mdm:
apple_server_url: https://instance.fleet.com
```

Can only be configured for all teams (`org_settings`).

<meta name="title" value="YAML files">
<meta name="description" value="Reference documentation for Fleet's GitOps workflow. See examples and configuration options.">
<meta name="pageOrderInSection" value="1500">
77 changes: 77 additions & 0 deletions docs/Contributing/API-for-contributors.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
- [Live query](#live-query)
- [Trigger cron schedule](#trigger-cron-schedule)
- [Device-authenticated routes](#device-authenticated-routes)
- [Orbit-authenticated routes](#orbit-authenticated-routes)
- [Downloadable installers](#downloadable-installers)
- [Setup](#setup)
- [Scripts](#scripts)
Expand Down Expand Up @@ -3196,6 +3197,82 @@ Notifies the server about an agent error, resulting in two outcomes:

---

## Orbit-authenticated routes

- [Get the status of a device in the setup experience](#get-the-status-of-a-device-in-the-setup-experience)


### Get the status of a device in the setup experience

`POST /api/fleet/orbit/setup_experience/status`

##### Parameters

| Name | Type | In | Description |
| ----- | ------ | ---- | ---------------------------------- |
| orbit_node_key | string | body | The Orbit's node key for authentication. |
| force_release | boolean | body | Force a host release from ADE flow, in case the setup is taking too long. |


##### Example

`POST /api/v1/fleet/device/8b49859b-1ffa-483d-ad27-85b30aa3c55f/setup_experience/status`

##### Request body

```json
{
"orbit_node_key":"FbvSsWfTRwXEecUlCBTLmBcjGFAdzqd/",
"force_release":false
}
```

##### Default response

`Status: 200`

```json
{
"setup_experience_results": {
"script": {
"name": "setup_script.sh",
"status": "success",
"execution_id": "b16fdd31-71cc-4258-ab27-744490809ebd"
},
"software": [
{
"name": "Zoom Workplace",
"status": "success",
"software_title_id": 957
},
{
"name": "Bear: Markdown Notes",
"status": "success",
"software_title_id": 287
},
{
"name": "Evernote",
"status": "success",
"software_title_id": 1313
}
],
"configuration_profiles": [
{
"profile_uuid": "ae6a9efd5-9166-11ef-83af-0242ac12000b",
"name": "Fleetd configuration",
"status": "verified"
},
{
"profile_uuid": "ae6aa8108-9166-11ef-83af-0242ac12000b",
"name": "Fleet root certificate authority (CA)",
"status": "verified"
}
],
"org_logo_url": ""
}
}

```

## Downloadable installers

Expand Down
Loading

0 comments on commit f5598e0

Please sign in to comment.